org.cipango.server.session

Class Session

java.lang.Object

org.cipango.server.session.Session

All Implemented Interfaces:

javax.servlet.sip.SipSession, SessionManager.SipSessionIf, org.eclipse.jetty.util.component.Dumpable

public class Session
extends java.lang.Object
implements SessionManager.SipSessionIf, org.eclipse.jetty.util.component.Dumpable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Session.DialogInfo
static class	Session.Role

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

javax.servlet.sip.SipSession.State

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	_attributes
protected java.lang.String	_callId
protected java.util.List<ClientTransaction>	_clientTransactions
protected java.lang.String	_linkedSessionId
protected javax.servlet.sip.Address	_localParty
protected javax.servlet.sip.ar.SipApplicationRoutingRegion	_region
protected javax.servlet.sip.Address	_remoteParty
protected Session.Role	_role
protected java.util.List<ServerTransaction>	_serverTransactions
protected javax.servlet.sip.SipSession.State	_state
protected javax.servlet.sip.URI	_subscriberURI

Constructor Summary

Constructors

Modifier	Constructor and Description
	Session(ApplicationSession applicationSession, java.lang.String id, SipRequest request)
	Session(ApplicationSession applicationSession, java.lang.String id, java.lang.String callId, javax.servlet.sip.Address local, javax.servlet.sip.Address remote)
protected	Session(ApplicationSession applicationSession, java.lang.String id, java.lang.String callId, javax.servlet.sip.Address local, javax.servlet.sip.Address remote, long created, long lastAccessed)
	Session(java.lang.String id, Session other)

Method Summary

Modifier and Type	Method and Description
void	access()
void	addClientTransaction(ClientTransaction transaction)
void	addServerTransaction(ServerTransaction transaction)
ApplicationSession	appSession()
protected void	createProxyDialog(SipResponse response)
javax.servlet.sip.SipServletRequest	createRequest(java.lang.String method)
void	createUA(javax.servlet.sip.UAMode mode)
protected java.lang.Object	doPutOrRemove(java.lang.String name, java.lang.Object value)
java.lang.String	dump()
void	dump(java.lang.Appendable out, java.lang.String indent)
boolean	equals(java.lang.Object o)
javax.servlet.sip.SipApplicationSession	getApplicationSession()
java.lang.Object	getAttribute(java.lang.String name)
java.util.Enumeration<java.lang.String>	getAttributeNames()
java.lang.String	getCallId()
java.util.List<ClientTransaction>	getClientTransactions()
javax.servlet.sip.Address	getContact()
javax.servlet.sip.Address	getContact(SipConnection connection)
javax.servlet.sip.Address	getContact(SipConnector connector)
long	getCreationTime()
SipServletHolder	getHandler()
java.lang.String	getId()
boolean	getInvalidateWhenReady()
long	getLastAccessedTime()
Session	getLinkedSession()
javax.servlet.sip.Address	getLocalParty()
java.lang.String	getLocalTag()
javax.servlet.sip.ar.SipApplicationRoutingRegion	getRegion()
javax.servlet.sip.Address	getRemoteParty()
protected SipServer	getServer()
java.util.List<ServerTransaction>	getServerTransactions()
javax.servlet.ServletContext	getServletContext()
Session	getSession()
javax.servlet.sip.SipSession.State	getState()
javax.servlet.sip.URI	getSubscriberURI()
Session.DialogInfo	getUa()
void	invalidate()
void	invalidateIfReady()
void	invokeServlet(SipRequest request)
void	invokeServlet(SipResponse response)
boolean	isDialog(java.lang.String callId, java.lang.String fromTag, java.lang.String toTag)
boolean	isProxy()
boolean	isReadyToInvalidate()
boolean	isSameDialog(SipResponse response)
boolean	isTerminated()
boolean	isUA()
boolean	isValid()
protected Session.DialogInfo	newDialogInfo()
void	putAttribute(java.lang.String name, java.lang.Object value)
void	removeAttribute(java.lang.String name)
void	removeTransaction(Transaction transaction)
ClientTransaction	sendRequest(SipRequest request)
ClientTransaction	sendRequest(SipRequest request, ClientTransactionListener listener)
void	sendResponse(SipResponse response, boolean reliable)
void	setAttribute(java.lang.String name, java.lang.Object value)
void	setHandler(SipServletHolder handler)
void	setHandler(java.lang.String name)
void	setInvalidateWhenReady(boolean invalidateWhenReady)
void	setLinkedSession(Session session)
void	setOutboundInterface(java.net.InetAddress address)
void	setOutboundInterface(java.net.InetSocketAddress address)
void	setProxy()
void	setRecordRoute(boolean recordRoute)
void	setRegion(javax.servlet.sip.ar.SipApplicationRoutingRegion region)
void	setSubscriberURI(javax.servlet.sip.URI uri)
void	setUAS()
java.lang.String	toString()
void	updateState(SipResponse response, boolean uac)
void	updateStateOnProxyComplete(boolean forceTerminated) When in proxy mode, the server transaction become complete, the derived sessions state should be set to TERMINATED.

