MobicentsSipSessionFacade (Sip Servlets Implementation 3.0.549 API)

java.lang.Object
- org.mobicents.servlet.sip.message.MobicentsSipSessionFacade

All Implemented Interfaces:

Serializable, SipSession, SipSessionExt, MobicentsSipSession
```
public class MobicentsSipSessionFacade
extends Object
implements MobicentsSipSession, Serializable
```
The purpose of this class is to be a facade to the real sip 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.SipSession
  SipSession.State

Field Summary

Fields
Modifier and Type Field and Description

protected boolean orphan

Fields
Modifier and Type	Field and Description
`protected boolean`	`orphan`

Constructor Summary

Constructors
Constructor and Description

MobicentsSipSessionFacade(MobicentsSipSession sipSession)

Constructors
Constructor and Description
`MobicentsSipSessionFacade(MobicentsSipSession sipSession)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`access()`
`void`	`acquire()`
`void`	`addDerivedSipSessions(MobicentsSipSession derivedSession)`
`void`	`addOngoingTransaction(javax.sip.Transaction transaction)`
`void`	`addSubscription(MobicentsSipServletMessage sipServletMessage)`
`SipServletRequest`	`createRequest(String arg0)`
`boolean`	`equals(Object obj)`
`MobicentsSipSession`	`findDerivedSipSession(String toTag)`
`SipApplicationSession`	`getApplicationSession()`
`Object`	`getAttribute(String arg0)`
`Enumeration<String>`	`getAttributeNames()`
`MobicentsB2BUAHelper`	`getB2buaHelper()`
`String`	`getCallId()`
`boolean`	`getCopyRecordRouteHeadersOnSubsequentResponses()`
`long`	`getCreationTime()`
`long`	`getCseq()`
`Iterator<MobicentsSipSession>`	`getDerivedSipSessions()`
`MobicentsSipSession`	`getFacade()`
`javax.sip.address.SipURI`	`getFlow()`
`String`	`getHandler()`
`String`	`getId()`
`boolean`	`getInvalidateWhenReady()`
`MobicentsSipSessionKey`	`getKey()`
`long`	`getLastAccessedTime()`
`Address`	`getLocalParty()`
`MobicentsSipSession`	`getMobicentsSipSession()`
`SipApplicationRouterInfo`	`getNextSipApplicationRouterInfo()`
`Set<javax.sip.Transaction>`	`getOngoingTransactions()`
`String`	`getOutboundInterface()`
`MobicentsSipSession`	`getParentSession()`
`MobicentsProxy`	`getProxy()`
`SipApplicationRoutingRegion`	`getRegion()`
`SipApplicationRoutingRegion`	`getRegionInternal()`
`Address`	`getRemoteParty()`
`int`	`getRequestsPending()`
`javax.servlet.ServletContext`	`getServletContext()`
`javax.sip.Dialog`	`getSessionCreatingDialog()`
`MobicentsSipServletMessage`	`getSessionCreatingTransactionRequest()`
`MobicentsSipApplicationSession`	`getSipApplicationSession()`
`Map<String,Object>`	`getSipSessionAttributeMap()`
`MobicentsSipSessionSecurity`	`getSipSessionSecurity()`
`String`	`getSipSubscriberURI()`
`SipSession.State`	`getState()`
`Serializable`	`getStateInfo()`
`URI`	`getSubscriberURI()`
`String`	`getTransport()`
`SipPrincipal`	`getUserPrincipal()`
`int`	`hashCode()`
`void`	`invalidate()`
`void`	`invalidate(boolean bypassCheck)`
`boolean`	`isOrphan()`
`boolean`	`isReadyToInvalidate()`
`boolean`	`isReadyToInvalidateInternal()`
`boolean`	`isValid()`
`boolean`	`isValidInternal()`
`void`	`notifySipSessionListeners(SipSessionEventType creation)`
`void`	`onReadyToInvalidate()`
`void`	`onTerminatedState()`
`void`	`release()`
`void`	`removeAttribute(String arg0)`
`MobicentsSipSession`	`removeDerivedSipSession(String toTag)`
`void`	`removeOngoingTransaction(javax.sip.Transaction transaction)`
`void`	`removeSubscription(MobicentsSipServletMessage sipServletMessage)`
`void`	`scheduleAsynchronousWork(SipSessionAsynchronousWork work)`
`void`	`setAckReceived(long cSeq, boolean ackReceived)`
`void`	`setAttribute(String arg0, Object arg1)`
`void`	`setB2buaHelper(MobicentsB2BUAHelper helperImpl)`
`void`	`setCopyRecordRouteHeadersOnSubsequentResponses(boolean copyRecordRouteHeadersOnSubsequentResponses)`
`void`	`setCseq(long cseq)`
`void`	`setFlow(javax.sip.address.SipURI flow)`
`void`	`setHandler(String arg0)`
`void`	`setInvalidateWhenReady(boolean arg0)`
`void`	`setLocalParty(Address addressImpl)`
`void`	`setNextSipApplicationRouterInfo(SipApplicationRouterInfo routerInfo)`
`void`	`setOrphan(boolean orphan)`
`void`	`setOutboundInterface(InetAddress arg0)`
`void`	`setOutboundInterface(InetSocketAddress arg0)`
`void`	`setOutboundInterface(SipURI arg0)`
`void`	`setParentSession(MobicentsSipSession mobicentsSipSession)`
`void`	`setProxy(MobicentsProxy proxy)`
`void`	`setRemoteParty(Address addressImpl)`
`void`	`setRequestsPending(int requests)`
`void`	`setRoutingRegion(SipApplicationRoutingRegion routingRegion)`
`void`	`setSessionCreatingDialog(javax.sip.Dialog dialog)`
`void`	`setSessionCreatingTransactionRequest(MobicentsSipServletMessage message)`
`void`	`setSipSessionAttributeMap(Map<String,Object> sipSessionAttributeMap)`
`void`	`setSipSessionSecurity(MobicentsSipSessionSecurity sipSessionSecurity)`
`void`	`setSipSubscriberURI(String subscriberURI)`
`void`	`setState(SipSession.State state)`
`void`	`setStateInfo(Serializable stateInfo)`
`void`	`setTransport(String transport)`
`void`	`setUserPrincipal(SipPrincipal principal)`
`String`	`toString()`
`void`	`updateStateOnResponse(MobicentsSipServletResponse sipServletResponseImpl, boolean receive)`
`void`	`updateStateOnSubsequentRequest(MobicentsSipServletRequest sipServletRequestImpl, boolean receive)`
`boolean`	`validateCSeq(MobicentsSipServletRequest request)`

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

- Field Detail
  - orphan
```
protected boolean orphan
```
- Constructor Detail
  - MobicentsSipSessionFacade
```
public MobicentsSipSessionFacade(MobicentsSipSession sipSession)
```
- Method Detail
  - createRequest
```
public SipServletRequest createRequest(String arg0)
```
    Specified by:
    
    createRequest in interface SipSession
  - getApplicationSession
```
public SipApplicationSession getApplicationSession()
```
    Specified by:
    
    getApplicationSession in interface SipSession
  - getAttribute
```
public Object getAttribute(String arg0)
```
    Specified by:
    
    getAttribute in interface SipSession
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface SipSession
  - getCallId
```
public String getCallId()
```
    Specified by:
    
    getCallId in interface SipSession
  - getCreationTime
```
public long getCreationTime()
```
    Specified by:
    
    getCreationTime in interface SipSession
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface SipSession
  - getInvalidateWhenReady
```
public boolean getInvalidateWhenReady()
```
    Specified by:
    
    getInvalidateWhenReady in interface SipSession
  - getLastAccessedTime
```
public long getLastAccessedTime()
```
    Specified by:
    
    getLastAccessedTime in interface SipSession
  - getLocalParty
```
public Address getLocalParty()
```
    Specified by:
    
    getLocalParty in interface SipSession
  - getRegion
```
public SipApplicationRoutingRegion getRegion()
```
    Specified by:
    
    getRegion in interface SipSession
  - getRemoteParty
```
public Address getRemoteParty()
```
    Specified by:
    
    getRemoteParty in interface SipSession
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
    Specified by:
    
    getServletContext in interface SipSession
  - getState
```
public SipSession.State getState()
```
    Specified by:
    
    getState in interface SipSession
  - getSubscriberURI
```
public URI getSubscriberURI()
```
    Specified by:
    
    getSubscriberURI in interface SipSession
  - invalidate
```
public void invalidate()
```
    Specified by:
    
    invalidate in interface SipSession
  - invalidate
```
public void invalidate(boolean bypassCheck)
```
    Specified by:
    
    invalidate in interface MobicentsSipSession
  - isReadyToInvalidate
```
public boolean isReadyToInvalidate()
```
    Specified by:
    
    isReadyToInvalidate in interface SipSession
  - isReadyToInvalidateInternal
```
public boolean isReadyToInvalidateInternal()
```
    Specified by:
    
    isReadyToInvalidateInternal in interface MobicentsSipSession
  - isValid
```
public boolean isValid()
```
    Specified by:
    
    isValid in interface SipSession
  - isValidInternal
```
public boolean isValidInternal()
```
    Specified by:
    
    isValidInternal in interface MobicentsSipSession
  - removeAttribute
```
public void removeAttribute(String arg0)
```
    Specified by:
    
    removeAttribute in interface SipSession
  - setAttribute
```
public void setAttribute(String arg0,
                Object arg1)
