org.ice4j.attribute

Class RealmAttribute

java.lang.Object

org.ice4j.attribute.Attribute

org.ice4j.attribute.RealmAttribute

public class RealmAttribute
extends Attribute

The REALM attribute contains a text which meets the grammar for "realm value" as described in RFC3261 but without the double quotes.

Author:

Sebastien Vincent

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Attribute name.
private byte[]	realm Realm value.

Fields inherited from class org.ice4j.attribute.Attribute

ALTERNATE_SERVER, attributeType, CHANGE_REQUEST, CHANGED_ADDRESS, CHANNEL_NUMBER, CONNECTION_ID, 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_ADDRESS_FAMILY, 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
RealmAttribute() Constructor.

Method Summary

Modifier and Type	Method and Description
(package private) void	decodeAttributeBody(byte[] attributeValue, char offset, char length) Copies the value of the realm attribute from the specified attributeValue.
byte[]	encode() Returns a binary representation of this attribute.
boolean	equals(Object obj) Compares two STUN Attributes.
char	getDataLength() Returns the length of this attribute's body.
String	getName() Returns the human readable name of this attribute.
byte[]	getRealm() Returns a (cloned) byte array containing the data value of the realm attribute.
void	setRealm(byte[] realm) Copies the specified binary array into the the data value of the realm attribute.

Methods inherited from class org.ice4j.attribute.Attribute

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 final String NAME

Attribute name.

See Also:

Constant Field Values

realm

private byte[] realm

Realm value.

Constructor Detail

RealmAttribute

RealmAttribute()

Constructor.

Method Detail

decodeAttributeBody

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

Copies the value of the realm attribute from the specified attributeValue.

Specified by:

decodeAttributeBody in class Attribute

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 attributeValue contains invalid data.

encode

public byte[] encode()

Returns a binary representation of this attribute.

Specified by:

encode in class Attribute

Returns:

a binary representation of this attribute.

getDataLength

public char getDataLength()

Returns the length of this attribute's body.

Specified by:

getDataLength in class Attribute

Returns:

the length of this attribute's value.

getName

public String getName()

Returns the human readable name of this attribute.

Specified by:

getName in class Attribute

Returns:

this attribute's name.

getRealm

public byte[] getRealm()

Returns a (cloned) byte array containing the data value of the realm attribute.

Returns:

the binary array containing the realm.

setRealm

public void setRealm(byte[] realm)

Copies the specified binary array into the the data value of the realm attribute.

Parameters:

realm - the binary array containing the realm.

equals

public boolean equals(Object obj)

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

Specified by:

equals in class Attribute

Parameters:

obj - the object to compare this attribute with.

Returns:

true if the attributes are equal and false otherwise.