org.mobicents.servlet.sip.startup
Interface SipContext

All Superinterfaces:

org.apache.catalina.Container, org.apache.catalina.Context

public interface SipContext
extends org.apache.catalina.Context

A SipContext is a Container that represents a sip/converged servlet context, and therefore an individual sip/converged application, in the Catalina servlet engine.

This extends Tomcat Context interface to allow sip capabilities to be used on Tomcat deployed applictions.

Author:

Jean Deruelle

Field Summary

static java.lang.String	APPLICATION_SIP_XML
static java.lang.String	LOAD_BALANCER

Fields inherited from interface org.apache.catalina.Context

RELOAD_EVENT

Fields inherited from interface org.apache.catalina.Container

ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT

Method Summary

void	addChild(SipServletImpl child)
void	addConstraint(org.apache.catalina.deploy.SecurityConstraint securityConstraint)
void	addSipApplicationListener(java.lang.String listener)
void	addSipServletMapping(SipServletMapping sipServletMapping)
void	enterSipApp(MobicentsSipApplicationSession sipApplicationSession, MobicentsSipSession sipSession, boolean checkIsManagedThread) notify the application that we are going to access it with the sipapplicationsession and sip session in parameter and tells whether or not to check if we are in a managed thread to check if we should lock the session or not
boolean	enterSipAppHa(boolean startCacheActivity)
void	exitSipApp(MobicentsSipApplicationSession sipApplicationSession, MobicentsSipSession sipSession) notify the application that we are going to exit it with the sipapplicationsession and sip session in parameter
void	exitSipAppHa(SipServletRequestImpl request, SipServletResponseImpl response, boolean batchStarted)
org.apache.catalina.Container	findChildrenByClassName(java.lang.String className)
org.apache.catalina.Container	findChildrenByName(java.lang.String name)
java.lang.String[]	findSipApplicationListeners()
java.util.List<SipServletMapping>	findSipServletMappings()
SipServletMapping	findSipServletMappings(SipServletRequest sipServletRequest)
org.apache.AnnotationProcessor	getAnnotationProcessor()
java.lang.String	getApplicationName()
java.lang.String	getApplicationNameHashed()
java.lang.String	getBasePath()
java.util.Map<java.lang.String,org.apache.catalina.Container>	getChildrenMap()
ConcurrencyControlMode	getConcurrencyControlMode()
java.lang.String	getDescription()
java.lang.String	getEngineName()
java.lang.String	getLargeIcon()
SipListenersHolder	getListeners()
java.lang.String	getMainServlet()
int	getProxyTimeout()
ProxyTimerService	getProxyTimerService()
java.lang.String	getServletHandler()
SipApplicationDispatcher	getSipApplicationDispatcher()
java.lang.reflect.Method	getSipApplicationKeyMethod()
int	getSipApplicationSessionTimeout()
SipApplicationSessionTimerService	getSipApplicationSessionTimerService()
SipFactoryFacade	getSipFactoryFacade()
SipLoginConfig	getSipLoginConfig()
SipManager	getSipManager()
SipRubyController	getSipRubyController()
SipSessionsUtilImpl	getSipSessionsUtil()
java.lang.String	getSmallIcon()
TimerService	getTimerService()
boolean	hasDistributableManager()
boolean	isMainServlet()
boolean	notifySipContextListeners(SipContextEvent event)
void	removeChild(SipServletImpl child)
void	removeConstraint(org.apache.catalina.deploy.SecurityConstraint securityConstraint)
void	removeSipApplicationListener(java.lang.String listener)
void	removeSipServletMapping(SipServletMapping sipServletMapping)
void	setApplicationName(java.lang.String applicationName)
void	setConcurrencyControlMode(ConcurrencyControlMode mode)
void	setDescription(java.lang.String description)
void	setLargeIcon(java.lang.String largeIcon)
void	setListeners(SipListenersHolder listeners)
void	setMainServlet(java.lang.String mainServlet)
void	setProxyTimeout(int proxyTimeout)
void	setServletHandler(java.lang.String servletHandler)
void	setSipApplicationKeyMethod(java.lang.reflect.Method sipApplicationKeyMethod)
void	setSipApplicationSessionTimeout(int proxyTimeout)
void	setSipLoginConfig(SipLoginConfig config)
void	setSipRubyController(SipRubyController rubyController)
void	setSmallIcon(java.lang.String smallIcon)

