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

All Superinterfaces:

SipSession, SipSessionExt

All Known Implementing Classes:

MobicentsSipSessionFacade, SipSessionImpl

public interface MobicentsSipSession
extends SipSession, SipSessionExt

Author:

Jean Deruelle

Nested Class Summary

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

SipSession.State

Method Summary

void	access()
void	acquire()
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()
long	getCseq()
java.util.Iterator<MobicentsSipSession>	getDerivedSipSessions()
java.lang.String	getHandler()
SipSessionKey	getKey() get the internal Mobicents Sip Session Key
SipApplicationRouterInfo	getNextSipApplicationRouterInfo()
java.util.Set<javax.sip.Transaction>	getOngoingTransactions()
java.lang.String	getOutboundInterface()
MobicentsSipSession	getParentSession()
ProxyImpl	getProxy() Retieves the proxy of the sip session if any
SipApplicationRoutingRegion	getRegionInternal()
int	getRequestsPending()
MobicentsSipSessionFacade	getSession()
javax.sip.Dialog	getSessionCreatingDialog()
SipServletMessageImpl	getSessionCreatingTransactionRequest()
MobicentsSipApplicationSession	getSipApplicationSession()
java.util.Map<java.lang.String,java.lang.Object>	getSipSessionAttributeMap()
SipSessionSecurity	getSipSessionSecurity()
java.lang.String	getSipSubscriberURI()
java.io.Serializable	getStateInfo()
java.lang.String	getTransport()
java.security.Principal	getUserPrincipal()
boolean	isValidInternal()
void	notifySipSessionListeners(SipSessionEventType creation)
void	onReadyToInvalidate()
void	onTerminatedState()
void	release()
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	setAckReceived(long cSeq, boolean ackReceived)
void	setB2buaHelper(B2buaHelperImpl helperImpl)
void	setCseq(long cseq)
void	setLocalParty(Address addressImpl)
void	setNextSipApplicationRouterInfo(SipApplicationRouterInfo routerInfo)
void	setParentSession(MobicentsSipSession mobicentsSipSession)
void	setProxy(ProxyImpl proxy)
void	setRemoteParty(Address addressImpl)
void	setRequestsPending(int requests)
void	setRoutingRegion(SipApplicationRoutingRegion routingRegion)
void	setSessionCreatingDialog(javax.sip.Dialog dialog)
void	setSessionCreatingTransactionRequest(SipServletMessageImpl message)
void	setSipSessionAttributeMap(java.util.Map<java.lang.String,java.lang.Object> sipSessionAttributeMap)
void	setSipSessionSecurity(SipSessionSecurity sipSessionSecurity)
void	setSipSubscriberURI(java.lang.String subscriberURI)
void	setState(SipSession.State state)
void	setStateInfo(java.io.Serializable stateInfo)
void	setTransport(java.lang.String transport)
void	setUserPrincipal(java.security.Principal principal)
void	updateStateOnResponse(SipServletResponseImpl sipServletResponseImpl, boolean receive)
void	updateStateOnSubsequentRequest(SipServletRequestImpl sipServletRequestImpl, boolean receive)
boolean	validateCSeq(SipServletRequestImpl sipServletRequestImpl)

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

Methods inherited from interface org.mobicents.javax.servlet.sip.SipSessionExt

getCopyRecordRouteHeadersOnSubsequentResponses, scheduleAsynchronousWork, setCopyRecordRouteHeadersOnSubsequentResponses, 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)

getSessionCreatingTransactionRequest

SipServletMessageImpl getSessionCreatingTransactionRequest()

setSessionCreatingTransactionRequest

void setSessionCreatingTransactionRequest(SipServletMessageImpl message)

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)

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

java.lang.String getOutboundInterface()

getDerivedSipSessions

java.util.Iterator<MobicentsSipSession> getDerivedSipSessions()

setState

void setState(SipSession.State state)

setSipSubscriberURI

void setSipSubscriberURI(java.lang.String subscriberURI)

getSipSubscriberURI

java.lang.String getSipSubscriberURI()

getParentSession

MobicentsSipSession getParentSession()

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()

acquire

void acquire()

release

void release()

addSubscription

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

Throws:

javax.sip.SipException

removeSubscription

void removeSubscription(SipServletMessageImpl sipServletMessage)

getSession

MobicentsSipSessionFacade getSession()

setNextSipApplicationRouterInfo

void setNextSipApplicationRouterInfo(SipApplicationRouterInfo routerInfo)

getNextSipApplicationRouterInfo

SipApplicationRouterInfo getNextSipApplicationRouterInfo()

isValidInternal

boolean isValidInternal()

getCseq

long getCseq()

setCseq

void setCseq(long cseq)

validateCSeq

boolean validateCSeq(SipServletRequestImpl sipServletRequestImpl)

getTransport

java.lang.String getTransport()

setTransport

void setTransport(java.lang.String transport)

getRequestsPending

int getRequestsPending()

setRequestsPending

void setRequestsPending(int requests)

setAckReceived

void setAckReceived(long cSeq,
                    boolean ackReceived)

notifySipSessionListeners

void notifySipSessionListeners(SipSessionEventType creation)

setSipSessionSecurity

void setSipSessionSecurity(SipSessionSecurity sipSessionSecurity)

getSipSessionSecurity

SipSessionSecurity getSipSessionSecurity()