org.restcomm.media.stun.messages.attributes.address

Class AddressAttribute

java.lang.Object

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

org.restcomm.media.stun.messages.attributes.address.AddressAttribute

Direct Known Subclasses:

AlternateServerAttribute, ChangedAddressAttribute, DestinationAddressAttribute, MappedAddressAttribute, ReflectedFromAttribute, RemoteAddressAttribute, ResponseAddressAttribute, SourceAddressAttribute, XorMappedAddressAttribute

public abstract class AddressAttribute
extends StunAttribute

This class is used to represent Stun attributes that contain an address. Such attributes are:

MAPPED-ADDRESS
RESPONSE-ADDRESS
SOURCE-ADDRESS
CHANGED-ADDRESS
REFLECTED-FROM
ALTERNATE-SERVER
XOR-PEER-ADDRESS
XOR-RELAYED-ADDRESS

The different attributes are distinguished by the attributeType of org.ice4j.attribute.Attribute.

Address attributes indicate the mapped IP address and port. They consist of an eight bit address family, and a sixteen bit port, followed by a fixed length value representing the IP address. 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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|x x x x x x x x| Family | Port |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Address |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+



The port is a network byte ordered representation of the mapped port. The address family is always 0x01, corresponding to IPv4. The first 8 bits of the MAPPED-ADDRESS are ignored, for the purposes of aligning parameters on natural boundaries. The IPv4 address is 32 bits.

Field Summary

Fields

Modifier and Type	Field and Description
protected static byte	ADDRESS_FAMILY_IPV4
protected static byte	ADDRESS_FAMILY_IPV6
protected TransportAddress	transportAddress

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	AddressAttribute(char attributeType)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	decodeAttributeBody(byte[] attributeValue, 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.
TransportAddress	getAddress()
byte[]	getAddressBytes() Returns the bytes of the address.
char	getDataLength() Returns the length of this attribute's body.
byte	getFamily() Returns the family that the this.address belongs to.
int	getPort()
void	setAddress(TransportAddress address)
protected void	setAttributeType(char type) Sets the attribute's type.

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

getAttributeType, getLocationInMessage, getName, setLocationInMessage

Methods inherited from class java.lang.Object

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

Field Detail

ADDRESS_FAMILY_IPV4

protected static final byte ADDRESS_FAMILY_IPV4

See Also:

Constant Field Values

ADDRESS_FAMILY_IPV6

protected static final byte ADDRESS_FAMILY_IPV6

See Also:

Constant Field Values

transportAddress

protected TransportAddress transportAddress

Constructor Detail

AddressAttribute

protected AddressAttribute(char attributeType)

Method Detail

setAttributeType

protected void setAttributeType(char type)

Description copied from class: StunAttribute

Sets the attribute's type.

Overrides:

setAttributeType in class StunAttribute

Parameters:

type - the new type of this attribute

getAddress

public TransportAddress getAddress()

setAddress

public void setAddress(TransportAddress address)

getPort

public int getPort()

getAddressBytes

public byte[] getAddressBytes()

Returns the bytes of the address.

Returns:

the byte[] array containing the address.

getFamily

public byte getFamily()

Returns the family that the this.address belongs to.

Returns:

the family that the this.address belongs to.

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.

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[] attributeValue,
                       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:

attributeValue - 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.

equals

public boolean equals(Object other)

Compares two STUN Attributes. Attributes are considered equal when their type, length, and all data are the same.

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.