ErrorCodeAttribute (ice4j 2.0.0-SNAPSHOT API)

java.lang.Object
- org.ice4j.attribute.Attribute
- - org.ice4j.attribute.ErrorCodeAttribute

```
public class ErrorCodeAttribute
extends Attribute
```
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.

Author:

Emil Ivov, Aakash Garg

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`ADDRESS_FAMILY_NOT_SUPPORTED` Address Family not Supported error code.
`static char`	`ALLOCATION_MISMATCH` Allocation Mismatch error code.
`static char`	`ALLOCATION_QUOTA_REACHED` Allocation Quota reached error code.
`static char`	`BAD_REQUEST` Bad request error code.
`static char`	`CONNECTION_ALREADY_EXISTS` Connection Already Exists error code.
`static char`	`CONNECTION_TIMEOUT_OR_FAILURE` Connection Timeout or Failure error code.
`private byte`	`errorClass` The class represents the hundreds digit of the response code.
`private byte`	`errorNumber` The number represents the response code modulo 100, and its value MUST be between 0 and 99.
`static char`	`FORBIDDEN` Forbidden error code.
`static char`	`GLOBAL_FAILURE` Global failure error code.
`static char`	`INSUFFICIENT_CAPACITY` Insufficient Capacity error code.
`static char`	`INTEGRITY_CHECK_FAILURE` Integrity check failure error code.
`static char`	`MISSING_USERNAME` Missing username error code.
`static String`	`NAME` Attribute's name.
`static char`	`PEER_ADDRESS_FAMILY_MISMATCH` Peer Address Family Mismatch error code.
`private byte[]`	`reasonPhrase` The reason phrase is meant for user consumption, and can be anything appropriate for the response code.
`static char`	`ROLE_CONFLICT` Role conflict error code.
`static char`	`SERVER_ERROR` Server error code.
`static char`	`STALE_CREDENTIALS` Stale credentials error code.
`static char`	`STALE_NONCE` Stale Nonce error code.
`static char`	`TRY_ALTERNATE` Try Alternate error code.
`static char`	`UNAUTHORIZED` Unauthorized error code.
`static char`	`UNKNOWN_ATTRIBUTE` Unknown attribute error code.
`static char`	`UNSUPPORTED_TRANSPORT_PROTOCOL` Unsupported Transport Protocol error code.
`static char`	`USE_TLS` Use TLS error code.
`static char`	`WRONG_CREDENTIALS` Wrong Credentials error code.

Constructor Summary

Constructors
Constructor and Description

ErrorCodeAttribute()
Constructs a new ERROR-CODE attribute

Constructors
Constructor and Description
`ErrorCodeAttribute()` Constructs a new ERROR-CODE attribute

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) 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 obj)` 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()` Returns this error's error class.
`char`	`getErrorCode()` A convenience method that constructs an error code from this Attribute's class and number.
`byte`	`getErrorNumber()` Returns this attribute's error number.
`String`	`getName()` Returns the human readable name of this attribute.
`String`	`getReasonPhrase()` Returns the reason phrase.
`void`	`setErrorClass(byte errorClass)` Sets this error's error class.
`void`	`setErrorCode(char errorCode)` A convenience method that sets error class and number according to the specified errorCode.The class represents the hundreds digit of the error code.
`void`	`setErrorNumber(byte errorNumber)` Sets this attribute's error number.
`void`	`setReasonPhrase(String reasonPhrase)` Set's a reason phrase.

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's name.
    
    See Also:
    
    Constant Field Values
  - TRY_ALTERNATE
```
public static final char TRY_ALTERNATE
```
    Try Alternate error code.
    
    See Also:
    
    Constant Field Values
  - BAD_REQUEST
```
public static final char BAD_REQUEST
```
    Bad request error code.
    
    See Also:
    
    Constant Field Values
  - UNAUTHORIZED
```
public static final char UNAUTHORIZED
```
    Unauthorized error code.
    
    See Also:
    
    Constant Field Values
  - FORBIDDEN
```
public static final char FORBIDDEN
```
    Forbidden error code.
    
    See Also:
    
    Constant Field Values
  - UNKNOWN_ATTRIBUTE
```
public static final char UNKNOWN_ATTRIBUTE
```
    Unknown attribute error code.
    
    See Also:
    
    Constant Field Values
  - STALE_CREDENTIALS
```
public static final char STALE_CREDENTIALS
```
    Stale credentials error code.
    
    See Also:
    
    Constant Field Values
  - INTEGRITY_CHECK_FAILURE
```
public static final char INTEGRITY_CHECK_FAILURE
```
    Integrity check failure error code.
    
    See Also:
    
    Constant Field Values
  - MISSING_USERNAME
```
public static final char MISSING_USERNAME
```
    Missing username error code.
    
    See Also:
    
    Constant Field Values
  - USE_TLS
```
public static final char USE_TLS
```
    Use TLS error code.
    
    See Also:
    
    Constant Field Values
  - ALLOCATION_MISMATCH
```
public static final char ALLOCATION_MISMATCH
```
    Allocation Mismatch error code.
    
    See Also:
    
    Constant Field Values
  - STALE_NONCE
```
public static final char STALE_NONCE
```
    Stale Nonce error code.
    
    See Also:
    
    Constant Field Values
  - ADDRESS_FAMILY_NOT_SUPPORTED
```
public static final char ADDRESS_FAMILY_NOT_SUPPORTED
```
    Address Family not Supported error code.
    
    See Also:
    
    Constant Field Values
  - WRONG_CREDENTIALS
```
public static final char WRONG_CREDENTIALS
```
    Wrong Credentials error code.
    
    See Also:
    
    Constant Field Values
  - UNSUPPORTED_TRANSPORT_PROTOCOL
