Package javax.servlet.sip

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

See: Description

Interface Summary

Interface	Description
Address	Represents SIP addresses as found, for example, in From, To, and Contact headers.
AttributeStore	Interface representing a store of attributes.
AttributeStoreBindingListener<T extends AttributeStore>	Causes an object to be notified when it is bound to or unbound from an attribute store.
AttributeStoreListener<T extends AttributeStore>	This listener interface can be implemented in order to get notifications of changes to the attribute lists of attribute stores within this SIP servlet application.
AuthInfo	This interface allows applications to set the authentication information on servlet initiated requests that are challenged by a Proxy or UAS.
AutomaticProcessingListener	Implementations of this interface receives the SIP messages after application has relinquished the control over the SipSession using methods like SipSession.terminateDialog().
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.
DnsResolver	Interface encapsulating DNS resolution.
Flow	As per RFC 5626, flow is a transport-layer association between two hosts that is represented by the network address and port number of both ends and by the transport protocol.
FlowListener	An instance of FlowListener may be configured as a SipListener.
ForkingContext	A ForkingContext ties together SipSessions that are related by forking of the same common SIP dialog.
InviteBranch	Represents an initial invite transaction branch in the context of a single session or dialog.
Parameterable	The Parameterable interface is used to indicate a SIP header field value with optional parameters.
Predicate<M extends SipServletMessage>	A predicate that can be applied by SIP Servlet container for selecting a method for execution.
Proxy	Represents the operation of proxying a SIP request.
ProxyBranch	A ProxyBranch represents a branch which the Proxy sends out the request on.
ProxyBranch.Callback	Application may use an implementation of this interface to be called back by the container.
ServletTimer	Created by the TimerService for servlet applications wishing to schedule future tasks.
SessionKeepAlive	Represents Session Keep Alive as specified in RFC 4028.
SessionKeepAlive.Callback	An implementation of this interface may be set on the SessionKeepAlive as a refresh task and/or expiry callback.
SessionKeepAlive.Preference	Holds the preference data in the SIP message headers.
SipApplicationConfiguration	Interface for configuring a SIP application programmatically.
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	Deprecated As of release 2.0, replaced by AttributeStoreListener This listener interface can be implemented in order to get notifications of changes to the attribute lists of application sessions.
SipApplicationSessionBindingListener	Deprecated As of release 2.0, replaced by AttributeStoreBindingListener 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.
SipServletContext	Defines a set of method that a SIP servlet application can use to communicate with SIP servlet container.
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	Deprecated As of release 2.0, replaced by AttributeStoreListener 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	Deprecated As of release 2.0, replaced by AttributeStoreBindingListener 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.
SipWebSocketContext	Each SIP WebSocket connection established to a SIP Servlet container has an associated instance of SipWebSocketContext interface.
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

Class	Description
AttributeStoreBindingEvent<T extends AttributeStore>	Events of this type are either sent to an object that implements AttributeStoreBindingListener when it is bound or unbound from an attribute store, or to a AttributeStoreListener that has been configured in the deployment descriptor when any attribute is bound, unbound or replaced in a forking context.
FlowFailedEvent	EventObject representing the flow failure.
SipApplicationSessionBindingEvent	Deprecated As of release 2.0, replaced by AttributeStoreBindingEvent 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	Deprecated As of release 2.0, replaced by AttributeStoreBindingEvent 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

Enum	Description
ConcurrencyMode	Concurrency modes application may specify using {code SipApplication} annotation.
SessionKeepAlive.Refresher	Represents the refresher type.
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

Exception	Description
InsufficientBreadthException	When a SIP Servlet application attempts to proxy a request or forward a request as a B2BUA, that cause the total Max-Breadth of the active parallel branches exceed the Max-Breadth of the original incoming request, this exception is thrown.
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 359, this v2.0 version updates v1.1 developed under JSR 289. 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 359 home page