```
    Specified by:
    
    setAttribute in interface SipSession
  - setHandler
```
public void setHandler(String arg0)
                throws javax.servlet.ServletException
```
    Specified by:
    
    setHandler in interface SipSession
    
    Throws:
    
    javax.servlet.ServletException
  - setInvalidateWhenReady
```
public void setInvalidateWhenReady(boolean arg0)
```
    Specified by:
    
    setInvalidateWhenReady in interface SipSession
  - setOutboundInterface
```
public void setOutboundInterface(InetAddress arg0)
```
    Specified by:
    
    setOutboundInterface in interface SipSession
  - setOutboundInterface
```
public void setOutboundInterface(InetSocketAddress arg0)
```
    Specified by:
    
    setOutboundInterface in interface SipSession
  - setOutboundInterface
```
public void setOutboundInterface(SipURI arg0)
```
    Specified by:
    
    setOutboundInterface in interface SipSessionExt
  - access
```
public void access()
```
    Specified by:
    
    access in interface MobicentsSipSession
  - addDerivedSipSessions
```
public void addDerivedSipSessions(MobicentsSipSession derivedSession)
```
    Specified by:
    
    addDerivedSipSessions in interface MobicentsSipSession
  - addOngoingTransaction
```
public void addOngoingTransaction(javax.sip.Transaction transaction)
```
    Specified by:
    
    addOngoingTransaction in interface MobicentsSipSession
  - addSubscription
```
public void addSubscription(MobicentsSipServletMessage sipServletMessage)
                     throws javax.sip.SipException