Methods inherited from class java.lang.Object

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

Field Detail

_state

protected javax.servlet.sip.SipSession.State _state

_role

protected Session.Role _role

_callId

protected final java.lang.String _callId

_localParty

protected javax.servlet.sip.Address _localParty

_remoteParty

protected javax.servlet.sip.Address _remoteParty

_attributes

protected java.util.Map<java.lang.String,java.lang.Object> _attributes

_serverTransactions

protected java.util.List<ServerTransaction> _serverTransactions

_clientTransactions

protected java.util.List<ClientTransaction> _clientTransactions

_linkedSessionId

protected java.lang.String _linkedSessionId

_region

protected javax.servlet.sip.ar.SipApplicationRoutingRegion _region

_subscriberURI

protected javax.servlet.sip.URI _subscriberURI

Constructor Detail

Session

public Session(ApplicationSession applicationSession,
               java.lang.String id,
               SipRequest request)

Session

public Session(ApplicationSession applicationSession,
               java.lang.String id,
               java.lang.String callId,
               javax.servlet.sip.Address local,
               javax.servlet.sip.Address remote)

Session

protected Session(ApplicationSession applicationSession,
                  java.lang.String id,
                  java.lang.String callId,
                  javax.servlet.sip.Address local,
                  javax.servlet.sip.Address remote,
                  long created,
                  long lastAccessed)

Session

public Session(java.lang.String id,
               Session other)

Method Detail

appSession

public ApplicationSession appSession()

isUA

public boolean isUA()

isProxy

public boolean isProxy()

setLinkedSession

public void setLinkedSession(Session session)

getLinkedSession

public Session getLinkedSession()

getServer

protected SipServer getServer()

doPutOrRemove

protected java.lang.Object doPutOrRemove(java.lang.String name,
                                         java.lang.Object value)

setProxy

public void setProxy()

setRecordRoute

public void setRecordRoute(boolean recordRoute)

setUAS

public void setUAS()

createUA

public void createUA(javax.servlet.sip.UAMode mode)

newDialogInfo

protected Session.DialogInfo newDialogInfo()

sendResponse

public void sendResponse(SipResponse response,
                         boolean reliable)
                  throws java.io.IOException

Throws:

java.io.IOException

sendRequest

public ClientTransaction sendRequest(SipRequest request,
                                     ClientTransactionListener listener)
                              throws java.io.IOException

Throws:

java.io.IOException

sendRequest

public ClientTransaction sendRequest(SipRequest request)
                              throws java.io.IOException

Throws:

java.io.IOException

invokeServlet

public void invokeServlet(SipRequest request)
                   throws SipException

Throws:

SipException

invokeServlet

public void invokeServlet(SipResponse response)

access

public void access()

updateStateOnProxyComplete

public void updateStateOnProxyComplete(boolean forceTerminated)

When in proxy mode, the server transaction become complete, the derived sessions state should be set to TERMINATED.

Parameters:

SipReponse - the last received response for the branch.

updateState

public void updateState(SipResponse response,
                        boolean uac)

isSameDialog

public boolean isSameDialog(SipResponse response)

isDialog

public boolean isDialog(java.lang.String callId,
                        java.lang.String fromTag,
                        java.lang.String toTag)

createProxyDialog

protected void createProxyDialog(SipResponse response)

getContact

public javax.servlet.sip.Address getContact()

getContact

public javax.servlet.sip.Address getContact(SipConnector connector)

getContact

public javax.servlet.sip.Address getContact(SipConnection connection)

createRequest

public javax.servlet.sip.SipServletRequest createRequest(java.lang.String method)

Specified by:

createRequest in interface javax.servlet.sip.SipSession

getHandler

public SipServletHolder getHandler()

setHandler

public void setHandler(SipServletHolder handler)

getApplicationSession

public javax.servlet.sip.SipApplicationSession getApplicationSession()

Specified by:

getApplicationSession in interface javax.servlet.sip.SipSession

See Also:

