org.restcomm.media.stun.messages

Class StunResponse

java.lang.Object

org.restcomm.media.stun.messages.StunMessage

org.restcomm.media.stun.messages.StunResponse

public class StunResponse
extends StunMessage

Represents a STUN Response message.
A response message can be successful or erroneous.

Field Summary

Fields inherited from class org.restcomm.media.stun.messages.StunMessage

ALLOCATE_ERROR_RESPONSE, ALLOCATE_REQUEST, ALLOCATE_REQUEST_PRESENTITY_INDEX, ALLOCATE_RESPONSE, ALLOCATE_RESPONSE_PRESENTITY_INDEX, ALTERNATE_SERVER_PRESENTITY_INDEX, attributePresentities, attributes, BINDING_ERROR_RESPONSE, BINDING_ERROR_RESPONSE_PRESENTITY_INDEX, BINDING_INDICATION, BINDING_REQUEST, BINDING_REQUEST_PRESENTITY_INDEX, BINDING_RESPONSE_PRESENTITY_INDEX, BINDING_SUCCESS_RESPONSE, C, CHANGE_REQUEST_PRESENTITY_INDEX, CHANGED_ADDRESS_PRESENTITY_INDEX, CHANNEL_NUMBER_PRESENTITY_INDEX, CHANNELBIND_ERROR_RESPONSE, CHANNELBIND_REQUEST, CHANNELBIND_REQUEST_PRESENTITY_INDEX, CHANNELBIND_RESPONSE, CHANNELBIND_RESPONSE_PRESENTITY_INDEX, CREATEPERMISSION_ERROR_RESPONSE, CREATEPERMISSION_REQUEST, CREATEPERMISSION_RESPONSE, DATA_INDICATION, DATA_INDICATION_PRESENTITY_INDEX, DATA_PRESENTITY_INDEX, DESTINATION_ADDRESS_PRESENTITY_INDEX, DONT_FRAGMENT_PRESENTITY_INDEX, ERROR_CODE_PRESENTITY_INDEX, EVEN_PORT_PRESENTITY_INDEX, FINGERPRINT_PRESENTITY_INDEX, HEADER_LENGTH, ICE_CONTROLLED_PRESENTITY_INDEX, ICE_CONTROLLING_PRESENTITY_INDEX, LIFETIME_PRESENTITY_INDEX, M, MAGIC_COOKIE, MAPPED_ADDRESS_PRESENTITY_INDEX, MESSAGE_INTEGRITY_PRESENTITY_INDEX, messageType, N_A, NONCE_PRESENTITY_INDEX, O, OLD_DATA_INDICATION, PASSWORD_PRESENTITY_INDEX, PRIORITY_PRESENTITY_INDEX, REALM_PRESENTITY_INDEX, REFLECTED_FROM_PRESENTITY_INDEX, REFRESH_ERROR_RESPONSE, REFRESH_REQUEST, REFRESH_REQUEST_PRESENTITY_INDEX, REFRESH_RESPONSE, REFRESH_RESPONSE_PRESENTITY_INDEX, REQUESTED_TRANSPORT_PRESENTITY_INDEX, RESERVATION_TOKEN_PRESENTITY_INDEX, RESPONSE_ADDRESS_PRESENTITY_INDEX, RFC3489_TRANSACTION_ID_LENGTH, SEND_INDICATION, SEND_INDICATION_PRESENTITY_INDEX, SEND_REQUEST, SHARED_SECRET_ERROR_RESPONSE, SHARED_SECRET_ERROR_RESPONSE_PRESENTITY_INDEX, SHARED_SECRET_REQUEST, SHARED_SECRET_REQUEST_PRESENTITY_INDEX, SHARED_SECRET_RESPONSE, SHARED_SECRET_RESPONSE_PRESENTITY_INDEX, SOFTWARE_PRESENTITY_INDEX, SOURCE_ADDRESS_PRESENTITY_INDEX, STUN_ERROR_RESP, STUN_INDICATION, STUN_METHOD_BINDING, STUN_REQUEST, STUN_SUCCESS_RESP, TRANSACTION_ID_LENGTH, transactionID, TURN_METHOD_ALLOCATE, TURN_METHOD_CHANNELBIND, TURN_METHOD_CREATEPERMISSION, TURN_METHOD_DATA, TURN_METHOD_REFRESH, TURN_METHOD_SEND, UNKNOWN_ATTRIBUTES_PRESENTITY_INDEX, UNKNOWN_OPTIONAL_ATTRIBUTES_PRESENTITY_INDEX, USE_CANDIDATE_PRESENTITY_INDEX, USERNAME_PRESENTITY_INDEX, XOR_MAPPED_ADDRESS_PRESENTITY_INDEX, XOR_ONLY_PRESENTITY_INDEX, XOR_PEER_ADDRESS_PRESENTITY_INDEX, XOR_RELAYED_ADDRESS_PRESENTITY_INDEX

Constructor Summary

Constructors

Constructor and Description
StunResponse()

Method Summary

Modifier and Type	Method and Description
boolean	isErrorResponse() Determines whether this instance represents a STUN error response.
boolean	isSuccessResponse() Determines whether this instance represents a STUN success response.
void	setMessageType(char responseType) Sets this message's type to be messageType.

Methods inherited from class org.restcomm.media.stun.messages.StunMessage

addAttribute, containsAttribute, decode, encode, equals, getAttribute, getAttributeCount, getAttributePresentity, getAttributes, getDataLength, getDataLengthWithoutPadding, getMessageType, getName, getTransactionId, isErrorResponseType, isIndicationType, isRequestType, isResponseType, isSuccessResponseType, removeAttribute, setTransactionID, toString, validateAttributePresentity

Methods inherited from class java.lang.Object

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

Constructor Detail

StunResponse

public StunResponse()

Method Detail

isErrorResponse

public boolean isErrorResponse()

Determines whether this instance represents a STUN error response.

Returns:

true if this instance represents a STUN error response; otherwise, false

isSuccessResponse

public boolean isSuccessResponse()

Determines whether this instance represents a STUN success response.

Returns:

true if this instance represents a STUN success response; otherwise, false

setMessageType

public void setMessageType(char responseType)
                    throws IllegalArgumentException

Description copied from class: StunMessage

Sets this message's type to be messageType. Method is package access as it should not permit changing the type of message once it has been initialized (could provoke attribute discrepancies). Called by messageFactory.

Overrides:

setMessageType in class StunMessage

Parameters:

responseType - the message type.

Throws:

IllegalArgumentException