org.restcomm.media.stun.messages.attributes.general

Class UnknownAttributesAttribute

java.lang.Object

org.restcomm.media.stun.messages.attributes.StunAttribute

org.restcomm.media.stun.messages.attributes.general.UnknownAttributesAttribute

public class UnknownAttributesAttribute
extends StunAttribute

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from class org.restcomm.media.stun.messages.attributes.StunAttribute

ALTERNATE_SERVER, attributeType, CHANGE_REQUEST, CHANGED_ADDRESS, CHANNEL_NUMBER, DATA, DESTINATION_ADDRESS, DONT_FRAGMENT, ERROR_CODE, EVEN_PORT, FINGERPRINT, HEADER_LENGTH, ICE_CONTROLLED, ICE_CONTROLLING, LIFETIME, MAGIC_COOKIE, MAPPED_ADDRESS, MESSAGE_INTEGRITY, NONCE, PASSWORD, PRIORITY, REALM, REFLECTED_FROM, REMOTE_ADDRESS, REQUESTED_TRANSPORT, RESERVATION_TOKEN, RESPONSE_ADDRESS, SOFTWARE, SOURCE_ADDRESS, UNKNOWN_ATTRIBUTES, UNKNOWN_OPTIONAL_ATTRIBUTE, USE_CANDIDATE, USERNAME, XOR_MAPPED_ADDRESS, XOR_ONLY, XOR_PEER_ADDRESS, XOR_RELAYED_ADDRESS

Constructor Summary

Constructors

Constructor and Description
UnknownAttributesAttribute()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttributeId(char attributeId)
boolean	contains(char attributeID) Verifies whether the specified attributeID is contained by this attribute.
protected void	decodeAttributeBody(byte[] data, char offset, char length) Sets this attribute's fields according to attributeValue array.
byte[]	encode() Returns a binary representation of this attribute.
boolean	equals(Object other) Compares two STUN Attributes.
char	getAttribute(int index) Returns the attribute id with index i.
int	getAttributeCount() Returns the number of attribute IDs contained by this class.
Iterator<Character>	getAttributes() Returns an iterator over the list of attribute IDs contained by this attribute.
char	getDataLength() Returns the length (in bytes) of this attribute's body.
String	getName() Returns the human readable name of this attribute.

Methods inherited from class org.restcomm.media.stun.messages.attributes.StunAttribute

getAttributeType, getLocationInMessage, setAttributeType, setLocationInMessage

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static String NAME

Constructor Detail

UnknownAttributesAttribute

public UnknownAttributesAttribute()

Method Detail

getDataLength

public char getDataLength()

Returns the length (in bytes) of this attribute's body. If the number of unknown attributes is an odd number, one of the attributes MUST be repeated in the list, so that the total length of the list is a multiple of 4 bytes.

Specified by:

getDataLength in class StunAttribute

Returns:

the length of this attribute's value (a multiple of 4).

contains

public boolean contains(char attributeID)

Verifies whether the specified attributeID is contained by this attribute.

Parameters:

attributeID - the attribute id to look for.

Returns:

true if this attribute contains the specified attribute id.

addAttributeId

public void addAttributeId(char attributeId)

getAttributes

public Iterator<Character> getAttributes()

Returns an iterator over the list of attribute IDs contained by this attribute.

Returns:

an iterator over the list of attribute IDs contained by this attribute.

getAttributeCount

public int getAttributeCount()

Returns the number of attribute IDs contained by this class.

Returns:

the number of attribute IDs contained by this class.

getAttribute

public char getAttribute(int index)

Returns the attribute id with index i.

Parameters:

index - the index of the attribute id to return.

Returns:

the attribute id with index i.

getName

public String getName()

Description copied from class: StunAttribute

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.

Specified by:

getName in class StunAttribute

Returns:

this attribute's name.

equals

public boolean equals(Object other)

Description copied from class: StunAttribute

Compares two STUN Attributes. Two attributes are considered equal when they have the same type length and value.

Specified by:

equals in class StunAttribute

Parameters:

other - the object to compare this attribute with.

Returns:

true if the attributes are equal and false otherwise.

encode

public byte[] encode()

Description copied from class: StunAttribute

Returns a binary representation of this attribute.

Specified by:

encode in class StunAttribute

Returns:

a binary representation of this attribute.

decodeAttributeBody

protected void decodeAttributeBody(byte[] data,
                       char offset,
                       char length)
                            throws StunException

Description copied from class: StunAttribute

Sets this attribute's fields according to attributeValue array.

Specified by:

decodeAttributeBody in class StunAttribute

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.