org.restcomm.media.stun.messages.attributes

Class StunAttributeFactory

java.lang.Object

org.restcomm.media.stun.messages.attributes.StunAttributeFactory

public class StunAttributeFactory
extends Object

Factory that provides STUN/TURN/ICE attributes.

Constructor Summary

Constructors

Constructor and Description
StunAttributeFactory()

Method Summary

Modifier and Type	Method and Description
static ChangedAddressAttribute	createChangedAddressAttribute(TransportAddress address) Creates a changedAddressAttribute of the specified type and with the specified address and port
static ChangeRequestAttribute	createChangeRequestAttribute() Creates a ChangeRequestAttribute with "false" values for the changeIP and changePort flags.
static ChangeRequestAttribute	createChangeRequestAttribute(boolean changeIP, boolean changePort) Creates a ChangeRequestAttribute with the specified flag values.
static ChannelNumberAttribute	createChannelNumberAttribute(char channelNumber) Create a ChannelNumberAttribute.
static DataAttribute	createDataAttribute(byte[] data) Create a DataAtttribute.
static DataAttribute	createDataAttributeWithoutPadding(byte[] data) Create a DataAtttribute.
static DestinationAddressAttribute	createDestinationAddressAttribute(TransportAddress address) Creates a DestinationFromAddressAttribute of the specified type and with the specified address and port
static ErrorCodeAttribute	createErrorCodeAttribute(byte errorClass, byte errorNumber) Creates an ErrorCodeAttribute with the specified error class and number and a default reason phrase.
static ErrorCodeAttribute	createErrorCodeAttribute(byte errorClass, byte errorNumber, String reasonPhrase) Creates an ErrorCodeAttribute with the specified error class, number and reason phrase.
static ErrorCodeAttribute	createErrorCodeAttribute(char errorCode) Creates an ErrorCodeAttribute with the specified error code and a default reason phrase.
static ErrorCodeAttribute	createErrorCodeAttribute(char errorCode, String reasonPhrase) Creates an ErrorCodeAttribute with the specified error code and reason phrase.
static EvenPortAttribute	createEvenPortAttribute(boolean rFlag) Create a EventAttribute.
static FingerprintAttribute	createFingerprintAttribute() Creates an empty FingerprintAttribute with a 0 check sum.
static ControlledAttribute	createIceControlledAttribute(long tieBreaker) Creates an Controlled Attribute object with the specified tie-breaker value
static ControllingAttribute	createIceControllingAttribute(long tieBreaker) Creates an Controlling Attribute with the specified tie-breaker value
static LifetimeAttribute	createLifetimeAttribute(int lifetime) Create a LifetimeAttribute.
static MagicCookieAttribute	createMagicCookieAttribute() Creates a MagicCookieAttribute.
static MappedAddressAttribute	createMappedAddressAttribute(TransportAddress address) Creates a MappedAddressAttribute of the specified type and with the specified address and port
static MessageIntegrityAttribute	createMessageIntegrityAttribute(String username, byte[] key) Creates an empty MessageIntegrityAttribute.
static NonceAttribute	createNonceAttribute(byte[] nonce) Create a NonceAttribute.
static PriorityAttribute	createPriorityAttribute(long priority) Creates a Priority attribute with the specified priority value
static RealmAttribute	createRealmAttribute(byte[] realm) Create a RealmAttribute.
static ReflectedFromAttribute	createReflectedFromAttribute(TransportAddress address) Creates a ReflectedFromAddressAttribute of the specified type and with the specified address and port
static RequestedTransportAttribute	createRequestedTransportAttribute(byte protocol) Create a RequestedTransportAttribute.
static ReservationTokenAttribute	createReservationTokenAttribute(byte[] token) Create a ReservationTokenAttribute.
static ResponseAddressAttribute	createResponseAddressAttribute(TransportAddress address) Creates a ResponseFromAddressAttribute of the specified type and with the specified address and port
static SoftwareAttribute	createSoftwareAttribute(byte[] software) Create a SoftwareAttribute.
static SourceAddressAttribute	createSourceAddressAttribute(TransportAddress address) Creates a SourceFromAddressAttribute of the specified type and with the specified address and port
static UnknownAttributesAttribute	createUnknownAttributesAttribute() Creates an empty UnknownAttributesAttribute.
static UseCandidateAttribute	createUseCandidateAttribute() Creates a UseCandidateAttribute
static UsernameAttribute	createUsernameAttribute(byte[] username) Create a UsernameAttribute.
static UsernameAttribute	createUsernameAttribute(String username) Creates a new UsernameAttribute instance.
static XorMappedAddressAttribute	createXorMappedAddressAttribute(TransportAddress address, byte[] tranID) Creates a XorMappedAddressAttribute for the specified address.
static XorPeerAddressAttribute	createXorPeerAddressAttribute(TransportAddress address, byte[] tranID) Creates a XorPeerAddressAttribute of the specified type and with the specified address and port
static XorRelayedAddressAttribute	createXorRelayedAddressAttribute(TransportAddress address, byte[] tranID) Creates a XorRelayedAddressAttribute of the specified type and with the specified address and port.