SipSession.getApplicationSession()

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Specified by:

getAttribute in interface javax.servlet.sip.SipSession

See Also:

SipSession.getAttribute(String)

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

Specified by:

getAttributeNames in interface javax.servlet.sip.SipSession

See Also:

SipSession.getAttributeNames()

getCallId

public java.lang.String getCallId()

Specified by:

getCallId in interface javax.servlet.sip.SipSession

getCreationTime

public long getCreationTime()

Specified by:

getCreationTime in interface javax.servlet.sip.SipSession

See Also:

SipSession.getCreationTime()

getId

public java.lang.String getId()

Specified by:

getId in interface javax.servlet.sip.SipSession

See Also:

SipSession.getId()

getInvalidateWhenReady

public boolean getInvalidateWhenReady()

Specified by:

getInvalidateWhenReady in interface javax.servlet.sip.SipSession

getLastAccessedTime

public long getLastAccessedTime()

Specified by:

getLastAccessedTime in interface javax.servlet.sip.SipSession

See Also:

SipSession.getLastAccessedTime()

getLocalParty

public javax.servlet.sip.Address getLocalParty()

Specified by:

getLocalParty in interface javax.servlet.sip.SipSession

getRegion

public javax.servlet.sip.ar.SipApplicationRoutingRegion getRegion()

Specified by:

getRegion in interface javax.servlet.sip.SipSession

getRemoteParty

public javax.servlet.sip.Address getRemoteParty()

Specified by:

getRemoteParty in interface javax.servlet.sip.SipSession

getLocalTag

public java.lang.String getLocalTag()

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface javax.servlet.sip.SipSession

See Also:

SipSession.getServletContext()

getState

public javax.servlet.sip.SipSession.State getState()

Specified by:

getState in interface javax.servlet.sip.SipSession

See Also:

SipSession.getState()

getSubscriberURI

public javax.servlet.sip.URI getSubscriberURI()

Specified by:

getSubscriberURI in interface javax.servlet.sip.SipSession

invalidate

public void invalidate()

Specified by:

invalidate in interface javax.servlet.sip.SipSession

isReadyToInvalidate

public boolean isReadyToInvalidate()

Specified by:

isReadyToInvalidate in interface javax.servlet.sip.SipSession

invalidateIfReady

public void invalidateIfReady()

isValid

public boolean isValid()

Specified by:

isValid in interface javax.servlet.sip.SipSession

See Also:

SipSession.isValid()

isTerminated

public boolean isTerminated()

removeAttribute

public void removeAttribute(java.lang.String name)

Specified by:

removeAttribute in interface javax.servlet.sip.SipSession

See Also:

SipSession.removeAttribute(String)

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Specified by:

setAttribute in interface javax.servlet.sip.SipSession

See Also:

SipSession.setAttribute(String, Object)

putAttribute

public void putAttribute(java.lang.String name,
                         java.lang.Object value)

setHandler

public void setHandler(java.lang.String name)
                throws javax.servlet.ServletException

Specified by:

setHandler in interface javax.servlet.sip.SipSession

Throws:

javax.servlet.ServletException

See Also:

SipSession.setHandler(String)

setInvalidateWhenReady

public void setInvalidateWhenReady(boolean invalidateWhenReady)

Specified by:

setInvalidateWhenReady in interface javax.servlet.sip.SipSession

setOutboundInterface

public void setOutboundInterface(java.net.InetSocketAddress address)

Specified by:

setOutboundInterface in interface javax.servlet.sip.SipSession

setOutboundInterface

public void setOutboundInterface(java.net.InetAddress address)

Specified by:

setOutboundInterface in interface javax.servlet.sip.SipSession

addServerTransaction

public void addServerTransaction(ServerTransaction transaction)

removeTransaction

public void removeTransaction(Transaction transaction)

getServerTransactions

public java.util.List<ServerTransaction> getServerTransactions()

addClientTransaction

public void addClientTransaction(ClientTransaction transaction)

getClientTransactions

public java.util.List<ClientTransaction> getClientTransactions()

setSubscriberURI

public void setSubscriberURI(javax.servlet.sip.URI uri)

setRegion

public void setRegion(javax.servlet.sip.ar.SipApplicationRoutingRegion region)

getUa

public Session.DialogInfo getUa()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getSession

public Session getSession()

Specified by:

getSession in interface SessionManager.SipSessionIf

dump

public java.lang.String dump()

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

dump

public void dump(java.lang.Appendable out,
                 java.lang.String indent)
          throws java.io.IOException

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

Throws:

java.io.IOException