StunAttribute (STUN 6.0.29 API)

java.lang.Object
- org.restcomm.media.stun.messages.attributes.StunAttribute

Direct Known Subclasses:

AddressAttribute, ChangeRequestAttribute, ChannelNumberAttribute, ControlAttribute, DataAttribute, DontFragmentAttribute, ErrorCodeAttribute, EvenPortAttribute, FingerprintAttribute, LifetimeAttribute, MagicCookieAttribute, MessageIntegrityAttribute, NonceAttribute, OptionalAttribute, PriorityAttribute, RealmAttribute, RequestedTransportAttribute, ReservationTokenAttribute, SoftwareAttribute, UnknownAttributesAttribute, UseCandidateAttribute, UsernameAttribute, XorOnlyAttribute
```
public abstract class StunAttribute
extends Object
```
After the header are 0 or more attributes. Each attribute is TLV encoded, with a 16 bit type, 16 bit length, and variable value: 0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Type | Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Value ....
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

The following types are defined:

STUN attributes:
0x0001: MAPPED-ADDRESS
0x0002: RESPONSE-ADDRESS
0x0003: CHANGE-REQUEST
0x0004: SOURCE-ADDRESS
0x0005: CHANGED-ADDRESS
0x0006: USERNAME
0x0007: PASSWORD
0x0008: MESSAGE-INTEGRITY
0x0009: ERROR-CODE
0x000a: UNKNOWN-ATTRIBUTES
0x000b: REFLECTED-FROM
0x0014: REALM
0x0015: NONCE
0x0020: XOR-MAPPED-ADDRESS
0x8022: SOFTWARE
0x8023: ALTERNATE-SERVER
0x8028: FINGERPRINT

TURN attributes:
0x000C: CHANNEL-NUMBER
0x000D: LIFETIME
0x0012: XOR-PEER-ADDRESS
0x0013: DATA
0x0016: XOR-RELAYED-ADDRESS
0x0018: EVEN-PORT
0x0019: REQUESTED-TRANSPORT
0x001A: DONT-FRAGMENT
0x0022: RESERVATION-TOKEN
ICE attributes:
0x0024: PRIORITY
0x0025: USE-CANDIDATE
0x8029: ICE-CONTROLLED
0x802A: ICE-CONTROLLING

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`ALTERNATE_SERVER` Alternate server attribute.
`protected char`	`attributeType` The type of the attribute.
`static char`	`CHANGE_REQUEST` Change request attribute.
`static char`	`CHANGED_ADDRESS` Changed address attribute.
`static char`	`CHANNEL_NUMBER` Channel number attribute.
`static char`	`DATA` Data attribute.
`static char`	`DESTINATION_ADDRESS` Destination address attribute.
`static char`	`DONT_FRAGMENT` Don't fragment attribute.
`static char`	`ERROR_CODE` Error code attribute.
`static char`	`EVEN_PORT` Even port attribute.
`static char`	`FINGERPRINT` Fingerprint attribute.
`static char`	`HEADER_LENGTH` The size of an atribute header in bytes = len(TYPE) + len(LENGTH) = 4
`static char`	`ICE_CONTROLLED` ICE controlled attribute.
`static char`	`ICE_CONTROLLING` ICE controlling attribute.
`static char`	`LIFETIME` Lifetime attribute.
`static char`	`MAGIC_COOKIE` Magic cookie attribute.
`static char`	`MAPPED_ADDRESS` Mapped address attribute.
`static char`	`MESSAGE_INTEGRITY` Message integrity attribute.
`static char`	`NONCE` Nonce attribute.
`static char`	`PASSWORD` Password attribute.
`static char`	`PRIORITY` Priority attribute.
`static char`	`REALM` Realm attribute.
`static char`	`REFLECTED_FROM` Reflected from attribute.
`static char`	`REMOTE_ADDRESS` Destination address attribute.
`static char`	`REQUESTED_TRANSPORT` Requested transport attribute.
`static char`	`RESERVATION_TOKEN` Reservation token attribute.
`static char`	`RESPONSE_ADDRESS` Response address attribute.
`static char`	`SOFTWARE` Software attribute.
`static char`	`SOURCE_ADDRESS` Source address attribute.
`static char`	`UNKNOWN_ATTRIBUTES` Unknown attributes attribute.
`static char`	`UNKNOWN_OPTIONAL_ATTRIBUTE` Unknown optional attribute.
`static char`	`USE_CANDIDATE` Use candidate attribute.
`static char`	`USERNAME` Username attribute.
`static char`	`XOR_MAPPED_ADDRESS` XOR Mapped address attribute.
`static char`	`XOR_ONLY` XOR only attribute.
`static char`	`XOR_PEER_ADDRESS` XOR peer address attribute.
`static char`	`XOR_RELAYED_ADDRESS` XOR relayed address attribute.

Constructor Summary

Constructors
Modifier Constructor and Description

protected StunAttribute(char attributeType)
Creates an empty STUN message attribute.