Methods inherited from class java.lang.Object

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

Constructor Detail

StunAttributeFactory

public StunAttributeFactory()

Method Detail

createChangeRequestAttribute

public static ChangeRequestAttribute createChangeRequestAttribute()

Creates a ChangeRequestAttribute with "false" values for the changeIP and changePort flags.

Returns:

the newly created ChangeRequestAttribute.

createChangeRequestAttribute

public static ChangeRequestAttribute createChangeRequestAttribute(boolean changeIP,
                                                                  boolean changePort)

Creates a ChangeRequestAttribute with the specified flag values.

Parameters:

changeIP - the value of the changeIP flag.

changePort - the value of the changePort flag.

Returns:

the newly created ChangeRequestAttribute.

createChangedAddressAttribute

public static ChangedAddressAttribute createChangedAddressAttribute(TransportAddress address)

Creates a changedAddressAttribute of the specified type and with the specified address and port

Parameters:

address - the address value of the address attribute

Returns:

the newly created address attribute.

createErrorCodeAttribute

public static ErrorCodeAttribute createErrorCodeAttribute(byte errorClass,
                                                          byte errorNumber)
                                                   throws StunException

Creates an ErrorCodeAttribute with the specified error class and number and a default reason phrase.

Parameters:

errorClass - a valid error class.

errorNumber - a valid error number.

Returns:

the newly created attribute.

Throws:

StunException - if the error class or number have invalid values according to rfc3489.

createErrorCodeAttribute

public static ErrorCodeAttribute createErrorCodeAttribute(byte errorClass,
                                                          byte errorNumber,
                                                          String reasonPhrase)
                                                   throws StunException

Creates an ErrorCodeAttribute with the specified error class, number and reason phrase.

Parameters:

errorClass - a valid error class.

errorNumber - a valid error number.

reasonPhrase - a human readable reason phrase. A null reason phrase would be replaced (if possible) by a default one as defined byte the rfc3489.

Returns:

the newly created attribute.

Throws:

StunException - if the error class or number have invalid values according to rfc3489.

createErrorCodeAttribute

public static ErrorCodeAttribute createErrorCodeAttribute(char errorCode)
                                                   throws StunException

Creates an ErrorCodeAttribute with the specified error code and a default reason phrase.

Parameters:

errorCode - a valid error code.

Returns:

the newly created attribute.

Throws:

StunException - if errorCode is not a valid error code as defined by rfc3489

createErrorCodeAttribute

public static ErrorCodeAttribute createErrorCodeAttribute(char errorCode,
                                                          String reasonPhrase)
                                                   throws IllegalArgumentException

Creates an ErrorCodeAttribute with the specified error code and reason phrase.

Parameters:

errorCode - a valid error code.

reasonPhrase - a human readable reason phrase. A null reason phrase would be replaced (if possible) by a default one as defined byte the rfc3489.

Returns:

the newly created attribute.

Throws:

IllegalArgumentException - if errorCode is not a valid error code as defined by rfc3489

createMappedAddressAttribute

public static MappedAddressAttribute createMappedAddressAttribute(TransportAddress address)

Creates a MappedAddressAttribute of the specified type and with the specified address and port

Parameters:

address - the address value of the address attribute

Returns:

the newly created address attribute.

createReflectedFromAttribute

public static ReflectedFromAttribute createReflectedFromAttribute(TransportAddress address)

Creates a ReflectedFromAddressAttribute of the specified type and with the specified address and port

Parameters:

address - the address value of the address attribute

Returns:

the newly created address attribute.

createResponseAddressAttribute

public static ResponseAddressAttribute createResponseAddressAttribute(TransportAddress address)

Creates a ResponseFromAddressAttribute of the specified type and with the specified address and port

Parameters:

address - the address value of the address attribute

Returns:

the newly created address attribute.

createSourceAddressAttribute

public static SourceAddressAttribute createSourceAddressAttribute(TransportAddress address)

Creates a SourceFromAddressAttribute of the specified type and with the specified address and port

Parameters:

address - the address value of the address attribute

Returns:

the newly created address attribute.

createUnknownAttributesAttribute

public static UnknownAttributesAttribute createUnknownAttributesAttribute()

Creates an empty UnknownAttributesAttribute.

Returns:

the newly created UnknownAttributesAttribute

createXorRelayedAddressAttribute

public static XorRelayedAddressAttribute createXorRelayedAddressAttribute(TransportAddress address,
                                                                          byte[] tranID)

Creates a XorRelayedAddressAttribute of the specified type and with the specified address and port.

Parameters:

address - the address value of the address attribute

tranID - the ID of the transaction that we will be using for the XOR mask.

Returns:

the newly created address attribute.

createXorPeerAddressAttribute

public static XorPeerAddressAttribute createXorPeerAddressAttribute(TransportAddress address,
                                                                    byte[] tranID)

Creates a XorPeerAddressAttribute of the specified type and with the specified address and port

Parameters:

address - the address value of the address attribute

tranID - the ID of the transaction that we will be using for the XOR mask.

Returns:

the newly created address attribute.

createXorMappedAddressAttribute

