org.restlet.ext.sip
Class SipStatus

java.lang.Object
  extended by org.restlet.ext.sip.SipStatus

public final class SipStatus
extends Object

Constants for SIP statuses.

Author:
Jerome Louvel

Field Summary
static Status CLIENT_ERROR_ADDRESS_INCOMPLETE
          The server received a request with a Request-URI that was incomplete.
static Status CLIENT_ERROR_AMBIGUOUS
          The Request-URI was ambiguous.
static Status CLIENT_ERROR_BAD_EXTENSION
          The server did not understand the protocol extension specified in a Proxy-Require or Require header field.
static Status CLIENT_ERROR_BAD_REQUEST
          The request could not be understood due to malformed syntax.
static Status CLIENT_ERROR_BUSY_HERE
          The callee's end system was contacted successfully, but the callee is currently not willing or able to take additional calls at this end system.
static Status CLIENT_ERROR_CALL_DOESNT_EXIST
          Indicates that the UAS received a request that does not match any existing dialog or transaction.
static Status CLIENT_ERROR_EXTENSION_REQUIRED
          The UAS needs a particular extension to process the request, but this extension is not listed in a Supported header field in the request.
static Status CLIENT_ERROR_FORBIDDEN
          The server understood the request, but is refusing to fulfill it.
static Status CLIENT_ERROR_GONE
          The requested resource is no longer available at the server and no forwarding address is known.
static Status CLIENT_ERROR_INTERVAL_TOO_BRIEF
          The server is rejecting the request because the expiration time of the resource refreshed by the request is too short.
static Status CLIENT_ERROR_LOOP_DETECTED
          The server has detected a loop.
static Status CLIENT_ERROR_METHOD_NOT_ALLOWED
          The method specified in the Request-Line is understood, but not allowed for the address identified by the Request-URI.
static Status CLIENT_ERROR_NOT_ACCEPTABLE
          The resource identified by the request is only capable of generating response entities that have content characteristics not acceptable according to the Accept header field sent in the request.
static Status CLIENT_ERROR_NOT_ACCEPTABLE_HERE
          The response has the same meaning as 606 (Not Acceptable), but only applies to the specific resource addressed by the Request-URI and the request may succeed elsewhere.
static Status CLIENT_ERROR_NOT_FOUND
          The server has definitive information that the user does not exist at the domain specified in the Request-URI.
static Status CLIENT_ERROR_PAYMENT_REQUIRED
          Reserved for future use.
static Status CLIENT_ERROR_PROXY_AUTHENTIFICATION_REQUIRED
          This code is similar to 401 (Unauthorized), but indicates that the client MUST first authenticate itself with the proxy.
static Status CLIENT_ERROR_REQUEST_ENTITY_TOO_LARGE
          The server is refusing to process a request because the request entity-body is larger than the server is willing or able to process.
static Status CLIENT_ERROR_REQUEST_PENDING
          The request was received by a UAS that had a pending request within the same dialog.
static Status CLIENT_ERROR_REQUEST_TERMINATED
          The request was terminated by a BYE or CANCEL request.
static Status CLIENT_ERROR_REQUEST_TIMEOUT
          The server could not produce a response within a suitable amount of time, for example, if it could not determine the location of the user in time.
static Status CLIENT_ERROR_REQUEST_UNDECIPHERABLE
          The request was received by a UAS that contained an encrypted MIME body for which the recipient does not possess or will not provide an appropriate decryption key.
static Status CLIENT_ERROR_REQUEST_URI_TOO_LONG
          The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret.
static Status CLIENT_ERROR_TEMPORARILY_UNAVAILABLE
          The callee's end system was contacted successfully but the callee is currently unavailable (for example, is not logged in, logged in but in a state that precludes communication with the callee, or has activated the "do not disturb" feature).
static Status CLIENT_ERROR_TOO_MANY_HOPS
          The server received a request that contains a Max-Forwards header field with the value zero.
static Status CLIENT_ERROR_UNAUTHORIZED
          The request requires user authentication.
static Status CLIENT_ERROR_UNSUPPORTED_MEDIA_TYPE
          The server is refusing to service the request because the message body of the request is in a format not supported by the server for the requested method.
static Status CLIENT_ERROR_UNSUPPORTED_URI_SCHEME
          The server cannot process the request because the scheme of the URI in the Request-URI is unknown to the server.
static Status GLOBAL_ERROR_BUSY_EVERYWHERE
          The callee's end system was contacted successfully but the callee is busy and does not wish to take the call at this time.