Methods inherited from interface org.apache.catalina.Context

addApplicationListener, addApplicationParameter, addErrorPage, addFilterDef, addFilterMap, addInstanceListener, addJspMapping, addLocaleEncodingMappingParameter, addMimeMapping, addParameter, addRoleMapping, addSecurityRole, addServletMapping, addTaglib, addWatchedResource, addWelcomeFile, addWrapperLifecycle, addWrapperListener, createWrapper, findApplicationListeners, findApplicationParameters, findConstraints, findErrorPage, findErrorPage, findErrorPages, findFilterDef, findFilterDefs, findFilterMaps, findInstanceListeners, findMimeMapping, findMimeMappings, findParameter, findParameters, findRoleMapping, findSecurityRole, findSecurityRoles, findServletMapping, findServletMappings, findStatusPage, findStatusPages, findTaglib, findTaglibs, findWatchedResources, findWelcomeFile, findWelcomeFiles, findWrapperLifecycles, findWrapperListeners, getAltDDName, getApplicationEventListeners, getApplicationLifecycleListeners, getAvailable, getCharsetMapper, getConfigFile, getConfigured, getCookies, getCrossContext, getDisplayName, getDistributable, getDocBase, getEncodedPath, getIgnoreAnnotations, getLoginConfig, getMapper, getNamingResources, getOverride, getPath, getPrivileged, getPublicId, getReloadable, getServletContext, getSessionCookieDomain, getSessionCookieName, getSessionCookiePath, getSessionTimeout, getSwallowOutput, getTldNamespaceAware, getTldValidation, getUseHttpOnly, getWrapperClass, getXmlNamespaceAware, getXmlValidation, isDisableURLRewriting, reload, removeApplicationListener, removeApplicationParameter, removeErrorPage, removeFilterDef, removeFilterMap, removeInstanceListener, removeMimeMapping, removeParameter, removeRoleMapping, removeSecurityRole, removeServletMapping, removeTaglib, removeWatchedResource, removeWelcomeFile, removeWrapperLifecycle, removeWrapperListener, setAltDDName, setApplicationEventListeners, setApplicationLifecycleListeners, setAvailable, setCharsetMapper, setConfigFile, setConfigured, setCookies, setCrossContext, setDisableURLRewriting, setDisplayName, setDistributable, setDocBase, setIgnoreAnnotations, setLoginConfig, setNamingResources, setOverride, setPath, setPrivileged, setPublicId, setReloadable, setSessionCookieDomain, setSessionCookieName, setSessionCookiePath, setSessionTimeout, setSwallowOutput, setTldNamespaceAware, setTldValidation, setUseHttpOnly, setWrapperClass, setXmlNamespaceAware, setXmlValidation

Methods inherited from interface org.apache.catalina.Container

addChild, addContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, getAccessLog, getBackgroundProcessorDelay, getCluster, getInfo, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, invoke, logAccess, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setName, setParent, setParentClassLoader, setRealm, setResources

Field Detail

APPLICATION_SIP_XML

static final java.lang.String APPLICATION_SIP_XML

See Also:

Constant Field Values

LOAD_BALANCER

static final java.lang.String LOAD_BALANCER

See Also:

Constant Field Values

Method Detail

getApplicationName

java.lang.String getApplicationName()

getApplicationNameHashed

java.lang.String getApplicationNameHashed()

hasDistributableManager

boolean hasDistributableManager()

setApplicationName

void setApplicationName(java.lang.String applicationName)

getDescription

java.lang.String getDescription()

setDescription

void setDescription(java.lang.String description)

getLargeIcon

java.lang.String getLargeIcon()

setLargeIcon

void setLargeIcon(java.lang.String largeIcon)

getListeners

SipListenersHolder getListeners()

setListeners

void setListeners(SipListenersHolder listeners)

isMainServlet

boolean isMainServlet()

getMainServlet

java.lang.String getMainServlet()

setMainServlet

void setMainServlet(java.lang.String mainServlet)

setServletHandler

void setServletHandler(java.lang.String servletHandler)

getServletHandler

java.lang.String getServletHandler()

getProxyTimeout

int getProxyTimeout()

setProxyTimeout

void setProxyTimeout(int proxyTimeout)

getSipApplicationSessionTimeout

