javax.servlet.sip

Interface SipServletContext

All Superinterfaces:

javax.servlet.ServletContext

public interface SipServletContext
extends javax.servlet.ServletContext

Defines a set of method that a SIP servlet application can use to communicate with SIP servlet container. A SIP Servlet container provides an instance of this interface as the ServletContext object to the Servlet.

Since:

2.0

See Also:

ServletContext

Field Summary

Fields inherited from interface javax.servlet.ServletContext

ORDERED_LIBS, TEMPDIR

Method Summary

Methods

Modifier and Type	Method and Description
javax.servlet.ServletRegistration.Dynamic	addServletPOJO(String servletName, Class<?> servletClass) Adds the servlet POJO with the given name and class type to this servlet context.
javax.servlet.ServletRegistration.Dynamic	addServletPOJO(String servletName, Object servlet) Registers the given servlet instance with this ServletContext under the given servletName.
void	assignWebSocketSipIdentity(javax.servlet.http.HttpServletRequest httpRequest, String sipIdentity) Once a user is authenticated, assign a SIP identity for that HttpServletRequest.
<T> T	createServletPOJO(Class<T> clazz) Instantiates the given Servlet POJO class.
DnsResolver	getDnsResolver() Gets an instance of DnsResolver class.
Flow	getFlow(String flowToken) Returns the flow represented by the flow token.
List<InetAddress>	getOutboundAddresses() An immutable instance of the java.util.List interface containing the InetAddress representation of IP addresses which are used by the container to send out the messages
List<SipURI>	getOutboundInterfaces() An immutable instance of the java.util.List interface containing the SipURI representation of IP addresses which are used by the container to send out the messages
SipApplicationConfiguration	getSipApplicationConfiguration() Returns the SipApplicationConfiguration object that represents the application configuration.
SipFactory	getSipFactory() Gets an instance of application's SipFactory
SipSessionsUtil	getSipSessionsUtil() Gets an instance of SipSessionsUtil for executing session related utility functions like lookup of SipApplicationSession instances.
SipWebSocketContext	getSipWebSocketContext(String flowToken) Retrieve the SipWebSocketContext that the flow token represents.
List<String>	getSupported() An immutable instance of the java.util.List interface containing the String names of SIP extensions supported by the container
List<String>	getSupportedRfcs() An immutable instance of the java.util.List interface containing the RFC numbers represented as Strings of SIP RFCs supported by the container.
TimerService	getTimerService() Gets an instance of TimerService class.

Methods inherited from interface javax.servlet.ServletContext

addFilter, addFilter, addFilter, addListener, addListener, addListener, addServlet, addServlet, addServlet, createFilter, createListener, createServlet, declareRoles, getAttribute, getAttributeNames, getClassLoader, getContext, getContextPath, getDefaultSessionTrackingModes, getEffectiveMajorVersion, getEffectiveMinorVersion, getEffectiveSessionTrackingModes, getFilterRegistration, getFilterRegistrations, getInitParameter, getInitParameterNames, getJspConfigDescriptor, getMajorVersion, getMimeType, getMinorVersion, getNamedDispatcher, getRealPath, getRequestDispatcher, getResource, getResourceAsStream, getResourcePaths, getServerInfo, getServlet, getServletContextName, getServletNames, getServletRegistration, getServletRegistrations, getServlets, getSessionCookieConfig, log, log, log, removeAttribute, setAttribute, setInitParameter, setSessionTrackingModes

Method Detail

getSupported

List<String> getSupported()

An immutable instance of the java.util.List interface containing the String names of SIP extensions supported by the container

Returns:

List of SIP extensions.

getSupportedRfcs

List<String> getSupportedRfcs()

An immutable instance of the java.util.List interface containing the RFC numbers represented as Strings of SIP RFCs supported by the container.

Returns:

List of supported rfcs.

getOutboundInterfaces

List<SipURI> getOutboundInterfaces()

An immutable instance of the java.util.List interface containing the SipURI representation of IP addresses which are used by the container to send out the messages

Returns:

List of outbound interfaces.

getOutboundAddresses

List<InetAddress> getOutboundAddresses()

An immutable instance of the java.util.List interface containing the InetAddress representation of IP addresses which are used by the container to send out the messages

Returns:

List of outbound addresses.

getSipFactory

SipFactory getSipFactory()