static Status GLOBAL_ERROR_DECLINE
          The callee's machine was successfully contacted but the user explicitly does not wish to or cannot participate.
static Status GLOBAL_ERROR_DOESNT_EXIST_ANYWHERE
          The server has authoritative information that the user indicated in the Request-URI does not exist anywhere.
static Status GLOBAL_ERROR_NOT_ACCEPTABLE
          The user's agent was contacted successfully but some aspects of the session description such as the requested media, bandwidth, or addressing style were not acceptable.
static Status INFO_CALL_IS_BEING_FORWARDED
          A server MAY use this status code to indicate that the call is being forwarded to a different set of destinations.
static Status INFO_QUEUED
          The called party is temporarily unavailable, but the server has decided to queue the call rather than reject it.
static Status INFO_RINGING
          The UA receiving the INVITE is trying to alert the user.
static Status INFO_SESSION_PROGRESS
          Used to convey information about the progress of the call that is not otherwise classified.
static Status INFO_TRYING
          This response indicates that the request has been received by the next-hop server and that some unspecified action is being taken on behalf of this call.
static Status REDIRECTION_ALTERNATIVE_SERVICE
          The call was not successful, but alternative services are possible.
static Status REDIRECTION_MOVED_PERMANENTLY
          The user can no longer be found at the address in the Request-URI, and the requesting client SHOULD retry at the new address given by the Contact header field.
static Status REDIRECTION_MOVED_TEMPORARILY
          The requesting client SHOULD retry the request at the new address(es) given by the Contact header field.
static Status REDIRECTION_MULTIPLE_CHOICES
          The address in the request resolved to several choices, each with its own specific location, and the user (or UA) can select a preferred communication end point and redirect its request to that location.
static Status REDIRECTION_USE_PROXY
          The requested resource MUST be accessed through the proxy given by the Contact field.
static Status SERVER_ERROR_BAD_GATEWAY
          The server, while acting as a gateway or proxy, received an invalid response from the downstream server it accessed in attempting to fulfill the request.
static Status SERVER_ERROR_INTERNAL
          The server encountered an unexpected condition that prevented it from fulfilling the request.
static Status SERVER_ERROR_MESSAGE_TOO_LARGE
          The server was unable to process the request since the message length exceeded its capabilities.
static Status SERVER_ERROR_NOT_IMPLEMENTED
          The server does not support the functionality required to fulfill the request.
static Status SERVER_ERROR_SERVER_TIMEOUT
          The server did not receive a timely response from an external server it accessed in attempting to process the request.
static Status SERVER_ERROR_SERVICE_UNAVAILABLE
          The server is temporarily unable to process the request due to a temporary overloading or maintenance of the server.
static Status SERVER_ERROR_VERSION_NOT_SUPPORTED
          The server does not support, or refuses to support, the SIP protocol version that was used in the request.
static Status SUCCESS_OK
          The request has succeeded.
 
Constructor Summary
SipStatus()
           
 
Method Summary
static Status valueOf(int code)
          Returns the status associated to a code.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INFO_TRYING

public static final Status INFO_TRYING
This response indicates that the request has been received by the next-hop server and that some unspecified action is being taken on behalf of this call.

See Also:
SIP RFC - 21.1.1 100 Trying

INFO_RINGING

public static final Status INFO_RINGING
The UA receiving the INVITE is trying to alert the user. This response MAY be used to initiate local ringback.

See Also:
SIP RFC - 21.1.2 180 Ringing

INFO_CALL_IS_BEING_FORWARDED

public static final Status INFO_CALL_IS_BEING_FORWARDED
A server MAY use this status code to indicate that the call is being forwarded to a different set of destinations.

See Also:
SIP RFC - 21.1.3 181 Call Is Being Forwarded

INFO_QUEUED

public static final Status INFO_QUEUED
The called party is temporarily unavailable, but the server has decided to queue the call rather than reject it. When the callee becomes available, it will return the appropriate final status response.

See Also:
SIP RFC - 21.1.4 182 Queued

INFO_SESSION_PROGRESS

public static final Status INFO_SESSION_PROGRESS
Used to convey information about the progress of the call that is not otherwise classified.

See Also:
SIP RFC - 21.1.5 183 Session Progress

SUCCESS_OK

public static final Status SUCCESS_OK
The request has succeeded. The information returned with the response depends on the method used in the request.

See Also:
SIP RFC - 21.2.1 200 Success

REDIRECTION_MULTIPLE_CHOICES

public static final Status REDIRECTION_MULTIPLE_CHOICES
The address in the request resolved to several choices, each with its own specific location, and the user (or UA) can select a preferred communication end point and redirect its request to that location.

