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

All Superinterfaces:

SipSession

All Known Implementing Classes:

AttributeBasedClusteredSipSession, ClusteredSipSession, FieldBasedClusteredSipSession, JBossCacheClusteredSipSession, SessionBasedClusteredSipSession, SipSessionImpl

public interface MobicentsSipSession
extends SipSession

Author:

Jean Deruelle

Nested Class Summary

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

SipSession.State

Method Summary

void	access()
void	addDerivedSipSessions(MobicentsSipSession derivedSession) Add the derived sip session it will be identified by the To tag from its key
void	addOngoingTransaction(javax.sip.Transaction transaction)
void	addSubscription(SipServletMessageImpl sipServletMessage)
MobicentsSipSession	findDerivedSipSession(java.lang.String toTag) Find the derived sip session identified by its to tag
B2buaHelperImpl	getB2buaHelper()
java.util.Iterator<MobicentsSipSession>	getDerivedSipSessions()
ThreadPoolQueueExecutor	getExecutorService()
java.lang.String	getHandler()
SipSessionKey	getKey() get the internal Mobicents Sip Session Key
java.util.Set<javax.sip.Transaction>	getOngoingTransactions()
SipURI	getOutboundInterface()
ProxyImpl	getProxy() Retieves the proxy of the sip session if any
SipApplicationRoutingRegion	getRegionInternal()
javax.sip.Dialog	getSessionCreatingDialog()
javax.sip.Transaction	getSessionCreatingTransaction()
MobicentsSipApplicationSession	getSipApplicationSession()
java.util.Map<java.lang.String,java.lang.Object>	getSipSessionAttributeMap()
URI	getSipSubscriberURI()
java.io.Serializable	getStateInfo()
java.security.Principal	getUserPrincipal()
void	onReadyToInvalidate()
void	onTerminatedState()
MobicentsSipSession	removeDerivedSipSession(java.lang.String toTag) Removes the derived sip session identified by the To tag in parameter
void	removeOngoingTransaction(javax.sip.Transaction transaction)
void	removeSubscription(SipServletMessageImpl sipServletMessage)
void	setB2buaHelper(B2buaHelperImpl helperImpl)
void	setLocalParty(Address addressImpl)
void	setParentSession(MobicentsSipSession mobicentsSipSession)
void	setProxy(ProxyImpl proxy) Set the proxy of the sip session
void	setRemoteParty(Address addressImpl)
void	setRoutingRegion(SipApplicationRoutingRegion routingRegion)
void	setSessionCreatingDialog(javax.sip.Dialog dialog)
void	setSessionCreatingTransaction(javax.sip.Transaction transaction)
void	setSipSessionAttributeMap(java.util.Map<java.lang.String,java.lang.Object> sipSessionAttributeMap)
void	setSipSubscriberURI(URI subscriberURI)
void	setState(SipSession.State state)
void	setStateInfo(java.io.Serializable stateInfo)
void	setUserPrincipal(java.security.Principal principal)
void	updateStateOnResponse(SipServletResponseImpl sipServletResponseImpl, boolean receive)
void	updateStateOnSubsequentRequest(SipServletRequestImpl sipServletRequestImpl, boolean receive)

Methods inherited from interface javax.servlet.sip.SipSession

createRequest, getApplicationSession, getAttribute, getAttributeNames, getCallId, getCreationTime, getId, getInvalidateWhenReady, getLastAccessedTime, getLocalParty, getRegion, getRemoteParty, getServletContext, getState, getSubscriberURI, invalidate, isReadyToInvalidate, isValid, removeAttribute, setAttribute, setHandler, setInvalidateWhenReady, setOutboundInterface, setOutboundInterface

Method Detail

getKey

SipSessionKey getKey()

get the internal Mobicents Sip Session Key

Returns:

the internal Mobicents Sip Session Key

addDerivedSipSessions

void addDerivedSipSessions(MobicentsSipSession derivedSession)

Add the derived sip session it will be identified by the To tag from its key

Parameters:

derivedSession - the derived session to add

removeDerivedSipSession

MobicentsSipSession removeDerivedSipSession(java.lang.String toTag)

Removes the derived sip session identified by the To tag in parameter

Parameters:

toTag - the to Tag identifying the sip session to remove

Returns:

the removed derived sip session

findDerivedSipSession

MobicentsSipSession findDerivedSipSession(java.lang.String toTag)

Find the derived sip session identified by its to tag

Parameters:

toTag - the to Tag identifying the sip session to remove

Returns:

the derived sip session identified by its to tag or null if none has been found

getSipApplicationSession

MobicentsSipApplicationSession getSipApplicationSession()

getHandler

java.lang.String getHandler()

getSessionCreatingDialog

javax.sip.Dialog getSessionCreatingDialog()

setSessionCreatingDialog

void setSessionCreatingDialog(javax.sip.Dialog dialog)

getSessionCreatingTransaction

javax.sip.Transaction getSessionCreatingTransaction()

setSessionCreatingTransaction

void setSessionCreatingTransaction(javax.sip.Transaction transaction)

getOngoingTransactions

java.util.Set<javax.sip.Transaction> getOngoingTransactions()

removeOngoingTransaction

void removeOngoingTransaction(javax.sip.Transaction transaction)

addOngoingTransaction

void addOngoingTransaction(javax.sip.Transaction transaction)

getStateInfo

java.io.Serializable getStateInfo()

setStateInfo

void setStateInfo(java.io.Serializable stateInfo)

getUserPrincipal

java.security.Principal getUserPrincipal()

setUserPrincipal

void setUserPrincipal(java.security.Principal principal)

setRoutingRegion

void setRoutingRegion(SipApplicationRoutingRegion routingRegion)

getProxy

ProxyImpl getProxy()

Retieves the proxy of the sip session if any

Returns:

setProxy

void setProxy(ProxyImpl proxy)

Set the proxy of the sip session

Parameters:

proxy -

setB2buaHelper

void setB2buaHelper(B2buaHelperImpl helperImpl)

getB2buaHelper

B2buaHelperImpl getB2buaHelper()

access

void access()

updateStateOnResponse

void updateStateOnResponse(SipServletResponseImpl sipServletResponseImpl,
                           boolean receive)

updateStateOnSubsequentRequest

void updateStateOnSubsequentRequest(SipServletRequestImpl sipServletRequestImpl,
                                    boolean receive)

onTerminatedState

void onTerminatedState()

onReadyToInvalidate

void onReadyToInvalidate()

getOutboundInterface

SipURI getOutboundInterface()

getDerivedSipSessions

java.util.Iterator<MobicentsSipSession> getDerivedSipSessions()

setState

void setState(SipSession.State state)

setSipSubscriberURI

void setSipSubscriberURI(URI subscriberURI)

getSipSubscriberURI

URI getSipSubscriberURI()

setParentSession

void setParentSession(MobicentsSipSession mobicentsSipSession)

getSipSessionAttributeMap

java.util.Map<java.lang.String,java.lang.Object> getSipSessionAttributeMap()

setSipSessionAttributeMap

void setSipSessionAttributeMap(java.util.Map<java.lang.String,java.lang.Object> sipSessionAttributeMap)

setLocalParty

void setLocalParty(Address addressImpl)

setRemoteParty

void setRemoteParty(Address addressImpl)

getRegionInternal

SipApplicationRoutingRegion getRegionInternal()

getExecutorService

ThreadPoolQueueExecutor getExecutorService()

addSubscription

void addSubscription(SipServletMessageImpl sipServletMessage)
                     throws javax.sip.SipException

Throws:

javax.sip.SipException

removeSubscription

void removeSubscription(SipServletMessageImpl sipServletMessage)