Constructors
Modifier	Constructor and Description
`protected`	`StunAttribute(char attributeType)` Creates an empty STUN message attribute.

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract void`	`decodeAttributeBody(byte[] data, char offset, char length)` Sets this attribute's fields according to attributeValue array.
`abstract byte[]`	`encode()` Returns a binary representation of this attribute.
`abstract boolean`	`equals(Object other)` Compares two STUN Attributes.
`char`	`getAttributeType()` Returns the attribute's type.
`abstract char`	`getDataLength()` Returns the length of this attribute's body.
`int`	`getLocationInMessage()` For attributes that have arriving in incoming messages, this method returns their original location in the binary array so that we could later more easily verify attributes like MESSAGE-INTEGRITY.
`abstract String`	`getName()` Returns the human readable name of this attribute.
`protected void`	`setAttributeType(char type)` Sets the attribute's type.
`void`	`setLocationInMessage(int index)` For attributes that have arriving in incoming messages, this method stores their original location in the binary array so that we could later more easily verify attributes like MESSAGE-INTEGRITY.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAPPED_ADDRESS
```
public static final char MAPPED_ADDRESS
```
    Mapped address attribute.
    
    See Also:
    Constant Field Values
  - RESPONSE_ADDRESS
```
public static final char RESPONSE_ADDRESS
```
    Response address attribute.
    
    See Also:
    Constant Field Values
  - CHANGE_REQUEST
```
public static final char CHANGE_REQUEST
```
    Change request attribute.
    
    See Also:
    Constant Field Values
  - SOURCE_ADDRESS
```
public static final char SOURCE_ADDRESS
```
    Source address attribute.
    
    See Also:
    Constant Field Values
  - CHANGED_ADDRESS
```
public static final char CHANGED_ADDRESS
```
    Changed address attribute.
    
    See Also:
    Constant Field Values
  - USERNAME
```
public static final char USERNAME
```
    Username attribute.
    
    See Also:
    Constant Field Values
  - PASSWORD
```
public static final char PASSWORD
```
    Password attribute.
    
    See Also:
    Constant Field Values
  - MESSAGE_INTEGRITY
```
public static final char MESSAGE_INTEGRITY
```
    Message integrity attribute.
    
    See Also:
    Constant Field Values
  - ERROR_CODE
```
public static final char ERROR_CODE
```
    Error code attribute.
    
    See Also:
    Constant Field Values
  - UNKNOWN_ATTRIBUTES
```
public static final char UNKNOWN_ATTRIBUTES
```
    Unknown attributes attribute.
    
    See Also:
    Constant Field Values
  - REFLECTED_FROM
```
public static final char REFLECTED_FROM
```
    Reflected from attribute.
    
    See Also:
    Constant Field Values
  - REALM
```
public static final char REALM
```
    Realm attribute.
    
    See Also:
    Constant Field Values
  - NONCE
```
public static final char NONCE
```
    Nonce attribute.
    
    See Also:
    Constant Field Values
  - XOR_MAPPED_ADDRESS
```
public static final char XOR_MAPPED_ADDRESS
```
    XOR Mapped address attribute.
    
    See Also:
    Constant Field Values
  - XOR_ONLY
```
public static final char XOR_ONLY
```
    XOR only attribute.
    
    See Also:
    Constant Field Values
  - SOFTWARE
```
public static final char SOFTWARE
```
    Software attribute.
    
    See Also:
    Constant Field Values
  - ALTERNATE_SERVER
```
public static final char ALTERNATE_SERVER
```
    Alternate server attribute.
    
    See Also:
    Constant Field Values
  - FINGERPRINT
```
public static final char FINGERPRINT
```
    Fingerprint attribute.
    
    See Also:
    Constant Field Values
  - UNKNOWN_OPTIONAL_ATTRIBUTE
```
public static final char UNKNOWN_OPTIONAL_ATTRIBUTE
```
    Unknown optional attribute.
    
    See Also:
    Constant Field Values
  - CHANNEL_NUMBER
```
public static final char CHANNEL_NUMBER
```
    Channel number attribute.
    
    See Also:
    Constant Field Values
  - LIFETIME
```
public static final char LIFETIME
```
    Lifetime attribute.
    
    See Also:
    Constant Field Values
  - XOR_PEER_ADDRESS
```
public static final char XOR_PEER_ADDRESS
```
    XOR peer address attribute.
    
    See Also:
    Constant Field Values
  - DATA
```
public static final char DATA
```
    Data attribute.
    
    See Also:
    Constant Field Values
  - XOR_RELAYED_ADDRESS
```
public static final char XOR_RELAYED_ADDRESS
```
    XOR relayed address attribute.
    
    See Also:
    Constant Field Values
  - EVEN_PORT
```
public static final char EVEN_PORT
```
    Even port attribute.
    
    See Also:
    Constant Field Values
  - REQUESTED_TRANSPORT
```
public static final char REQUESTED_TRANSPORT
```
    Requested transport attribute.
    
    See Also:
    Constant Field Values
  - DONT_FRAGMENT
```
public static final char DONT_FRAGMENT
```
    Don't fragment attribute.
    
    See Also:
    Constant Field Values
  - RESERVATION_TOKEN
```
public static final char RESERVATION_TOKEN
```
    Reservation token attribute.
    
    See Also:
    Constant Field Values
  - MAGIC_COOKIE
```
public static final char MAGIC_COOKIE
```
    Magic cookie attribute.
    
    See Also:
    Constant Field Values
  - DESTINATION_ADDRESS
```
public static final char DESTINATION_ADDRESS
```
    Destination address attribute.
    
    See Also:
    Constant Field Values
  - REMOTE_ADDRESS
```
public static final char REMOTE_ADDRESS
```
    Destination address attribute.
    
    See Also:
    Constant Field Values
  - PRIORITY
```
public static final char PRIORITY
```
    Priority attribute.
    
    See Also:
    Constant Field Values
  - USE_CANDIDATE
```
public static final char USE_CANDIDATE
```
    Use candidate attribute.
    
    See Also:
    Constant Field Values
  - ICE_CONTROLLED
```
public static final char ICE_CONTROLLED
```
    ICE controlled attribute.
    
    See Also:
    Constant Field Values
  - ICE_CONTROLLING
```
public static final char ICE_CONTROLLING
```
    ICE controlling attribute.
    
    See Also:
    Constant Field Values
  - attributeType
```
protected char attributeType
```
    The type of the attribute.
  - HEADER_LENGTH
```
public static final char HEADER_LENGTH
```
    The size of an atribute header in bytes = len(TYPE) + len(LENGTH) = 4
    
    See Also:
    Constant Field Values
- Constructor Detail
  - StunAttribute
```
protected StunAttribute(char attributeType)
```
    Creates an empty STUN message attribute.
    
    Parameters:
    attributeType - the type of the attribute.
- Method Detail
  - getDataLength
```
public abstract char getDataLength()
```
    Returns the length of this attribute's body.
    
    Returns:
    the length of this attribute's value.
  - getName
```
public abstract String getName()
```
    Returns the human readable name of this attribute. Attribute names do not really matter from the protocol point of view. They are only used for debugging and readability.
    
    Returns:
    this attribute's name.
  - getAttributeType
```
public char getAttributeType()
```
    Returns the attribute's type.
    
    Returns:
    the type of this attribute.
  - setAttributeType
```
protected void setAttributeType(char type)
```
    Sets the attribute's type.
    
    Parameters:
    type - the new type of this attribute
  - equals
```
public abstract boolean equals(Object other)
```
    Compares two STUN Attributes. Two attributes are considered equal when they have the same type length and value.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    other - the object to compare this attribute with.
    
    Returns:
    true if the attributes are equal and false otherwise.
  - encode
```
public abstract byte[] encode()
```
    Returns a binary representation of this attribute.
    
    Returns:
    a binary representation of this attribute.
  - setLocationInMessage
```
public void setLocationInMessage(int index)
```
    For attributes that have arriving in incoming messages, this method stores their original location in the binary array so that we could later more easily verify attributes like MESSAGE-INTEGRITY.
    
    Parameters:
    index - the original location of this attribute in the datagram we got off the wire
  - getLocationInMessage
```
public int getLocationInMessage()
```
    For attributes that have arriving in incoming messages, this method returns their original location in the binary array so that we could later more easily verify attributes like MESSAGE-INTEGRITY.
    
    Returns:
    the original location of this attribute in the datagram we got off the wire or -1 if this is not an incoming StunAttribute
  - decodeAttributeBody
```
protected abstract void decodeAttributeBody(byte[] data,
                       char offset,
                       char length)
                                     throws StunException