See Also:
SIP RFC - 21.3.1 300 Multiple Choices

REDIRECTION_MOVED_PERMANENTLY

public static final Status REDIRECTION_MOVED_PERMANENTLY
The user can no longer be found at the address in the Request-URI, and the requesting client SHOULD retry at the new address given by the Contact header field.

See Also:
SIP RFC - 21.3.2 301 Moved Permanently

REDIRECTION_MOVED_TEMPORARILY

public static final Status REDIRECTION_MOVED_TEMPORARILY
The requesting client SHOULD retry the request at the new address(es) given by the Contact header field.

See Also:
SIP RFC - 21.3.3 302 Moved Temporarily

REDIRECTION_USE_PROXY

public static final Status REDIRECTION_USE_PROXY
The requested resource MUST be accessed through the proxy given by the Contact field.

See Also:
SIP RFC - 21.3.4 305 Use Proxy

REDIRECTION_ALTERNATIVE_SERVICE

public static final Status REDIRECTION_ALTERNATIVE_SERVICE
The call was not successful, but alternative services are possible.

See Also:
SIP RFC - 21.3.5 380 Alternative Service

CLIENT_ERROR_BAD_REQUEST

public static final Status CLIENT_ERROR_BAD_REQUEST
The request could not be understood due to malformed syntax.

See Also:
SIP RFC - 21.4.1 400 Bad Request

CLIENT_ERROR_UNAUTHORIZED

public static final Status CLIENT_ERROR_UNAUTHORIZED
The request requires user authentication.

See Also:
SIP RFC - 21.4.2 401 Unauthorized

CLIENT_ERROR_PAYMENT_REQUIRED

public static final Status CLIENT_ERROR_PAYMENT_REQUIRED
Reserved for future use.

See Also:
SIP RFC - 21.4.3 402 Payment Required

CLIENT_ERROR_FORBIDDEN

public static final Status CLIENT_ERROR_FORBIDDEN
The server understood the request, but is refusing to fulfill it. Authorization will not help, and the request SHOULD NOT be repeated.

See Also:
SIP RFC - 21.4.4 403 Forbidden

CLIENT_ERROR_NOT_FOUND

public static final Status CLIENT_ERROR_NOT_FOUND
The server has definitive information that the user does not exist at the domain specified in the Request-URI. This status is also returned if the domain in the Request-URI does not match any of the domains handled by the recipient of the request.

See Also:
SIP RFC - 21.4.5 404 Not Found

CLIENT_ERROR_METHOD_NOT_ALLOWED

public static final Status CLIENT_ERROR_METHOD_NOT_ALLOWED
The method specified in the Request-Line is understood, but not allowed for the address identified by the Request-URI.

See Also:
SIP RFC - 21.4.6 405 Method Not Allowed

CLIENT_ERROR_NOT_ACCEPTABLE

public static final Status CLIENT_ERROR_NOT_ACCEPTABLE
The resource identified by the request is only capable of generating response entities that have content characteristics not acceptable according to the Accept header field sent in the request.

See Also:
SIP RFC - 21.4.7 406 Not Acceptable

CLIENT_ERROR_PROXY_AUTHENTIFICATION_REQUIRED

public static final Status CLIENT_ERROR_PROXY_AUTHENTIFICATION_REQUIRED
This code is similar to 401 (Unauthorized), but indicates that the client MUST first authenticate itself with the proxy.

See Also:
SIP RFC - 21.4.8 407 Proxy Authentication Required

CLIENT_ERROR_REQUEST_TIMEOUT

public static final Status CLIENT_ERROR_REQUEST_TIMEOUT
The server could not produce a response within a suitable amount of time, for example, if it could not determine the location of the user in time. The client MAY repeat the request without modifications at any later time.

See Also:
SIP RFC - 21.4.9 408 Request Timeout

CLIENT_ERROR_GONE

public static final Status CLIENT_ERROR_GONE
The requested resource is no longer available at the server and no forwarding address is known. This condition is expected to be considered permanent.

See Also:
SIP RFC - 21.4.10 410 Gone

CLIENT_ERROR_REQUEST_ENTITY_TOO_LARGE

public static final Status CLIENT_ERROR_REQUEST_ENTITY_TOO_LARGE
The server is refusing to process a request because the request entity-body is larger than the server is willing or able to process. The server MAY close the connection to prevent the client from continuing the request.

See Also:
SIP RFC - 21.4.11 413 Request Entity Too Large

CLIENT_ERROR_REQUEST_URI_TOO_LONG

