ErrorCodeAttribute (STUN 6.0.36 API)

java.lang.Object
- org.restcomm.media.stun.messages.attributes.StunAttribute
- - org.restcomm.media.stun.messages.attributes.general.ErrorCodeAttribute

```
public class ErrorCodeAttribute
extends StunAttribute
```
The ERROR-CODE attribute is present in the Binding Error Response and Shared Secret Error Response. It is a numeric value in the range of 100 to 699 plus a textual reason phrase encoded in UTF-8, and is consistent in its code assignments and semantics with SIP [10] and HTTP [15]. The reason phrase is meant for user consumption, and can be anything appropriate for the response code. The lengths of the reason phrases MUST be a multiple of 4 (measured in bytes). This can be accomplished by added spaces to the end of the text, if necessary. Recommended reason phrases for the defined response codes are presented below. To facilitate processing, the class of the error code (the hundreds digit) is encoded separately from the rest of the code. 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 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | 0 |Class| Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Reason Phrase (variable) .. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ The class represents the hundreds digit of the response code. The value MUST be between 1 and 6. The number represents the response code modulo 100, and its value MUST be between 0 and 99. The following response codes, along with their recommended reason phrases (in brackets) are defined at this time: 400 (Bad Request): The request was malformed. The client should not retry the request without modification from the previous attempt. 401 (Unauthorized): The Binding Request did not contain a MESSAGE- INTEGRITY attribute. 420 (Unknown Attribute): The server did not understand a mandatory attribute in the request. 430 (Stale Credentials): The Binding Request did contain a MESSAGE- INTEGRITY attribute, but it used a shared secret that has expired. The client should obtain a new shared secret and try again. 431 (Integrity Check Failure): The Binding Request contained a MESSAGE-INTEGRITY attribute, but the HMAC failed verification. This could be a sign of a potential attack, or client implementation error. 432 (Missing Username): The Binding Request contained a MESSAGE- INTEGRITY attribute, but not a USERNAME attribute. Both must be present for integrity checks. 433 (Use TLS): The Shared Secret request has to be sent over TLS, but was not received over TLS. 500 (Server Error): The server has suffered a temporary error. The client should try again. 600 (Global Failure:) The server is refusing to fulfill the request. The client should not retry.

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`BAD_REQUEST`
`static char`	`GLOBAL_FAILURE`
`static char`	`INTEGRITY_CHECK_FAILURE`
`static char`	`MISSING_USERNAME`
`static String`	`NAME`
`static char`	`ROLE_CONFLICT`
`static char`	`SERVER_ERROR`
`static char`	`STALE_CREDENTIALS`
`static char`	`UNAUTHORIZED`
`static char`	`UNKNOWN_ATTRIBUTE`
`static char`	`USE_TLS`

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
Constructor and Description

ErrorCodeAttribute()

Constructors
Constructor and Description
`ErrorCodeAttribute()`

Method Summary

Methods
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.
`static String`	`getDefaultReasonPhrase(char errorCode)` Returns a default reason phrase corresponding to the specified error code, as described by rfc 3489.
`byte`	`getErrorClass()`
`char`	`getErrorCode()` A convenience method that constructs an error code from this attribute's class and number.
`byte`	`getErrorNumber()`
`String`	`getName()` Returns the human readable name of this attribute.
`byte[]`	`getReasonPhrase()` Returns the reason phrase.
`void`	`setErrorClass(byte errorClass)` Sets the class of the error.
`void`	`setErrorCode(char code)` A convenience method that sets error class and number according to the specified error code.
`void`	`setErrorNumber(byte errorNumber)`
`void`	`setReasonPhrase(String reason)` Set's a reason phrase.

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
  - NAME
```
public static final String NAME
```
    See Also:
    Constant Field Values
  - BAD_REQUEST
```
public static final char BAD_REQUEST
```
    See Also:
    Constant Field Values
  - UNAUTHORIZED