```
    Sets this attribute's fields according to attributeValue array.
    
    Parameters:
    data - a binary array containing this attribute's field values and NOT containing the attribute header.
    offset - the position where attribute values begin (most often offset is equal to the index of the first byte after length)
    length - the length of the binary array.
    
    Throws:
    
    StunException - if attrubteValue contains invalid data.

Class StunAttribute

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAPPED_ADDRESS

RESPONSE_ADDRESS

CHANGE_REQUEST

SOURCE_ADDRESS

CHANGED_ADDRESS

USERNAME

PASSWORD

MESSAGE_INTEGRITY

ERROR_CODE

UNKNOWN_ATTRIBUTES

REFLECTED_FROM

REALM

NONCE

XOR_MAPPED_ADDRESS

XOR_ONLY

SOFTWARE

ALTERNATE_SERVER

FINGERPRINT

UNKNOWN_OPTIONAL_ATTRIBUTE

CHANNEL_NUMBER

LIFETIME

XOR_PEER_ADDRESS

DATA

XOR_RELAYED_ADDRESS

EVEN_PORT

REQUESTED_TRANSPORT

DONT_FRAGMENT

RESERVATION_TOKEN

MAGIC_COOKIE

DESTINATION_ADDRESS

REMOTE_ADDRESS

PRIORITY

USE_CANDIDATE

ICE_CONTROLLED

ICE_CONTROLLING

attributeType

HEADER_LENGTH

Constructor Detail

StunAttribute

Method Detail

getDataLength

getName

getAttributeType

setAttributeType

equals

encode

setLocationInMessage

getLocationInMessage

decodeAttributeBody