public static final Status CLIENT_ERROR_REQUEST_URI_TOO_LONG
The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret.

See Also:
SIP RFC - 21.4.12 414 Request-URI Too Long

CLIENT_ERROR_UNSUPPORTED_MEDIA_TYPE

public static final Status CLIENT_ERROR_UNSUPPORTED_MEDIA_TYPE
The server is refusing to service the request because the message body of the request is in a format not supported by the server for the requested method.

See Also:
SIP RFC - 21.4.13 415 Unsupported Media Type

CLIENT_ERROR_UNSUPPORTED_URI_SCHEME

public static final Status CLIENT_ERROR_UNSUPPORTED_URI_SCHEME
The server cannot process the request because the scheme of the URI in the Request-URI is unknown to the server.

See Also:
SIP RFC - 21.4.14 416 Unsupported URI Scheme

CLIENT_ERROR_BAD_EXTENSION

public static final Status CLIENT_ERROR_BAD_EXTENSION
The server did not understand the protocol extension specified in a Proxy-Require or Require header field.

See Also:
SIP RFC - 21.4.15 420 Bad Extension

CLIENT_ERROR_EXTENSION_REQUIRED

public static final Status CLIENT_ERROR_EXTENSION_REQUIRED
The UAS needs a particular extension to process the request, but this extension is not listed in a Supported header field in the request.

See Also:
SIP RFC - 21.4.16 421 Extension Required

CLIENT_ERROR_INTERVAL_TOO_BRIEF

public static final Status CLIENT_ERROR_INTERVAL_TOO_BRIEF
The server is rejecting the request because the expiration time of the resource refreshed by the request is too short. This response can be used by a registrar to reject a registration whose Contact header field expiration time was too small.

See Also:
SIP RFC - 21.4.17 423 Interval Too Brief

CLIENT_ERROR_TEMPORARILY_UNAVAILABLE

public static final Status CLIENT_ERROR_TEMPORARILY_UNAVAILABLE
The callee's end system was contacted successfully but the callee is currently unavailable (for example, is not logged in, logged in but in a state that precludes communication with the callee, or has activated the "do not disturb" feature).

See Also:
SIP RFC - 21.4.18 480 Temporarily Unavailable

CLIENT_ERROR_CALL_DOESNT_EXIST

public static final Status CLIENT_ERROR_CALL_DOESNT_EXIST
Indicates that the UAS received a request that does not match any existing dialog or transaction.

See Also:
SIP RFC - 21.4.19 481 Call/Transaction Does Not Exist

CLIENT_ERROR_LOOP_DETECTED

public static final Status CLIENT_ERROR_LOOP_DETECTED
The server has detected a loop.

See Also:
SIP RFC - 21.4.20 482 Loop Detected

CLIENT_ERROR_TOO_MANY_HOPS

public static final Status CLIENT_ERROR_TOO_MANY_HOPS
The server received a request that contains a Max-Forwards header field with the value zero.

See Also:
SIP RFC - 21.4.21 483 Too Many Hops

CLIENT_ERROR_ADDRESS_INCOMPLETE

public static final Status CLIENT_ERROR_ADDRESS_INCOMPLETE
The server received a request with a Request-URI that was incomplete. Additional information SHOULD be provided in the reason phrase.

See Also:
SIP RFC - 21.4.22 484 Address Incomplete

CLIENT_ERROR_AMBIGUOUS

public static final Status CLIENT_ERROR_AMBIGUOUS
The Request-URI was ambiguous. The response MAY contain a listing of possible unambiguous addresses in Contact header fields. Revealing alternatives can infringe on privacy of the user or the organization.

See Also:
SIP RFC - 21.4.24 485 Ambiguous

CLIENT_ERROR_BUSY_HERE

public static final Status CLIENT_ERROR_BUSY_HERE
The callee's end system was contacted successfully, but the callee is currently not willing or able to take additional calls at this end system.

See Also:
SIP RFC - 21.4.25 486 Busy Here

CLIENT_ERROR_REQUEST_TERMINATED

public static final Status CLIENT_ERROR_REQUEST_TERMINATED
The request was terminated by a BYE or CANCEL request. This response is never returned for a CANCEL request itself.

See Also:
SIP RFC - 21.4.26 487 Request Terminated

CLIENT_ERROR_NOT_ACCEPTABLE_HERE

public static final Status CLIENT_ERROR_NOT_ACCEPTABLE_HERE
The response has the same meaning as 606 (Not Acceptable), but only applies to the specific resource addressed by the Request-URI and the request may succeed elsewhere.

