org.restcomm.media.stun.messages.attributes.control

Class ControlAttribute

java.lang.Object

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

org.restcomm.media.stun.messages.attributes.control.ControlAttribute

Direct Known Subclasses:

ControlledAttribute, ControllingAttribute

public abstract class ControlAttribute
extends StunAttribute

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	controlling
protected static char	DATA_LENGTH
protected static String	ICE_CONTROLLED_NAME
protected static String	ICE_CONTROLLING_NAME
protected long	tieBreaker

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

Modifier	Constructor and Description
protected	ControlAttribute(boolean isControlling)

Method Summary

Modifier and Type	Method and Description
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	getDataLength() Returns the length of this attribute's body.
String	getName() Returns the human readable name of this attribute.
long	getTieBreaker()
boolean	isControlling()
void	setTieBreaker(long tieBreaker)

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

ICE_CONTROLLED_NAME

protected static final String ICE_CONTROLLED_NAME

See Also:

Constant Field Values

ICE_CONTROLLING_NAME

protected static final String ICE_CONTROLLING_NAME

See Also:

Constant Field Values

DATA_LENGTH

protected static final char DATA_LENGTH

See Also:

Constant Field Values

tieBreaker

protected long tieBreaker

controlling

protected boolean controlling

Constructor Detail

ControlAttribute

protected ControlAttribute(boolean isControlling)

Method Detail

getTieBreaker

public long getTieBreaker()

setTieBreaker

public void setTieBreaker(long tieBreaker)

isControlling

public boolean isControlling()

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.

getDataLength

public char getDataLength()

Description copied from class: StunAttribute

Returns the length of this attribute's body.

Specified by:

getDataLength in class StunAttribute

Returns:

the length of this attribute's value.

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.

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.

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.