org.mobicents.servlet.sip.core.session

Class SipSessionKey

java.lang.Object

org.mobicents.servlet.sip.core.session.SipSessionKey

All Implemented Interfaces:

Serializable, MobicentsSipSessionKey

public final class SipSessionKey
extends Object
implements MobicentsSipSessionKey, Serializable

Class representing the key (which will also be its id) for a sip session.
It is composed of the From Header parameter Tag, the To Header parameter tag, the Call-Id, the app session id and the application Name.

IT is maaped to the SIP Dialog from RFC3261 (from tag, to tag + call-ID)

It is to be noted that the To Header parameter Tag will not be used in SipSessionKey comparison (equals() and hashcode() methods).
It will only be used to check if a new derived sip session needs to be created.

Author:

Jean Deruelle

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SipSessionKey(String fromTag, String toTag, String callId, String applicationSessionId, String applicationName)

Method Summary

Methods

Modifier and Type	Method and Description
void	computeToString()
boolean	equals(Object obj)
String	getApplicationName()
String	getApplicationSessionId()
String	getCallId()
String	getFromTag()
String	getToTag()
int	hashCode()
void	setToString(String toString)
void	setToTag(String toTag, boolean recomputeSessionId) Sets the to tag on the key when we receive a response.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SipSessionKey

public SipSessionKey(String fromTag,
             String toTag,
             String callId,
             String applicationSessionId,
             String applicationName)

Parameters:

fromAddress -

fromTag -

toAddress -

toTag -

callId -

applicationSessionId -

applicationName -

Method Detail

getFromTag

public String getFromTag()

Specified by:

getFromTag in interface MobicentsSipSessionKey

Returns:

the fromTag

getToTag

public String getToTag()

Specified by:

getToTag in interface MobicentsSipSessionKey

Returns:

the toTag

getCallId

public String getCallId()

Specified by:

getCallId in interface MobicentsSipSessionKey

Returns:

the callId

getApplicationSessionId

public String getApplicationSessionId()

Specified by:

getApplicationSessionId in interface MobicentsSipSessionKey

Returns:

the applicationSessionId

getApplicationName

public String getApplicationName()

Specified by:

getApplicationName in interface MobicentsSipSessionKey

Returns:

the applicationName

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

setToTag

public void setToTag(String toTag,
            boolean recomputeSessionId)

Sets the to tag on the key when we receive a response. We recompute the session id only for derived session otherwise the id will change when the a request is received or sent and the response is sent back or received which should not happen See TCK test SipSessionListenerTest.testSessionDestroyed001

Specified by:

setToTag in interface MobicentsSipSessionKey

Parameters:

toTag - the toTag to set

recomputeSessionId - check if the sessionid need to be recomputed

setToString

public void setToString(String toString)

Parameters:

toString - the toString to set

computeToString

public void computeToString()