```
public static final char UNAUTHORIZED
```
    See Also:
    Constant Field Values
  - UNKNOWN_ATTRIBUTE
```
public static final char UNKNOWN_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - STALE_CREDENTIALS
```
public static final char STALE_CREDENTIALS
```
    See Also:
    Constant Field Values
  - INTEGRITY_CHECK_FAILURE
```
public static final char INTEGRITY_CHECK_FAILURE
```
    See Also:
    Constant Field Values
  - MISSING_USERNAME
```
public static final char MISSING_USERNAME
```
    See Also:
    Constant Field Values
  - USE_TLS
```
public static final char USE_TLS
```
    See Also:
    Constant Field Values
  - ROLE_CONFLICT
```
public static final char ROLE_CONFLICT
```
    See Also:
    Constant Field Values
  - SERVER_ERROR
```
public static final char SERVER_ERROR
```
    See Also:
    Constant Field Values
  - GLOBAL_FAILURE
```
public static final char GLOBAL_FAILURE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ErrorCodeAttribute
```
public ErrorCodeAttribute()
```
- Method Detail
  - getErrorClass
```
public byte getErrorClass()
```
  - setErrorClass
```
public void setErrorClass(byte errorClass)
                   throws IllegalArgumentException
```
    Sets the class of the error.
    
    Parameters:
    errorClass - The error class.
    
    Throws:
    
    IllegalArgumentException - Only error classes between 0 and 99 are valid.
  - getErrorNumber
```
public byte getErrorNumber()
```
  - setErrorNumber
```
public void setErrorNumber(byte errorNumber)
```
  - setErrorCode
```
public void setErrorCode(char code)
```
    A convenience method that sets error class and number according to the specified error code.
    The class represents the hundreds digit of the error code.
    The value MUST be between 1 and 6.
    The number represents the response code modulo 100, and its value MUST be between 0 and 99.
    
    Parameters:
    errorCode - the errorCode that this class encapsulates.
  - getErrorCode
```
public char getErrorCode()
```
    A convenience method that constructs an error code from this attribute's class and number.
    
    Returns:
    the code of the error this attribute represents.
  - getDefaultReasonPhrase
```
public static String getDefaultReasonPhrase(char errorCode)
```
    Returns a default reason phrase corresponding to the specified error code, as described by rfc 3489.
    
    Parameters:
    errorCode - the code of the error that the reason phrase must describe.
    
    Returns:
    a default reason phrase corresponding to the specified error code, as described by rfc 3489.
  - setReasonPhrase
```
public void setReasonPhrase(String reason)
```
    Set's a reason phrase. The reason phrase is meant for user consumption, and can be anything appropriate for the response code. The lengths of the reason phrases MUST be a multiple of 4 (measured in bytes).
    
    Parameters:
    reasonPhrase - a reason phrase that describes this error.
  - getReasonPhrase
```
public byte[] getReasonPhrase()
```
    Returns the reason phrase. The reason phrase is meant for user consumption, and can be anything appropriate for the response code. The lengths of the reason phrases MUST be a multiple of 4 (measured in bytes).
    
    Returns:
    reasonPhrase a reason phrase that describes this error.
  - 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.
  - 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.
  - 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[] 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.

Class ErrorCodeAttribute

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

NAME

BAD_REQUEST

UNAUTHORIZED

UNKNOWN_ATTRIBUTE

STALE_CREDENTIALS

INTEGRITY_CHECK_FAILURE

MISSING_USERNAME

USE_TLS

ROLE_CONFLICT

SERVER_ERROR

GLOBAL_FAILURE

Constructor Detail

ErrorCodeAttribute

Method Detail

getErrorClass

setErrorClass

getErrorNumber

setErrorNumber

setErrorCode

getErrorCode

getDefaultReasonPhrase

setReasonPhrase

getReasonPhrase

getDataLength

getName

equals

encode

decodeAttributeBody