```
    Specified by:
    
    addSubscription in interface MobicentsSipSession
    
    Throws:
    
    javax.sip.SipException
  - findDerivedSipSession
```
public MobicentsSipSession findDerivedSipSession(String toTag)
```
    Specified by:
    
    findDerivedSipSession in interface MobicentsSipSession
  - getB2buaHelper
```
public MobicentsB2BUAHelper getB2buaHelper()
```
    Specified by:
    
    getB2buaHelper in interface MobicentsSipSession
  - getDerivedSipSessions
```
public Iterator<MobicentsSipSession> getDerivedSipSessions()
```
    Specified by:
    
    getDerivedSipSessions in interface MobicentsSipSession
  - getHandler
```
public String getHandler()
```
    Specified by:
    
    getHandler in interface MobicentsSipSession
  - getKey
```
public MobicentsSipSessionKey getKey()
```
    Specified by:
    
    getKey in interface MobicentsSipSession
  - getOngoingTransactions
```
public Set<javax.sip.Transaction> getOngoingTransactions()
```
    Specified by:
    
    getOngoingTransactions in interface MobicentsSipSession
  - getOutboundInterface
```
public String getOutboundInterface()
```
    Specified by:
    
    getOutboundInterface in interface MobicentsSipSession
  - getProxy
```
public MobicentsProxy getProxy()
```
    Specified by:
    
    getProxy in interface MobicentsSipSession
  - getRegionInternal
```
public SipApplicationRoutingRegion getRegionInternal()
```
    Specified by:
    
    getRegionInternal in interface MobicentsSipSession
  - getSessionCreatingDialog
```
public javax.sip.Dialog getSessionCreatingDialog()
```
    Specified by:
    
    getSessionCreatingDialog in interface MobicentsSipSession
  - getSessionCreatingTransactionRequest
```
public MobicentsSipServletMessage getSessionCreatingTransactionRequest()
```
    Specified by:
    
    getSessionCreatingTransactionRequest in interface MobicentsSipSession
  - getSipApplicationSession
```
public MobicentsSipApplicationSession getSipApplicationSession()
```
    Specified by:
    
    getSipApplicationSession in interface MobicentsSipSession
  - getSipSessionAttributeMap
```
public Map<String,Object> getSipSessionAttributeMap()
```
    Specified by:
    
    getSipSessionAttributeMap in interface MobicentsSipSession
  - getSipSubscriberURI
```
public String getSipSubscriberURI()
```
    Specified by:
    
    getSipSubscriberURI in interface MobicentsSipSession
  - getStateInfo
```
public Serializable getStateInfo()
```
    Specified by:
    
    getStateInfo in interface MobicentsSipSession
  - getUserPrincipal
```
public SipPrincipal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface MobicentsSipSession
  - onReadyToInvalidate
