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

All Superinterfaces:

org.apache.catalina.Manager, SipManager

public interface DistributableSipManager
extends SipManager

Interface that should be implemented by all manager allowing applications to work in a distributed environment.

Author:

Jean Deruelle

Method Summary

MobicentsSipApplicationSession	getSipApplicationSession(SipApplicationSessionKey key, boolean create, boolean localOnly) Retrieve a sip application session from its key.
MobicentsSipSession	getSipSession(SipSessionKey key, boolean create, SipFactoryImpl sipFactoryImpl, MobicentsSipApplicationSession MobicentsSipApplicationSession, boolean localOnly) Retrieve a sip session from its key.

Methods inherited from interface org.mobicents.servlet.sip.core.session.SipManager

dumpSipApplicationSessions, dumpSipSessions, findSipApplicationSession, getActiveSipApplicationSessions, getActiveSipSessions, getAllSipApplicationSessions, getAllSipSessions, getExpiredSipApplicationSessions, getExpiredSipSessions, getMaxActiveSipApplicationSessions, getMaxActiveSipSessions, getNumberOfSipApplicationSessionCreationPerSecond, getNumberOfSipSessionCreationPerSecond, getRejectedSipApplicationSessions, getRejectedSipSessions, getSipApplicationSession, getSipApplicationSessionAverageAliveTime, getSipApplicationSessionCounter, getSipApplicationSessionMaxAliveTime, getSipFactoryImpl, getSipSession, getSipSessionAverageAliveTime, getSipSessionCounter, getSipSessionMaxAliveTime, removeAllSessions, removeSipApplicationSession, removeSipSession, setExpiredSipApplicationSessions, setExpiredSipSessions, setMaxActiveSipApplicationSessions, setMaxActiveSipSessions, setRejectedSipApplicationSessions, setRejectedSipSessions, setSipApplicationSessionAverageAliveTime, setSipApplicationSessionCounter, setSipApplicationSessionMaxAliveTime, setSipFactoryImpl, setSipSessionAverageAliveTime, setSipSessionCounter, setSipSessionMaxAliveTime, updateStats

Methods inherited from interface org.apache.catalina.Manager

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

Method Detail

getSipApplicationSession

MobicentsSipApplicationSession getSipApplicationSession(SipApplicationSessionKey key,
                                                        boolean create,
                                                        boolean localOnly)

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

localOnly - if true check only locally and not in the cache, if false check in the cache as well

Returns:

the sip application session matching the key

getSipSession

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

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

localOnly - if true check only locally and not in the cache, if false check in the cache as well

Returns:

the sip session matching the key

Throws:

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