See Also:
SIP RFC - 21.4.27 488 Not Acceptable Here

CLIENT_ERROR_REQUEST_PENDING

public static final Status CLIENT_ERROR_REQUEST_PENDING
The request was received by a UAS that had a pending request within the same dialog.

See Also:
SIP RFC - 21.4.28 491 Request Pending

CLIENT_ERROR_REQUEST_UNDECIPHERABLE

public static final Status CLIENT_ERROR_REQUEST_UNDECIPHERABLE
The request was received by a UAS that contained an encrypted MIME body for which the recipient does not possess or will not provide an appropriate decryption key.

See Also:
SIP RFC - 21.4.29 493 Undecipherable

SERVER_ERROR_INTERNAL

public static final Status SERVER_ERROR_INTERNAL
The server encountered an unexpected condition that prevented it from fulfilling the request. The client MAY display the specific error condition and MAY retry the request after several seconds.

See Also:
SIP RFC - 21.5.1 500 Server Internal Error

SERVER_ERROR_NOT_IMPLEMENTED

public static final Status SERVER_ERROR_NOT_IMPLEMENTED
The server does not support the functionality required to fulfill the request. This is the appropriate response when a UAS does not recognize the request method and is not capable of supporting it for any user.

See Also:
SIP RFC - 21.5.2 501 Not Implemented

SERVER_ERROR_BAD_GATEWAY

public static final Status SERVER_ERROR_BAD_GATEWAY
The server, while acting as a gateway or proxy, received an invalid response from the downstream server it accessed in attempting to fulfill the request.

See Also:
SIP RFC - 21.5.3 502 Bad Gateway

SERVER_ERROR_SERVICE_UNAVAILABLE

public static final Status SERVER_ERROR_SERVICE_UNAVAILABLE
The server is temporarily unable to process the request due to a temporary overloading or maintenance of the server. The server MAY indicate when the client should retry the request in a Retry-After header field.

See Also:
SIP RFC - 21.5.4 503 Service Unavailable

SERVER_ERROR_SERVER_TIMEOUT

public static final Status SERVER_ERROR_SERVER_TIMEOUT
The server did not receive a timely response from an external server it accessed in attempting to process the request. 408 (Request Timeout) should be used instead if there was no response within the period specified in the Expires header field from the upstream server.

See Also:
SIP RFC - 21.5.5 504 Server Time-out

SERVER_ERROR_VERSION_NOT_SUPPORTED

public static final Status SERVER_ERROR_VERSION_NOT_SUPPORTED
The server does not support, or refuses to support, the SIP protocol version that was used in the request. The server is indicating that it is unable or unwilling to complete the request using the same major version as the client, other than with this error message.

See Also:
SIP RFC - 21.5.6 505 Version Not Supported

SERVER_ERROR_MESSAGE_TOO_LARGE

public static final Status SERVER_ERROR_MESSAGE_TOO_LARGE
The server was unable to process the request since the message length exceeded its capabilities.

See Also:
SIP RFC - 21.5.7 513 Message Too Large

GLOBAL_ERROR_BUSY_EVERYWHERE

public static final Status GLOBAL_ERROR_BUSY_EVERYWHERE
The callee's end system was contacted successfully but the callee is busy and does not wish to take the call at this time.

See Also:
SIP RFC - 21.6.1 600 Busy Everywhere

GLOBAL_ERROR_DECLINE

public static final Status GLOBAL_ERROR_DECLINE
The callee's machine was successfully contacted but the user explicitly does not wish to or cannot participate.

See Also:
SIP RFC - 21.6.2 603 Decline

GLOBAL_ERROR_DOESNT_EXIST_ANYWHERE

public static final Status GLOBAL_ERROR_DOESNT_EXIST_ANYWHERE
The server has authoritative information that the user indicated in the Request-URI does not exist anywhere.

See Also:
SIP RFC - 21.6.3 604 Does Not Exist Anywhere

GLOBAL_ERROR_NOT_ACCEPTABLE

public static final Status GLOBAL_ERROR_NOT_ACCEPTABLE
The user's agent was contacted successfully but some aspects of the session description such as the requested media, bandwidth, or addressing style were not acceptable.

See Also:
SIP RFC - 21.6.4 606 Not Acceptable
Constructor Detail

SipStatus

public SipStatus()
Method Detail

valueOf

public static Status valueOf(int code)
Returns the status associated to a code. If an existing constant exists then it is returned, otherwise a new instance is created.

Parameters:
code - The code.
Returns:
The associated status.


Copyright © 2005-2013 Restlet.