Gets an instance of application's SipFactory

Returns:

instance of SipFactory

getSipSessionsUtil

SipSessionsUtil getSipSessionsUtil()

Gets an instance of SipSessionsUtil for executing session related utility functions like lookup of SipApplicationSession instances.

Returns:

instance of SipSessionsUtil

getTimerService

TimerService getTimerService()

Gets an instance of TimerService class.

Returns:

instance of TimerService class.

getDnsResolver

DnsResolver getDnsResolver()

Gets an instance of DnsResolver class.

Returns:

instance of DnsResolver class.

addServletPOJO

javax.servlet.ServletRegistration.Dynamic addServletPOJO(String servletName,
                                                       Object servlet)

Registers the given servlet instance with this ServletContext under the given servletName. The registered servlet may be further configured via the returned ServletRegistration object. If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the name of the given servletClass to it) and returned.

Parameters:

servletName - the name of the servlet

servlet - the servlet POJO instance to register

Returns:

a ServletRegistration object that may be used to further configure the given servlet, or null if this ServletContext already contains a complete ServletRegistration for a servlet with the given servletName or if the same servlet instance has already been registered with this or another ServletContext in the same container

Throws:

{@code - IllegalStateException} if this ServletContext has already been initialized

addServletPOJO

javax.servlet.ServletRegistration.Dynamic addServletPOJO(String servletName,
                                                       Class<?> servletClass)

Adds the servlet POJO with the given name and class type to this servlet context. The registered servlet may be further configured via the returned ServletRegistration object. If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the name of the given servletClass to it) and returned. This method introspects the given class for the annotations except SipServlet In addition, this method supports resource injection if the given clazz represents a Managed Bean. See the SIP servlet specification for the dependency injection requirements.

Parameters:

servletName - the name of the servlet POJO.

servletClass - the class object from which the servlet will be instantiated.

Returns:

a ServletRegistration object that may be used to further configure the registered servlet, or null if this ServletContext already contains a complete ServletRegistration for the given servletName

Throws:

{@code - IllegalStateException} if this ServletContext has already been initialized

createServletPOJO

<T> T createServletPOJO(Class<T> clazz)
                    throws javax.servlet.ServletException

Instantiates the given Servlet POJO class. The returned Servlet instance may be further customized before it is registered with this ServletContext via a call to addServletPOJO(String,Object). The given Servlet POJO class must define a zero argument constructor, which is used to instantiate it. This method introspects the given clazz for the annotations except SipServlet In addition, this method supports resource injection if the given clazz represents a Managed Bean. See the SIP servlet specification for the dependency injection requirements.

Parameters:

clazz - the Servlet POJO class to instantiate

Returns:

the new Servlet POJO instance

Throws:

javax.servlet.ServletException - if the given clazz fails to be instantiated

getSipApplicationConfiguration

SipApplicationConfiguration getSipApplicationConfiguration()

Returns the SipApplicationConfiguration object that represents the application configuration. It may be used by the application to further configure the application.

Returns:

SipApplicationConfiguration instance.

See Also:

SipApplicationConfiguration

getFlow

Flow getFlow(String flowToken)

Returns the flow represented by the flow token. SIP servlets use this method to retrieve the Flow object from the container.

Returns:

Flow represented by the flow token. Null, if there is no usable flow represented by the flow token exist.

Since:

2.0

See Also:

Flow

assignWebSocketSipIdentity

void assignWebSocketSipIdentity(javax.servlet.http.HttpServletRequest httpRequest,
                              String sipIdentity)

Once a user is authenticated, assign a SIP identity for that HttpServletRequest. If a websocket connection is established for this user within the same authentication context, then the SIP messages sent on that websocket connection will be authenticated using the specified SIP identity.

Parameters:

httpRequest - Authenticated HttpServletRequest object.

Throws:

IllegalStateException - if the HttpServletRequest is not authenticated.

IllegalArgumentException - if the sipIdentity is null.

Since:

2.0

getSipWebSocketContext

SipWebSocketContext getSipWebSocketContext(String flowToken)

Retrieve the SipWebSocketContext that the flow token represents.

Parameters:

flowToken - A string representing the Flow of the SIP WebSocket Connection.

Returns:

SipWebSocketContext if the flowToken represents a SIP over WebSocket Connection. Null, otherwise.