javax.servlet.sip
Class Rel100Exception

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by javax.servlet.ServletException
              extended by javax.servlet.sip.Rel100Exception
All Implemented Interfaces:
java.io.Serializable

public class Rel100Exception
extends javax.servlet.ServletException

Indicates that a provisional response cannot be sent reliably or PRACK was attempted to be created on a non reliable provisional response.

This is thrown by the container when an application requested that a provisional response be sent reliably (using the 100rel extension defined in RFC 3262) but one or more of the conditions for using 100rel is not satisfied:

This exception is also thrown when SipServletResponse.createPrack() is called for non-reliable provisional response or a final response or if the original request was not an INVITE.

The actual reason why SipServletResponse.sendReliably() or SipServletResponse.createPrack() failed can be discovered through getReason().

See Also:
Serialized Form

Field Summary
static int NO_REQ_SUPPORT
          Reason code indicating that the UAC didn't indicate support for the reliable responses extension in the request.
static int NOT_100rel
          Reason code indicating that SipServletResponse.createPrack() was invoked on a provisional response that is not reliable.
static int NOT_1XX
          Reason code indicating that SipServletResponse.sendReliably() or SipServletResponse.createPrack() was invoked on a final or a 100 response.
static int NOT_INVITE
          Reason code indicating that SipServletResponse.sendReliably() or SipServletResponse.createPrack() was invoked for a response to a non-INVITE request.
static int NOT_SUPPORTED
          Reason code indicating that the container does not support reliable provisional response.
 
Constructor Summary
Rel100Exception(int reason)
          Constructs a new Rel100Exception with the specified error reason.
 
Method Summary
 java.lang.String getMessage()
          Returns message phrase suitable for the reason integer code.
 int getReason()
          Returns an integer code indicating the specific reason why this exception was thrown.
 
Methods inherited from class javax.servlet.ServletException
getRootCause
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NOT_1XX

public static final int NOT_1XX
Reason code indicating that SipServletResponse.sendReliably() or SipServletResponse.createPrack() was invoked on a final or a 100 response.

See Also:
Constant Field Values

NOT_INVITE

public static final int NOT_INVITE
Reason code indicating that SipServletResponse.sendReliably() or SipServletResponse.createPrack() was invoked for a response to a non-INVITE request.

See Also:
Constant Field Values

NO_REQ_SUPPORT

public static final int NO_REQ_SUPPORT
Reason code indicating that the UAC didn't indicate support for the reliable responses extension in the request.

See Also:
Constant Field Values

NOT_SUPPORTED

public static final int NOT_SUPPORTED
Reason code indicating that the container does not support reliable provisional response.

See Also:
Constant Field Values

NOT_100rel

public static final int NOT_100rel
Reason code indicating that SipServletResponse.createPrack() was invoked on a provisional response that is not reliable.

See Also:
Constant Field Values
Constructor Detail

Rel100Exception

public Rel100Exception(int reason)
Constructs a new Rel100Exception with the specified error reason.

Parameters:
reason - one of NOT_1XX, NOT_INVITE, NO_REQ_SUPPORT, NOT_SUPPORTED, NOT_100rel
Method Detail

getReason

public int getReason()
Returns an integer code indicating the specific reason why this exception was thrown.

Returns:
one of NOT_1XX, NOT_INVITE, NO_REQ_SUPPORT, NOT_SUPPORTED, NOT_100rel

getMessage

public java.lang.String getMessage()
Returns message phrase suitable for the reason integer code.

Overrides:
getMessage in class java.lang.Throwable
Returns:
descriptive message phrase