```
public static final char UNSUPPORTED_TRANSPORT_PROTOCOL
```
    Unsupported Transport Protocol error code.
    
    See Also:
    
    Constant Field Values
  - PEER_ADDRESS_FAMILY_MISMATCH
```
public static final char PEER_ADDRESS_FAMILY_MISMATCH
```
    Peer Address Family Mismatch error code.
    
    See Also:
    
    Constant Field Values
  - CONNECTION_ALREADY_EXISTS
```
public static final char CONNECTION_ALREADY_EXISTS
```
    Connection Already Exists error code.
    
    See Also:
    
    Constant Field Values
  - CONNECTION_TIMEOUT_OR_FAILURE
```
public static final char CONNECTION_TIMEOUT_OR_FAILURE
```
    Connection Timeout or Failure error code.
    
    See Also:
    
    Constant Field Values
  - ALLOCATION_QUOTA_REACHED
```
public static final char ALLOCATION_QUOTA_REACHED
```
    Allocation Quota reached error code.
    
    See Also:
    
    Constant Field Values
  - ROLE_CONFLICT
```
public static final char ROLE_CONFLICT
```
    Role conflict error code.
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR
```
public static final char SERVER_ERROR
```
    Server error code.
    
    See Also:
    
    Constant Field Values
  - INSUFFICIENT_CAPACITY
```
public static final char INSUFFICIENT_CAPACITY
```
    Insufficient Capacity error code.
    
    See Also:
    
    Constant Field Values
  - GLOBAL_FAILURE
```
public static final char GLOBAL_FAILURE
```
    Global failure error code.
    
    See Also:
    
    Constant Field Values
  - errorClass
```
private byte errorClass
```
    The class represents the hundreds digit of the response code. The value MUST be between 1 and 6.
  - errorNumber
```
private byte errorNumber
```
    The number represents the response code modulo 100, and its value MUST be between 0 and 99.
  - reasonPhrase
```
private byte[] reasonPhrase
```
    The reason phrase is meant for user consumption, and can be anything appropriate for the response code.
- Constructor Detail
  - ErrorCodeAttribute
```
ErrorCodeAttribute()
```
    Constructs a new ERROR-CODE attribute
- Method Detail
  - setErrorCode
```
public void setErrorCode(char errorCode)
                  throws IllegalArgumentException
```
    A convenience method that sets error class and number according to the specified errorCode.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.
    
    Throws:
    
    IllegalArgumentException - if errorCode is not a valid error code.
  - 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.
  - setErrorNumber
```
public void setErrorNumber(byte errorNumber)
                    throws IllegalArgumentException
```
    Sets this attribute's error number.
    
    Parameters:
    
    errorNumber - the error number to assign this attribute.
    
    Throws:
    
    IllegalArgumentException - if errorNumber is not a valid error number.
  - getErrorNumber
```
public byte getErrorNumber()
```
    Returns this attribute's error number.
    
    Returns:
    
    this attribute's error number.
  - setErrorClass
```
public void setErrorClass(byte errorClass)
                   throws IllegalArgumentException
```
    Sets this error's error class.
    
    Parameters:
    
    errorClass - this error's error class.
    
    Throws:
    
    IllegalArgumentException - if errorClass is not a valid error class.
  - getErrorClass
```
public byte getErrorClass()
```
    Returns this error's error class.
    
    Returns:
    
    this error's error class.
  - 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 reasonPhrase)
```
    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 String 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.
  - getName
```
public String getName()
```
    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 Attribute
    
    Returns:
    
    this attribute's name.
  - 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.
  - encode
```
public byte[] encode()
```
    Returns a binary representation of this attribute.
    
    Specified by:
    
    encode in class Attribute
    
    Returns:
    
    a binary representation of this attribute.
  - equals
```
public boolean equals(Object obj)
```
    Compares two STUN Attributes. Attributes are considered equal when their type, length, and all data are the same.
    
    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.
  - decodeAttributeBody
```
void decodeAttributeBody(byte[] attributeValue,
                         char offset,
                         char length)
```
    Sets this attribute's fields according to attributeValue array.
    
    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.

Class ErrorCodeAttribute

Field Summary

Fields inherited from class org.ice4j.attribute.Attribute

Constructor Summary

Method Summary

Methods inherited from class org.ice4j.attribute.Attribute

Methods inherited from class java.lang.Object

Field Detail

NAME

TRY_ALTERNATE

BAD_REQUEST

UNAUTHORIZED

FORBIDDEN

UNKNOWN_ATTRIBUTE

STALE_CREDENTIALS

INTEGRITY_CHECK_FAILURE

MISSING_USERNAME

USE_TLS

ALLOCATION_MISMATCH

STALE_NONCE

ADDRESS_FAMILY_NOT_SUPPORTED

WRONG_CREDENTIALS

UNSUPPORTED_TRANSPORT_PROTOCOL

PEER_ADDRESS_FAMILY_MISMATCH

CONNECTION_ALREADY_EXISTS

CONNECTION_TIMEOUT_OR_FAILURE

ALLOCATION_QUOTA_REACHED

ROLE_CONFLICT

SERVER_ERROR

INSUFFICIENT_CAPACITY

GLOBAL_FAILURE

errorClass

errorNumber

reasonPhrase

Constructor Detail

ErrorCodeAttribute

Method Detail

setErrorCode

getErrorCode

setErrorNumber

getErrorNumber

setErrorClass

getErrorClass

getDefaultReasonPhrase

setReasonPhrase

getReasonPhrase

getName

getDataLength

encode

equals

decodeAttributeBody