public static XorMappedAddressAttribute createXorMappedAddressAttribute(TransportAddress address,
                                                                        byte[] tranID)

Creates a XorMappedAddressAttribute for the specified address.

Parameters:

address - the address value of the address attribute

tranID - the ID of the transaction that we will be using for the XOR mask.

Returns:

the newly created XOR address attribute.

createUsernameAttribute

public static UsernameAttribute createUsernameAttribute(byte[] username)

Create a UsernameAttribute.

Parameters:

username - username value

Returns:

newly created UsernameAttribute

createUsernameAttribute

public static UsernameAttribute createUsernameAttribute(String username)

Creates a new UsernameAttribute instance.

Parameters:

username - the String value of the username

Returns:

a new UsernameAttribute instance

createMessageIntegrityAttribute

public static MessageIntegrityAttribute createMessageIntegrityAttribute(String username,
                                                                        byte[] key)

Creates an empty MessageIntegrityAttribute. When included in a message the stack would set the body of this attribute so that the the HMAC-SHA1 (RFC 2104) would correspond to the actual message that's transporting the attribute.

Parameters:

username - the username that we should use to obtain an encryption key (password) that the StunAttribute.encode() method should use when creating the content of this message.

Returns:

the newly created address attribute.

createFingerprintAttribute

public static FingerprintAttribute createFingerprintAttribute()

Creates an empty FingerprintAttribute with a 0 check sum. Once included in a message, the value of this attribute will be calculated by the stack just before sending it.

Returns:

the newly created FingerprintAttribute.

createChannelNumberAttribute

public static ChannelNumberAttribute createChannelNumberAttribute(char channelNumber)

Create a ChannelNumberAttribute.

Parameters:

channelNumber - channel number

Returns:

newly created ChannelNumberAttribute

createRealmAttribute

public static RealmAttribute createRealmAttribute(byte[] realm)

Create a RealmAttribute.

Parameters:

realm - realm value

Returns:

newly created RealmAttribute

createNonceAttribute

public static NonceAttribute createNonceAttribute(byte[] nonce)

Create a NonceAttribute.

Parameters:

nonce - nonce value

Returns:

newly created NonceAttribute

createSoftwareAttribute

public static SoftwareAttribute createSoftwareAttribute(byte[] software)

Create a SoftwareAttribute.

Parameters:

software - software value

Returns:

newly created SoftwareAttribute

createEvenPortAttribute

public static EvenPortAttribute createEvenPortAttribute(boolean rFlag)

Create a EventAttribute.

Parameters:

rFlag - R flag

Returns:

the newly created EventPortAttribute

createLifetimeAttribute

public static LifetimeAttribute createLifetimeAttribute(int lifetime)

Create a LifetimeAttribute.

Parameters:

lifetime - lifetime value

Returns:

newly created LifetimeAttribute

createRequestedTransportAttribute

public static RequestedTransportAttribute createRequestedTransportAttribute(byte protocol)

Create a RequestedTransportAttribute.

Parameters:

protocol - transport protocol requested

Returns:

newly created RequestedTransportAttribute

createReservationTokenAttribute

public static ReservationTokenAttribute createReservationTokenAttribute(byte[] token)

Create a ReservationTokenAttribute.

Parameters:

token - the token

Returns:

newly created RequestedTransportAttribute

createDataAttribute

public static DataAttribute createDataAttribute(byte[] data)

Create a DataAtttribute.

Parameters:

data - the data

Returns:

newly created DataAttribute

createDataAttributeWithoutPadding

public static DataAttribute createDataAttributeWithoutPadding(byte[] data)

Create a DataAtttribute.

Parameters:

data - the data

Returns:

newly created DataAttribute

createIceControlledAttribute

public static ControlledAttribute createIceControlledAttribute(long tieBreaker)

Creates an Controlled Attribute object with the specified tie-breaker value

Parameters:

tieBreaker - the tie-breaker value to be used

Returns:

the created IceControlledAttribute

createPriorityAttribute

public static PriorityAttribute createPriorityAttribute(long priority)
                                                 throws IllegalArgumentException

Creates a Priority attribute with the specified priority value

Parameters:

priority - the priority value

Returns:

the created PriorityAttribute

Throws:

IllegalArgumentException - if priority < 0 or priority > (2^31 - 1)

createUseCandidateAttribute

public static UseCandidateAttribute createUseCandidateAttribute()

Creates a UseCandidateAttribute

Returns:

the created UseCandidateAttribute

createIceControllingAttribute

public static ControllingAttribute createIceControllingAttribute(long tieBreaker)

Creates an Controlling Attribute with the specified tie-breaker value

Parameters:

tieBreaker - the tie-breaker value to be used

Returns:

the created IceControllingAttribute

createMagicCookieAttribute

public static MagicCookieAttribute createMagicCookieAttribute()

Creates a MagicCookieAttribute.

Returns:

the created MagicCookieAttribute

createDestinationAddressAttribute

public static DestinationAddressAttribute createDestinationAddressAttribute(TransportAddress address)

Creates a DestinationFromAddressAttribute of the specified type and with the specified address and port

Parameters:

address - the address value of the address attribute

Returns:

the newly created address attribute.