org.mobicents.servlet.sip.message

Class MobicentsSipApplicationSessionFacade

java.lang.Object

org.mobicents.servlet.sip.message.MobicentsSipApplicationSessionFacade

All Implemented Interfaces:

Externalizable, Serializable, SipApplicationSession, SipApplicationSessionExt, MobicentsSipApplicationSession

public class MobicentsSipApplicationSessionFacade
extends Object
implements MobicentsSipApplicationSession, Externalizable

The purpose of this class is to be a facade to the real sip application session as well as a serializable session class that can be put as a session attribute in other sessions or even its own session. Basically instead of replicating the whole attribute map, we will replicate the id, then on the remote side we will read the ID and look it up in the remote session manager.

Author:

vralev, jean.deruelle@gmail.com

See Also:

Serialized Form

Nested Class Summary

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

SipApplicationSession.Protocol

Field Summary

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

SIP_APPLICATION_KEY_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
MobicentsSipApplicationSessionFacade()
MobicentsSipApplicationSessionFacade(MobicentsSipApplicationSession sipApplicationSession)

Method Summary

Methods

Modifier and Type	Method and Description
void	access()
void	acquire()
boolean	addHttpSession(javax.servlet.http.HttpSession httpSession)
void	addServletTimer(ServletTimer servletTimer)
boolean	addSipSession(MobicentsSipSession mobicentsSipSession)
void	encodeURI(URI uri)
URL	encodeURL(URL url)
boolean	equals(Object obj)
javax.servlet.http.HttpSession	findHttpSession(String id)
String	getApplicationName()
Object	getAttribute(String name)
Iterator<String>	getAttributeNames()
long	getCreationTime()
String	getCurrentRequestHandler()
long	getExpirationTime()
long	getExpirationTimeInternal()
SipApplicationSessionTimerTask	getExpirationTimerTask()
MobicentsSipApplicationSession	getFacade()
String	getId()
boolean	getInvalidateWhenReady()
String	getJvmRoute()
MobicentsSipApplicationSessionKey	getKey()
long	getLastAccessedTime()
MobicentsSipApplicationSession	getMobicentstSipApplicationSession()
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 expiration)
void	onSipSessionReadyToInvalidate(MobicentsSipSession mobicentsSipSession)
void	readExternal(ObjectInput arg0)
void	release()
void	removeAttribute(String name)
boolean	removeHttpSession(javax.servlet.http.HttpSession httpSession)
void	removeServletTimer(ServletTimer servletTimer, boolean updateAppSessionReadyToInvalidateState)
void	scheduleAsynchronousWork(SipApplicationSessionAsynchronousWork work)
void	setAttribute(String name, 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	setOrphan(boolean orphan)
String	toString()
void	tryToInvalidate()
void	writeExternal(ObjectOutput arg0)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MobicentsSipApplicationSessionFacade

public MobicentsSipApplicationSessionFacade()

MobicentsSipApplicationSessionFacade

public MobicentsSipApplicationSessionFacade(MobicentsSipApplicationSession sipApplicationSession)

Method Detail

getMobicentstSipApplicationSession

public MobicentsSipApplicationSession getMobicentstSipApplicationSession()

access

public void access()

Specified by:

access in interface MobicentsSipApplicationSession

addHttpSession

public boolean addHttpSession(javax.servlet.http.HttpSession httpSession)

Specified by:

addHttpSession in interface MobicentsSipApplicationSession

addServletTimer

public void addServletTimer(ServletTimer servletTimer)

Specified by:

addServletTimer in interface MobicentsSipApplicationSession

addSipSession

public boolean addSipSession(MobicentsSipSession mobicentsSipSession)

Specified by:

addSipSession in interface MobicentsSipApplicationSession

findHttpSession

public javax.servlet.http.HttpSession findHttpSession(String id)

Specified by:

findHttpSession in interface MobicentsSipApplicationSession

getCurrentRequestHandler

public String getCurrentRequestHandler()

Specified by:

getCurrentRequestHandler in interface MobicentsSipApplicationSession

getKey

public MobicentsSipApplicationSessionKey getKey()

Specified by:

getKey in interface MobicentsSipApplicationSession

getSipContext

public SipContext getSipContext()

Specified by:

getSipContext in interface MobicentsSipApplicationSession

hasTimerListener

public boolean hasTimerListener()

Specified by:

hasTimerListener in interface MobicentsSipApplicationSession

isExpired

public boolean isExpired()

Specified by:

isExpired in interface MobicentsSipApplicationSession

notifySipApplicationSessionListeners

public void notifySipApplicationSessionListeners(SipApplicationSessionEventType expiration)

Specified by:

notifySipApplicationSessionListeners in interface MobicentsSipApplicationSession

onSipSessionReadyToInvalidate

public void onSipSessionReadyToInvalidate(MobicentsSipSession mobicentsSipSession)

Specified by:

onSipSessionReadyToInvalidate in interface MobicentsSipApplicationSession

removeHttpSession

public boolean removeHttpSession(javax.servlet.http.HttpSession httpSession)

Specified by:

removeHttpSession in interface MobicentsSipApplicationSession

removeServletTimer

public void removeServletTimer(ServletTimer servletTimer,
                      boolean updateAppSessionReadyToInvalidateState)

Specified by:

removeServletTimer in interface MobicentsSipApplicationSession

setCurrentRequestHandler

public void setCurrentRequestHandler(String currentRequestHandler)

Specified by:

setCurrentRequestHandler in interface MobicentsSipApplicationSession

tryToInvalidate

public void tryToInvalidate()

Specified by:

tryToInvalidate in interface MobicentsSipApplicationSession

encodeURI

public void encodeURI(URI uri)

Specified by:

encodeURI in interface SipApplicationSession

encodeURL

public URL encodeURL(URL url)

Specified by:

encodeURL in interface SipApplicationSession

getApplicationName

public String getApplicationName()

Specified by:

getApplicationName 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

getInvalidateWhenReady

public boolean getInvalidateWhenReady()

Specified by:

getInvalidateWhenReady in interface SipApplicationSession

getLastAccessedTime

public long getLastAccessedTime()

Specified by:

getLastAccessedTime in interface SipApplicationSession

getSession

public Object getSession(String id,
                SipApplicationSession.Protocol protocol)

Specified by:

getSession in interface SipApplicationSession

getSessions

public Iterator<?> getSessions()

Specified by:

getSessions in interface SipApplicationSession

getSessions

public Iterator<?> getSessions(String protocol)

Specified by:

getSessions in interface SipApplicationSession

getSipSession

public SipSession getSipSession(String id)

Specified by:

getSipSession in interface SipApplicationSession

getTimer

public ServletTimer getTimer(String id)

Specified by:

getTimer in interface SipApplicationSession

getTimers

public Collection<ServletTimer> getTimers()

Specified by:

getTimers in interface SipApplicationSession

invalidate

public void invalidate()

Specified by:

invalidate in interface SipApplicationSession

isReadyToInvalidate

public boolean isReadyToInvalidate()

Specified by:

isReadyToInvalidate in interface SipApplicationSession

isValid

public boolean isValid()

Specified by:

isValid in interface SipApplicationSession

isValidInternal

public boolean isValidInternal()

Specified by:

isValidInternal in interface MobicentsSipApplicationSession

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface SipApplicationSession

setAttribute

public void setAttribute(String name,
                Object attribute)

Specified by:

setAttribute in interface SipApplicationSession

setExpires

public int setExpires(int deltaMinutes)

Specified by:

setExpires in interface SipApplicationSession

setInvalidateWhenReady

public void setInvalidateWhenReady(boolean invalidateWhenReady)

Specified by:

setInvalidateWhenReady in interface SipApplicationSession

getFacade

public MobicentsSipApplicationSession getFacade()

Specified by:

getFacade in interface MobicentsSipApplicationSession

readExternal

public void readExternal(ObjectInput arg0)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput arg0)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

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

setExpired

public void setExpired(boolean hasExpired)

Specified by:

setExpired in interface MobicentsSipApplicationSession

getExpirationTimeInternal

public long getExpirationTimeInternal()

Specified by:

getExpirationTimeInternal in interface MobicentsSipApplicationSession

getSipSessions

public Set<MobicentsSipSession> getSipSessions(boolean internal)

Specified by:

getSipSessions in interface MobicentsSipApplicationSession

getExpirationTimerTask

public SipApplicationSessionTimerTask getExpirationTimerTask()

Specified by:

getExpirationTimerTask in interface MobicentsSipApplicationSession

scheduleAsynchronousWork

public void scheduleAsynchronousWork(SipApplicationSessionAsynchronousWork work)

Specified by:

scheduleAsynchronousWork in interface SipApplicationSessionExt

getSipApplicationSessionTimeout

public long getSipApplicationSessionTimeout()

Specified by:

getSipApplicationSessionTimeout in interface MobicentsSipApplicationSession

invalidate

public void invalidate(boolean bypassCheck)

Specified by:

invalidate in interface MobicentsSipApplicationSession

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