```
public void onReadyToInvalidate()
```
    Specified by:
    
    onReadyToInvalidate in interface MobicentsSipSession
  - onTerminatedState
```
public void onTerminatedState()
```
    Specified by:
    
    onTerminatedState in interface MobicentsSipSession
  - removeDerivedSipSession
```
public MobicentsSipSession removeDerivedSipSession(String toTag)
```
    Specified by:
    
    removeDerivedSipSession in interface MobicentsSipSession
  - removeOngoingTransaction
```
public void removeOngoingTransaction(javax.sip.Transaction transaction)
```
    Specified by:
    
    removeOngoingTransaction in interface MobicentsSipSession
  - removeSubscription
```
public void removeSubscription(MobicentsSipServletMessage sipServletMessage)
```
    Specified by:
    
    removeSubscription in interface MobicentsSipSession
  - setB2buaHelper
```
public void setB2buaHelper(MobicentsB2BUAHelper helperImpl)
```
    Specified by:
    
    setB2buaHelper in interface MobicentsSipSession
  - setLocalParty
```
public void setLocalParty(Address addressImpl)
```
    Specified by:
    
    setLocalParty in interface MobicentsSipSession
  - setParentSession
```
public void setParentSession(MobicentsSipSession mobicentsSipSession)
```
    Specified by:
    
    setParentSession in interface MobicentsSipSession
  - getParentSession
```
public MobicentsSipSession getParentSession()
```
    Specified by:
    
    getParentSession in interface MobicentsSipSession
  - setProxy
```
public void setProxy(MobicentsProxy proxy)
```
    Specified by:
    
    setProxy in interface MobicentsSipSession
  - setRemoteParty
