org.mobicents.servlet.sip.core.session
Interface SipManager

All Superinterfaces:

org.apache.catalina.Manager

All Known Implementing Classes:

JBossCacheSipManager, SipStandardManager

public interface SipManager
extends org.apache.catalina.Manager

A SipManager manages the Sip Sessions that are associated with a particular Container. Different Manager implementations may support value-added features such as the persistent storage of sip session data, as well as migrating sip sessions for distributable sip applications.

In order for a SipManager implementation to successfully operate with a SipContext implementation that implements reloading, it must obey the following constraints:

• Must implement Lifecycle so that the Context can indicate that a restart is required.
• Must allow a call to stop() to be followed by a call to start() on the same SipManager instance.

Author:

Jean Deruelle

Method Summary

void	dumpSipApplicationSessions()
void	dumpSipSessions()
MobicentsSipApplicationSession	findSipApplicationSession(javax.servlet.http.HttpSession httpSession) Retrieves the sip application session holding the converged http session in parameter
MobicentsSipApplicationSession	getSipApplicationSession(SipApplicationSessionKey key, boolean create) Retrieve a sip application session from its key.
SipFactoryImpl	getSipFactoryImpl()
MobicentsSipSession	getSipSession(SipSessionKey key, boolean create, SipFactoryImpl sipFactoryImpl, MobicentsSipApplicationSession MobicentsSipApplicationSession) Retrieve a sip session from its key.
void	removeAllSessions() Remove the sip sessions and sip application sessions
MobicentsSipApplicationSession	removeSipApplicationSession(SipApplicationSessionKey key) Removes a sip application session from the manager by its key
MobicentsSipSession	removeSipSession(SipSessionKey key) Removes a sip session from the manager by its key
void	setSipFactoryImpl(SipFactoryImpl sipFactoryImpl)

Methods inherited from interface org.apache.catalina.Manager

add, addPropertyChangeListener, backgroundProcess, createEmptySession, createSession, createSession, findSession, findSessions, getActiveSessions, getContainer, getDistributable, getExpiredSessions, getInfo, getMaxActive, getMaxInactiveInterval, getRejectedSessions, getSessionAverageAliveTime, getSessionCounter, getSessionIdLength, getSessionMaxAliveTime, load, remove, removePropertyChangeListener, setContainer, setDistributable, setExpiredSessions, setMaxActive, setMaxInactiveInterval, setRejectedSessions, setSessionAverageAliveTime, setSessionCounter, setSessionIdLength, setSessionMaxAliveTime, unload

Method Detail

removeSipSession

MobicentsSipSession removeSipSession(SipSessionKey key)

Removes a sip session from the manager by its key

Parameters:

key - the identifier for this session

Returns:

the sip session that had just been removed, null otherwise

removeSipApplicationSession

MobicentsSipApplicationSession removeSipApplicationSession(SipApplicationSessionKey key)

Removes a sip application session from the manager by its key

Parameters:

key - the identifier for this session

Returns:

the sip application session that had just been removed, null otherwise

getSipApplicationSession

MobicentsSipApplicationSession getSipApplicationSession(SipApplicationSessionKey key,
                                                        boolean create)

Retrieve a sip application session from its key. If none exists, one can enforce the creation through the create parameter to true.

Parameters:

key - the key identifying the sip application session to retrieve

create - if set to true, if no session has been found one will be created

Returns:

the sip application session matching the key

getSipSession

MobicentsSipSession getSipSession(SipSessionKey key,
                                  boolean create,
                                  SipFactoryImpl sipFactoryImpl,
                                  MobicentsSipApplicationSession MobicentsSipApplicationSession)

Retrieve a sip session from its key. If none exists, one can enforce the creation through the create parameter to true. the sip factory cannot be null if create is set to true.

Parameters:

key - the key identifying the sip session to retrieve

create - if set to true, if no session has been found one will be created

sipFactoryImpl - needed only for sip session creation.

MobicentsSipApplicationSession - to associate the SipSession with if create is set to true, if false it won't be used

Returns:

the sip session matching the key

Throws:

java.lang.IllegalArgumentException - if create is set to true and sip Factory is null

findSipApplicationSession

MobicentsSipApplicationSession findSipApplicationSession(javax.servlet.http.HttpSession httpSession)

Retrieves the sip application session holding the converged http session in parameter

Parameters:

convergedHttpSession - the converged session to look up

Returns:

the sip application session holding a reference to it or null if none references it

removeAllSessions

void removeAllSessions()

Remove the sip sessions and sip application sessions

setSipFactoryImpl

void setSipFactoryImpl(SipFactoryImpl sipFactoryImpl)

getSipFactoryImpl

SipFactoryImpl getSipFactoryImpl()

dumpSipSessions

void dumpSipSessions()

dumpSipApplicationSessions

void dumpSipApplicationSessions()