Package javax.servlet.sip

The javax.servlet.sip package is the API for the SIP Servlets developed under JSR 289, this v1.1 version obsoletes v1.0.

See:
Description

Interface Summary

Address	Represents SIP addresses as found, for example, in From, To, and Contact headers.
AuthInfo	This interface allows applications to set the authentication information on servlet initiated requests that are challenged by a Proxy or UAS.
B2buaHelper	Helper class providing support for B2BUA applications.
ConvergedHttpSession	The ConvergedHttpSession class provides access to HttpSession related functionality which is only present in a converged HTTP/SIP container.
Parameterable	The Parameterable interface is used to indicate a SIP header field value with optional parameters.
Proxy	Represents the operation of proxying a SIP request.
ProxyBranch	A ProxyBranch represents a branch which the Proxy sends out the request on.
ServletTimer	Created by the TimerService for servlet applications wishing to schedule future tasks.
SipApplicationSession	Represents application instances.
SipApplicationSessionActivationListener	Objects that are bound to a SipApplicationSession may listen to container events notifying them when the application session to which they are bound will be passivated or activated.
SipApplicationSessionAttributeListener	This listener interface can be implemented in order to get notifications of changes to the attribute lists of application sessions.
SipApplicationSessionBindingListener	Causes an object to be notified when it is bound to or unbound from a SipApplicationSession.
SipApplicationSessionListener	Implementations of this interface can receive notifications about invalidated and/or activated SipApplicationSession objects in the SIP application they are part of.
SipErrorListener	Causes applications to be notified of various error conditions occurring during regular SIP transaction processing.
SipFactory	Factory interface for a variety of SIP Servlet API abstractions.
SipServletListener	Containers are required to invoke init() on the servlets before the servlets are ready for service.
SipServletMessage	Defines common aspects of SIP requests and responses.
SipServletRequest	Represents SIP request messages.
SipServletResponse	Represents SIP responses.
SipSession	Represents point-to-point SIP relationships.
SipSessionActivationListener	Objects that are bound to a session may listen to container events notifying them that sessions will be passivated and that session will be activated.
SipSessionAttributeListener	This listener interface can be implemented in order to get notifications of changes to the attribute lists of sessions within this SIP servlet application.
SipSessionBindingListener	Causes an object to be notified when it is bound to or unbound from a SipSession.
SipSessionListener	Implementations of this interface are notified of changes to the list of active SipSessions in a SIP servlet application.
SipSessionsUtil	A utility class providing additional support for converged HTTP/SIP applications and converged Java EE / SIP applications.
SipURI	Represents sip and sips URIs.
TelURL	Represents tel URLs as defined by RFC 3966.
TimerListener	Listener interface implemented by SIP servlet applications using timers.
TimerService	Allows SIP servlet applications to set timers in order to receive notifications on timer expiration.
URI	Base interface for any type of URI.

Class Summary

SipApplicationSessionBindingEvent	Events of this type are either sent to an object that implements SipApplicationSessionBindingListener when it is bound or unbound from an application session, or to a SipApplicationSessionAttributeListener that has been configured in the deployment descriptor when any attribute is bound, unbound or replaced in an application session.
SipApplicationSessionEvent	This is the class representing event notifications for changes to SipApplicationSessions within a SIP servlet application.
SipErrorEvent	Events of this type are sent to objects implementing the SipErrorListener interface when an error occurs which is related to the applications processing of a SIP transaction.
SipServlet	Provides an abstract class to be subclassed to create a SIP servlet.
SipServletContextEvent	SIP Servlet specific context event.
SipSessionBindingEvent	Events of this type are either sent to an object that implements SipSessionBindingListener when it is bound or unbound from a session, or to a SipSessionAttributeListener that has been configured in the deployment descriptor when any attribute is bound, unbound or replaced in a session.
SipSessionEvent	This is the class representing event notifications for changes to SipSessions within a SIP servlet application.

Enum Summary

SipApplicationSession.Protocol	Possible protocols to which sessions contained in the SipApplicationSession belong to.
SipServletMessage.HeaderForm	Type header forms.
SipSession.State	Possible SIP dialog states from SipSession FSM.
UAMode	User Agent modes, UAC (client) or UAS (server)

Exception Summary

Rel100Exception	Indicates that a provisional response cannot be sent reliably or PRACK was attempted to be created on a non reliable provisional response.
ServletParseException	Thrown by the container when an application attempts to parse a malformed header or addressing structure.
TooManyHopsException	Thrown when a SIP Servlet application attempts to obtain a Proxy object for a request with a Max-Forwards header with value 0.

Package javax.servlet.sip Description

The javax.servlet.sip package is the API for the SIP Servlets developed under JSR 289, this v1.1 version obsoletes v1.0. The Session Initiation Protocol (SIP) is used to establish, modify, and tear down IP multimedia sessions including IP telephony, presence, instant messaging besides other SIP applications . An important aspect of any communication infrastructure is programmability and the purpose of the SIP Servlet API is to standardize the platform for delivering SIP based services. SIP Servlet API is based on the Servlet API and model. This API is parallel to the HTTP Servlet API.

Related Documentation

For a complete specification document on the SIP Servlests please visit the JSR 289 home page