```
public void setRemoteParty(Address addressImpl)
```
    Specified by:
    
    setRemoteParty in interface MobicentsSipSession
  - setRoutingRegion
```
public void setRoutingRegion(SipApplicationRoutingRegion routingRegion)
```
    Specified by:
    
    setRoutingRegion in interface MobicentsSipSession
  - setSessionCreatingDialog
```
public void setSessionCreatingDialog(javax.sip.Dialog dialog)
```
    Specified by:
    
    setSessionCreatingDialog in interface MobicentsSipSession
  - setSessionCreatingTransactionRequest
```
public void setSessionCreatingTransactionRequest(MobicentsSipServletMessage message)
```
    Specified by:
    
    setSessionCreatingTransactionRequest in interface MobicentsSipSession
  - setSipSessionAttributeMap
```
public void setSipSessionAttributeMap(Map<String,Object> sipSessionAttributeMap)
```
    Specified by:
    
    setSipSessionAttributeMap in interface MobicentsSipSession
  - setSipSubscriberURI
```
public void setSipSubscriberURI(String subscriberURI)
```
    Specified by:
    
    setSipSubscriberURI in interface MobicentsSipSession
  - setState
```
public void setState(SipSession.State state)
```
    Specified by:
    
    setState in interface MobicentsSipSession
  - setStateInfo
```
public void setStateInfo(Serializable stateInfo)
```
    Specified by:
    
    setStateInfo in interface MobicentsSipSession
  - setUserPrincipal
```
public void setUserPrincipal(SipPrincipal principal)
```
    Specified by:
    
    setUserPrincipal in interface MobicentsSipSession
  - updateStateOnResponse
```
public void updateStateOnResponse(MobicentsSipServletResponse sipServletResponseImpl,
                         boolean receive)
```
    Specified by:
    
    updateStateOnResponse in interface MobicentsSipSession
  - updateStateOnSubsequentRequest
```
public void updateStateOnSubsequentRequest(MobicentsSipServletRequest sipServletRequestImpl,
                                  boolean receive)
```
    Specified by:
    
    updateStateOnSubsequentRequest in interface MobicentsSipSession
  - getFacade
```
public MobicentsSipSession getFacade()
```
    Specified by:
    
    getFacade in interface MobicentsSipSession
  - 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
  - getNextSipApplicationRouterInfo
```
public SipApplicationRouterInfo getNextSipApplicationRouterInfo()
```
    Specified by:
    
    getNextSipApplicationRouterInfo in interface MobicentsSipSession
  - setNextSipApplicationRouterInfo
```
public void setNextSipApplicationRouterInfo(SipApplicationRouterInfo routerInfo)
```
    Specified by:
    
    setNextSipApplicationRouterInfo in interface MobicentsSipSession
  - setAckReceived
```
public void setAckReceived(long cSeq,
                  boolean ackReceived)
```
    Specified by:
    
    setAckReceived in interface MobicentsSipSession
  - setCseq
```
public void setCseq(long cseq)
```
    Specified by:
    
    setCseq in interface MobicentsSipSession
  - getCseq
```
public long getCseq()
```
    Specified by:
    
    getCseq in interface MobicentsSipSession
  - validateCSeq
```
public boolean validateCSeq(MobicentsSipServletRequest request)
```
    Specified by:
    
    validateCSeq in interface MobicentsSipSession
  - getMobicentsSipSession
```
public MobicentsSipSession getMobicentsSipSession()
```
  - getTransport
```
public String getTransport()
```
    Specified by:
    
    getTransport in interface MobicentsSipSession
  - setTransport
```
public void setTransport(String transport)
```
    Specified by:
    
    setTransport in interface MobicentsSipSession
  - scheduleAsynchronousWork
