SipApplicationSessionImpl (Sip Servlets Implementation 4.0.34 API)

java.lang.Object
- org.mobicents.servlet.sip.core.session.SipApplicationSessionImpl

All Implemented Interfaces:

SipApplicationSession, SipApplicationSessionExt, MobicentsSipApplicationSession
```
public class SipApplicationSessionImpl
extends Object
implements MobicentsSipApplicationSession
```
Implementation of the SipApplicationSession interface. An instance of this sip application session can only be retrieved through the Session Manager (extended class from Tomcat's manager classes implementing the Manager interface) to constrain the creation of sip application session and to make sure that all sessions created can be retrieved only through the session manager

As a SipApplicationSession represents a call (that can contain multiple call legs, in the B2BUA case by example), the call id and the app name are used as a unique key for a given SipApplicationSession instance.

Author:

Jean Deruelle

Nested Class Summary
- Nested classes/interfaces inherited from interface javax.servlet.sip.SipApplicationSession
  SipApplicationSession.Protocol

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`creationTime`
`protected String`	`currentRequestHandler`
`protected long`	`expirationTime`
`protected SipApplicationSessionTimerTask`	`expirationTimerTask`
`protected boolean`	`expired`
`protected MobicentsSipApplicationSessionFacade`	`facade`
`protected Set<String>`	`httpSessions`
`protected boolean`	`invalidateWhenReady`
`protected boolean`	`isValid`
`protected AtomicBoolean`	`isValidInternal`
`protected String`	`jvmRoute`
`protected SipApplicationSessionKey`	`key`
`protected long`	`lastAccessedTime`
`protected boolean`	`orphan`
`protected boolean`	`readyToInvalidate`
`protected Semaphore`	`semaphore`
`protected ConcurrentHashMap<String,ServletTimer>`	`servletTimers`
`protected Map<String,Object>`	`sipApplicationSessionAttributeMap`
`protected long`	`sipApplicationSessionTimeout`
`protected SipContext`	`sipContext` The first sip application for subsequent requests.
`protected Set<SipSessionKey>`	`sipSessions`

Fields inherited from interface org.mobicents.servlet.sip.core.session.MobicentsSipApplicationSession
SIP_APPLICATION_KEY_PARAM_NAME

Constructor Summary

Constructors
Modifier Constructor and Description

protected SipApplicationSessionImpl(SipApplicationSessionKey key, SipContext sipContext)

Constructors
Modifier	Constructor and Description
`protected`	`SipApplicationSessionImpl(SipApplicationSessionKey key, SipContext sipContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`access()` Update the accessed time information for this session.
`void`	`acquire()`
`void`	`activate()` Perform internal processing required to activate this session.
`boolean`	`addHttpSession(javax.servlet.http.HttpSession httpSession)`
`void`	`addServletTimer(ServletTimer servletTimer)` Add a servlet timer to this application session
`boolean`	`addSipSession(MobicentsSipSession mobicentsSipSession)`
`void`	`cancelAllTimers()`
`void`	`encodeURI(URI uri)`
`URL`	`encodeURL(URL url)` Adds a get parameter to the URL like this: http://hostname/link -> http://hostname/link?org.mobicents.servlet.sip.ApplicationSessionKey=0 http://hostname/link?something=1 -> http://hostname/link?something=1&org.mobicents.servlet.sip.ApplicationSessionKey=0
`boolean`	`equals(Object obj)`
`javax.servlet.http.HttpSession`	`findHttpSession(String sessionId)`
`String`	`getApplicationName()`
`Object`	`getAttribute(String name)`
`protected Map<String,Object>`	`getAttributeMap()`
`Iterator<String>`	`getAttributeNames()`
`long`	`getCreationTime()`
`String`	`getCurrentRequestHandler()`
`long`	`getExpirationTime()`
`long`	`getExpirationTimeInternal()`
`SipApplicationSessionTimerTask`	`getExpirationTimerTask()`
`MobicentsSipApplicationSession`	`getFacade()`
`protected Set<javax.servlet.http.HttpSession>`	`getHttpSessions()`
`String`	`getId()`
`boolean`	`getInvalidateWhenReady()`
`String`	`getJvmRoute()`
`SipApplicationSessionKey`	`getKey()`
`long`	`getLastAccessedTime()`
`Semaphore`	`getSemaphore()`
`Object`	`getSession(String id, SipApplicationSession.Protocol protocol)`
`Iterator<?>`	`getSessions()`
`Iterator<?>`	`getSessions(String protocol)`
`long`	`getSipApplicationSessionTimeout()`
`SipContext`	`getSipContext()`
`SipSession`	`getSipSession(String id)`
`Set<MobicentsSipSession>`	`getSipSessions(boolean internal)`
`ServletTimer`	`getTimer(String id)`
`Collection<ServletTimer>`	`getTimers()`
`int`	`hashCode()`
`boolean`	`hasTimerListener()`
`void`	`invalidate()`
`void`	`invalidate(boolean bypassCheck)`
`boolean`	`isExpired()`
`boolean`	`isOrphan()`
`boolean`	`isReadyToInvalidate()`
`boolean`	`isValid()`
`boolean`	`isValidInternal()`
`void`	`notifySipApplicationSessionListeners(SipApplicationSessionEventType sipApplicationSessionEventType)` Notifies the listeners that a lifecycle event occured on that sip application session
`void`	`onSipSessionReadyToInvalidate(MobicentsSipSession mobicentsSipSession)`
`void`	`passivate()` Perform the internal processing required to passivate this session.
`void`	`release()`
`void`	`removeAttribute(String name)`
`void`	`removeAttribute(String name, boolean byPassValidCheck)`
`boolean`	`removeHttpSession(javax.servlet.http.HttpSession httpSession)`
`void`	`removeServletTimer(ServletTimer servletTimer, boolean updateAppSessionReadyToInvalidateState)` Remove a servlet timer from this application session
`SipSessionKey`	`removeSipSession(MobicentsSipSession mobicentsSipSession)`
`void`	`scheduleAsynchronousWork(SipApplicationSessionAsynchronousWork work)`
`void`	`setAttribute(String key, Object attribute)`
`void`	`setCurrentRequestHandler(String currentRequestHandler)`
`void`	`setExpirationTimerTask(SipApplicationSessionTimerTask expirationTimerTask)`
`void`	`setExpired(boolean hasExpired)`
`int`	`setExpires(int deltaMinutes)`
`void`	`setInvalidateWhenReady(boolean invalidateWhenReady)`
`void`	`setJvmRoute(String jvmRoute)`
`void`	`setKey(SipApplicationSessionKey key)`
`protected void`	`setLastAccessedTime(long lastAccessTime)`
`void`	`setOrphan(boolean orphan)`
`protected void`	`setValid(boolean isValid)`
`String`	`toString()`
`void`	`tryToInvalidate()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - sipApplicationSessionAttributeMap
```
protected Map<String,Object> sipApplicationSessionAttributeMap
```
  - sipSessions
```
protected transient Set<SipSessionKey> sipSessions
```
  - httpSessions
```
protected transient Set<String> httpSessions
```
  - key
```
protected SipApplicationSessionKey key
```
  - lastAccessedTime
```
protected long lastAccessedTime
```
  - creationTime
```
protected long creationTime
```
  - expirationTime
```
protected long expirationTime
```
  - expired
```
protected boolean expired
```
  - expirationTimerTask
```
protected transient SipApplicationSessionTimerTask expirationTimerTask
```
  - servletTimers
```
protected transient ConcurrentHashMap<String,ServletTimer> servletTimers
```
  - isValidInternal
```
protected transient AtomicBoolean isValidInternal
```
  - isValid
```
protected transient boolean isValid
```
  - invalidateWhenReady
```
protected boolean invalidateWhenReady
```
  - readyToInvalidate
```
protected boolean readyToInvalidate
```
  - sipContext
```
protected transient SipContext sipContext
```
    The first sip application for subsequent requests.
  - currentRequestHandler
```
protected String currentRequestHandler
```
  - semaphore
```
protected transient Semaphore semaphore
```
  - facade
```
protected transient MobicentsSipApplicationSessionFacade facade
```
  - sipApplicationSessionTimeout
```
protected long sipApplicationSessionTimeout
```
  - jvmRoute
```
protected String jvmRoute
```
  - orphan
```
protected boolean orphan
```
- Constructor Detail
  - SipApplicationSessionImpl
```
protected SipApplicationSessionImpl(SipApplicationSessionKey key,
                         SipContext sipContext)
```
- Method Detail
  - getAttributeMap
```
protected Map<String,Object> getAttributeMap()
```
  - notifySipApplicationSessionListeners
```
public void notifySipApplicationSessionListeners(SipApplicationSessionEventType sipApplicationSessionEventType)
```
    Notifies the listeners that a lifecycle event occured on that sip application session
    
    Specified by:
    
    notifySipApplicationSessionListeners in interface MobicentsSipApplicationSession
    
    Parameters:
    sipApplicationSessionEventType - the type of event that happened
  - addSipSession
```
public boolean addSipSession(MobicentsSipSession mobicentsSipSession)
```
    Specified by:
    
    addSipSession in interface MobicentsSipApplicationSession
  - removeSipSession
```
public SipSessionKey removeSipSession(MobicentsSipSession mobicentsSipSession)
```
  - addHttpSession
```
public boolean addHttpSession(javax.servlet.http.HttpSession httpSession)
```
    Specified by:
    
    addHttpSession in interface MobicentsSipApplicationSession
  - removeHttpSession
```
public boolean removeHttpSession(javax.servlet.http.HttpSession httpSession)
```
    Specified by:
    
    removeHttpSession in interface MobicentsSipApplicationSession
  - findHttpSession
```
public javax.servlet.http.HttpSession findHttpSession(String sessionId)
```
    Specified by:
    
    findHttpSession in interface MobicentsSipApplicationSession
  - encodeURI
```
public void encodeURI(URI uri)
```
    Specified by:
    
    encodeURI in interface SipApplicationSession
  - encodeURL
```
public URL encodeURL(URL url)
```
    Adds a get parameter to the URL like this: http://hostname/link -> http://hostname/link?org.mobicents.servlet.sip.ApplicationSessionKey=0 http://hostname/link?something=1 -> http://hostname/link?something=1&org.mobicents.servlet.sip.ApplicationSessionKey=0
    
    Specified by:
    
    encodeURL in interface SipApplicationSession
  - getAttribute
```
public Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface SipApplicationSession
  - getAttributeNames
```
public Iterator<String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface SipApplicationSession
  - getCreationTime
```
public long getCreationTime()
```
    Specified by:
    
    getCreationTime in interface SipApplicationSession
  - getExpirationTime
```
public long getExpirationTime()
```
    Specified by:
    
    getExpirationTime in interface SipApplicationSession
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface SipApplicationSession
  - getLastAccessedTime
```
public long getLastAccessedTime()
```
    Specified by:
    
    getLastAccessedTime in interface SipApplicationSession
  - setLastAccessedTime
```
protected void setLastAccessedTime(long lastAccessTime)
```
  - access
```
public void access()
```
    Update the accessed time information for this session. This method should be called by the context when a request comes in for a particular session, even if the application does not reference it.
    
    Specified by:
    
    access in interface MobicentsSipApplicationSession
  - getSessions
```
public Iterator<?> getSessions()
```
    Specified by:
    
    getSessions in interface SipApplicationSession
  - getSessions
```
public Iterator<?> getSessions(String protocol)
```
    Specified by:
    
    getSessions in interface SipApplicationSession
  - getSipSessions
```
public Set<MobicentsSipSession> getSipSessions(boolean internal)
```
    Specified by:
    
    getSipSessions in interface MobicentsSipApplicationSession
  - getHttpSessions
```
protected Set<javax.servlet.http.HttpSession> getHttpSessions()
```
  - getSipSession
```
public SipSession getSipSession(String id)
```
    Specified by:
    
    getSipSession in interface SipApplicationSession
  - getTimers
```
public Collection<ServletTimer> getTimers()
```
    Specified by:
    
    getTimers in interface SipApplicationSession
  - addServletTimer
```
public void addServletTimer(ServletTimer servletTimer)
```
    Add a servlet timer to this application session
    
    Specified by:
    
    addServletTimer in interface MobicentsSipApplicationSession
    
    Parameters:
    servletTimer - the servlet timer to add
  - removeServletTimer
```
public void removeServletTimer(ServletTimer servletTimer,
                      boolean updateAppSessionReadyToInvalidateState)
```
    Remove a servlet timer from this application session
    
    Specified by:
    
    removeServletTimer in interface MobicentsSipApplicationSession
    
    Parameters:
    servletTimer - the servlet timer to remove
  - invalidate
```
public void invalidate()
```
    Specified by:
    
    invalidate in interface SipApplicationSession
  - invalidate
```
public void invalidate(boolean bypassCheck)
```
    Specified by:
    
    invalidate in interface MobicentsSipApplicationSession
  - cancelAllTimers
```
public void cancelAllTimers()
```
  - isValid
```
public boolean isValid()
```
    Specified by:
    
    isValid in interface SipApplicationSession
  - isValidInternal
```
public boolean isValidInternal()
```
    Specified by:
    
    isValidInternal in interface MobicentsSipApplicationSession
  - setValid
```
protected void setValid(boolean isValid)
```
    Parameters:
    isValid - the isValid to set
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface SipApplicationSession
  - removeAttribute
```
public void removeAttribute(String name,
                   boolean byPassValidCheck)
```
  - setAttribute
```
public void setAttribute(String key,
                Object attribute)
```
    Specified by:
    
    setAttribute in interface SipApplicationSession
  - setExpires
```
public int setExpires(int deltaMinutes)
```
    Specified by:
    
    setExpires in interface SipApplicationSession
  - hasTimerListener
```
public boolean hasTimerListener()
```
    Specified by:
    
    hasTimerListener in interface MobicentsSipApplicationSession
  - getSipContext
```
public SipContext getSipContext()
```
    Specified by:
    
    getSipContext in interface MobicentsSipApplicationSession
  - getKey
```
public SipApplicationSessionKey getKey()
```
    Specified by:
    
    getKey in interface MobicentsSipApplicationSession
    
    Returns:
    the key
  - setKey
```
public void setKey(SipApplicationSessionKey key)
```
    Parameters:
    key - the key to set
  - getApplicationName
```
public String getApplicationName()
```
    Specified by:
    
    getApplicationName in interface SipApplicationSession
  - getTimer
```
public ServletTimer getTimer(String id)
```
    Specified by:
    
    getTimer in interface SipApplicationSession
  - passivate
```
public void passivate()
```
    Perform the internal processing required to passivate this session.
  - activate
```
public void activate()
```
    Perform internal processing required to activate this session.
  - getInvalidateWhenReady
```
public boolean getInvalidateWhenReady()
```
    Specified by:
    
    getInvalidateWhenReady in interface SipApplicationSession
  - getSession
```
public Object getSession(String id,
                SipApplicationSession.Protocol protocol)
```
    Specified by:
    
    getSession in interface SipApplicationSession
  - isReadyToInvalidate
```
public boolean isReadyToInvalidate()
```
    Specified by:
    
    isReadyToInvalidate in interface SipApplicationSession
  - setInvalidateWhenReady
```
public void setInvalidateWhenReady(boolean invalidateWhenReady)
```
    Specified by:
    
    setInvalidateWhenReady in interface SipApplicationSession
  - onSipSessionReadyToInvalidate
```
public void onSipSessionReadyToInvalidate(MobicentsSipSession mobicentsSipSession)
```
    Specified by:
    
    onSipSessionReadyToInvalidate in interface MobicentsSipApplicationSession
  - tryToInvalidate
```
public void tryToInvalidate()
```
    Specified by:
    
    tryToInvalidate in interface MobicentsSipApplicationSession
  - isExpired
```
public boolean isExpired()
```
    Specified by:
    
    isExpired in interface MobicentsSipApplicationSession
    
    Returns:
    the expired
  - setCurrentRequestHandler
```
public void setCurrentRequestHandler(String currentRequestHandler)
```
    Specified by:
    
    setCurrentRequestHandler in interface MobicentsSipApplicationSession
    
    Parameters:
    currentServletHandler - the currentServletHandler to set
  - getCurrentRequestHandler
```
public String getCurrentRequestHandler()
```
    Specified by:
    
    getCurrentRequestHandler in interface MobicentsSipApplicationSession
    
    Returns:
    the currentServletHandler
  - getSemaphore
```
public Semaphore getSemaphore()
```
    Returns:
    the semaphore
  - getFacade
```
public MobicentsSipApplicationSession getFacade()
```
    Specified by:
    
    getFacade in interface MobicentsSipApplicationSession
  - getJvmRoute
```
public String getJvmRoute()
```
    Specified by:
    
    getJvmRoute in interface MobicentsSipApplicationSession
  - setJvmRoute
```
public void setJvmRoute(String jvmRoute)
```
    Specified by:
    
    setJvmRoute in interface MobicentsSipApplicationSession
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setExpirationTimerTask
```
public void setExpirationTimerTask(SipApplicationSessionTimerTask expirationTimerTask)
```
    Specified by:
    
    setExpirationTimerTask in interface MobicentsSipApplicationSession
  - getExpirationTimerTask
```
public SipApplicationSessionTimerTask getExpirationTimerTask()
```
    Specified by:
    
    getExpirationTimerTask in interface MobicentsSipApplicationSession
  - getSipApplicationSessionTimeout
```
public long getSipApplicationSessionTimeout()
```
    Specified by:
    
    getSipApplicationSessionTimeout in interface MobicentsSipApplicationSession
    
    Returns:
    the sipApplicationSessionTimeout
  - setExpired
```
public void setExpired(boolean hasExpired)
```
    Specified by:
    
    setExpired in interface MobicentsSipApplicationSession
  - getExpirationTimeInternal
```
public long getExpirationTimeInternal()
```
    Specified by:
    
    getExpirationTimeInternal in interface MobicentsSipApplicationSession
  - scheduleAsynchronousWork
```
public void scheduleAsynchronousWork(SipApplicationSessionAsynchronousWork work)
```
    Specified by:
    
    scheduleAsynchronousWork in interface SipApplicationSessionExt
  - acquire
```
public void acquire()
```
    Specified by:
    
    acquire in interface MobicentsSipApplicationSession
  - release
```
public void release()
```
    Specified by:
    
    release in interface MobicentsSipApplicationSession
  - isOrphan
```
public boolean isOrphan()
```
    Specified by:
    
    isOrphan in interface MobicentsSipApplicationSession
  - setOrphan
```
public void setOrphan(boolean orphan)
```
    Specified by:
    
    setOrphan in interface MobicentsSipApplicationSession

Class SipApplicationSessionImpl

Nested Class Summary

Nested classes/interfaces inherited from interface javax.servlet.sip.SipApplicationSession

Field Summary

Fields inherited from interface org.mobicents.servlet.sip.core.session.MobicentsSipApplicationSession

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sipApplicationSessionAttributeMap

sipSessions

httpSessions

key

lastAccessedTime

creationTime

expirationTime

expired

expirationTimerTask

servletTimers

isValidInternal

isValid

invalidateWhenReady

readyToInvalidate

sipContext

currentRequestHandler

semaphore

facade

sipApplicationSessionTimeout

jvmRoute

orphan

Constructor Detail

SipApplicationSessionImpl

Method Detail

getAttributeMap

notifySipApplicationSessionListeners

addSipSession

removeSipSession

addHttpSession

removeHttpSession

findHttpSession

encodeURI

encodeURL

getAttribute

getAttributeNames

getCreationTime

getExpirationTime

getId

getLastAccessedTime

setLastAccessedTime

access

getSessions

getSessions

getSipSessions

getHttpSessions

getSipSession

getTimers

addServletTimer

removeServletTimer

invalidate

invalidate

cancelAllTimers

isValid

isValidInternal

setValid

removeAttribute

removeAttribute

setAttribute

setExpires

hasTimerListener

getSipContext

getKey

setKey

getApplicationName

getTimer

passivate

activate

getInvalidateWhenReady

getSession

isReadyToInvalidate

setInvalidateWhenReady