int getSipApplicationSessionTimeout()

setSipApplicationSessionTimeout

void setSipApplicationSessionTimeout(int proxyTimeout)

addConstraint

void addConstraint(org.apache.catalina.deploy.SecurityConstraint securityConstraint)

Specified by:

addConstraint in interface org.apache.catalina.Context

removeConstraint

void removeConstraint(org.apache.catalina.deploy.SecurityConstraint securityConstraint)

Specified by:

removeConstraint in interface org.apache.catalina.Context

getSmallIcon

java.lang.String getSmallIcon()

setSmallIcon

void setSmallIcon(java.lang.String smallIcon)

addSipApplicationListener

void addSipApplicationListener(java.lang.String listener)

removeSipApplicationListener

void removeSipApplicationListener(java.lang.String listener)

findSipApplicationListeners

java.lang.String[] findSipApplicationListeners()

getSipApplicationKeyMethod

java.lang.reflect.Method getSipApplicationKeyMethod()

setSipApplicationKeyMethod

void setSipApplicationKeyMethod(java.lang.reflect.Method sipApplicationKeyMethod)

setSipLoginConfig

void setSipLoginConfig(SipLoginConfig config)

getSipLoginConfig

SipLoginConfig getSipLoginConfig()

addSipServletMapping

void addSipServletMapping(SipServletMapping sipServletMapping)

removeSipServletMapping

void removeSipServletMapping(SipServletMapping sipServletMapping)

findSipServletMappings

java.util.List<SipServletMapping> findSipServletMappings()

findSipServletMappings

SipServletMapping findSipServletMappings(SipServletRequest sipServletRequest)

getChildrenMap

java.util.Map<java.lang.String,org.apache.catalina.Container> getChildrenMap()

findChildrenByName

org.apache.catalina.Container findChildrenByName(java.lang.String name)

findChildrenByClassName

org.apache.catalina.Container findChildrenByClassName(java.lang.String className)

addChild

void addChild(SipServletImpl child)

removeChild

void removeChild(SipServletImpl child)

getSipManager

SipManager getSipManager()

getSipApplicationDispatcher

SipApplicationDispatcher getSipApplicationDispatcher()

getAnnotationProcessor

org.apache.AnnotationProcessor getAnnotationProcessor()

getEngineName

java.lang.String getEngineName()

getBasePath

java.lang.String getBasePath()

notifySipContextListeners

boolean notifySipContextListeners(SipContextEvent event)

enterSipApp

void enterSipApp(MobicentsSipApplicationSession sipApplicationSession,
                 MobicentsSipSession sipSession,
                 boolean checkIsManagedThread)

notify the application that we are going to access it with the sipapplicationsession and sip session in parameter and tells whether or not to check if we are in a managed thread to check if we should lock the session or not

Parameters:

sipApplicationSession - the sip application session that is accessing the application, it can be null

sipSession - the sip session that is accessing the application, it can be null

checkIsManagedThread - need to check if the access is done within a managed Thread or not to lock or not the session depending on the concurrency control

exitSipApp

void exitSipApp(MobicentsSipApplicationSession sipApplicationSession,
                MobicentsSipSession sipSession)

notify the application that we are going to exit it with the sipapplicationsession and sip session in parameter

Parameters:

sipApplicationSession - the sip application session that is exiting the application, it can be null

sipSession - the sip session that is exiting the application, it can be null

enterSipAppHa

boolean enterSipAppHa(boolean startCacheActivity)

exitSipAppHa

void exitSipAppHa(SipServletRequestImpl request,
                  SipServletResponseImpl response,
                  boolean batchStarted)

getSipFactoryFacade

SipFactoryFacade getSipFactoryFacade()

getSipSessionsUtil

SipSessionsUtilImpl getSipSessionsUtil()

getTimerService

TimerService getTimerService()

getProxyTimerService

ProxyTimerService getProxyTimerService()

getSipApplicationSessionTimerService

SipApplicationSessionTimerService getSipApplicationSessionTimerService()

setConcurrencyControlMode

void setConcurrencyControlMode(ConcurrencyControlMode mode)

getConcurrencyControlMode

ConcurrencyControlMode getConcurrencyControlMode()

setSipRubyController

void setSipRubyController(SipRubyController rubyController)

getSipRubyController

SipRubyController getSipRubyController()