```
public void scheduleAsynchronousWork(SipSessionAsynchronousWork work)
```
    Specified by:
    
    scheduleAsynchronousWork in interface SipSessionExt
  - getRequestsPending
```
public int getRequestsPending()
```
    Specified by:
    
    getRequestsPending in interface MobicentsSipSession
  - setRequestsPending
```
public void setRequestsPending(int requests)
```
    Specified by:
    
    setRequestsPending in interface MobicentsSipSession
  - notifySipSessionListeners
```
public void notifySipSessionListeners(SipSessionEventType creation)
```
    Specified by:
    
    notifySipSessionListeners in interface MobicentsSipSession
  - setCopyRecordRouteHeadersOnSubsequentResponses
```
public void setCopyRecordRouteHeadersOnSubsequentResponses(boolean copyRecordRouteHeadersOnSubsequentResponses)
```
    Specified by:
    
    setCopyRecordRouteHeadersOnSubsequentResponses in interface SipSessionExt
  - getCopyRecordRouteHeadersOnSubsequentResponses
```
public boolean getCopyRecordRouteHeadersOnSubsequentResponses()
```
    Specified by:
    
    getCopyRecordRouteHeadersOnSubsequentResponses in interface SipSessionExt
  - getSipSessionSecurity
```
public MobicentsSipSessionSecurity getSipSessionSecurity()
```
    Specified by:
    
    getSipSessionSecurity in interface MobicentsSipSession
  - setSipSessionSecurity
```
public void setSipSessionSecurity(MobicentsSipSessionSecurity sipSessionSecurity)
```
    Specified by:
    
    setSipSessionSecurity in interface MobicentsSipSession
  - acquire
```
public void acquire()
```
    Specified by:
    
    acquire in interface MobicentsSipSession
  - release
```
public void release()
```
    Specified by:
    
    release in interface MobicentsSipSession
  - setFlow
```
public void setFlow(javax.sip.address.SipURI flow)
```
    Specified by:
    
    setFlow in interface MobicentsSipSession
  - getFlow
```
public javax.sip.address.SipURI getFlow()
```
    Specified by:
    
    getFlow in interface MobicentsSipSession
  - isOrphan
```
public boolean isOrphan()
```
    Specified by:
    
    isOrphan in interface MobicentsSipSession
  - setOrphan
```
public void setOrphan(boolean orphan)
```
    Specified by:
    
    setOrphan in interface MobicentsSipSession

Class MobicentsSipSessionFacade

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

orphan

Constructor Detail

MobicentsSipSessionFacade

Method Detail

createRequest

getApplicationSession

getAttribute

getAttributeNames

getCallId

getCreationTime

getId

getInvalidateWhenReady

getLastAccessedTime

getLocalParty

getRegion

getRemoteParty

getServletContext

getState

getSubscriberURI

invalidate

invalidate

isReadyToInvalidate

isReadyToInvalidateInternal

isValid

isValidInternal

removeAttribute

setAttribute

setHandler

setInvalidateWhenReady

setOutboundInterface

setOutboundInterface

setOutboundInterface

access

addDerivedSipSessions

addOngoingTransaction

addSubscription

findDerivedSipSession

getB2buaHelper

getDerivedSipSessions

getHandler

getKey

getOngoingTransactions

getOutboundInterface

getProxy

getRegionInternal

getSessionCreatingDialog

getSessionCreatingTransactionRequest

getSipApplicationSession

getSipSessionAttributeMap

getSipSubscriberURI

getStateInfo

getUserPrincipal

onReadyToInvalidate

onTerminatedState

removeDerivedSipSession

removeOngoingTransaction

removeSubscription

setB2buaHelper

setLocalParty

setParentSession

getParentSession

setProxy

setRemoteParty

setRoutingRegion

setSessionCreatingDialog

setSessionCreatingTransactionRequest

setSipSessionAttributeMap

setSipSubscriberURI

setState

setStateInfo

setUserPrincipal

updateStateOnResponse