org.mobicents.javax.servlet.sip

Interface SipSessionsUtilExt

All Superinterfaces:

SipSessionsUtil

public interface SipSessionsUtilExt
extends SipSessionsUtil

Interface Extension that adds extra features to the JSR 289 SipFactory interface to allow creation of Sip Application Session outside the scope of container managed threads.

Since:

7.0.2

Author:

jean.deruelle@telestax.com

Method Summary

Methods

Modifier and Type	Method and Description
SipApplicationSession	getApplicationSessionById(String applicationSessionId, boolean isContainerManaged) Returns the SipApplicationSession for a given applicationSessionId.
SipApplicationSession	getApplicationSessionByKey(String applicationSessionKey, boolean create, boolean isContainerManaged) Returns the SipApplicationSession for a given session applicationSessionKey.
void	scheduleAsynchronousWork(String sipApplicationSessionId, SipApplicationSessionAsynchronousWork work) This method allows an application to access a SipApplicationSession in an asynchronous manner.
void	scheduleAsynchronousWork(String sipSessionId, SipSessionAsynchronousWork work) This method allows an application to access a SipSession in an asynchronous manner.

Methods inherited from interface javax.servlet.sip.SipSessionsUtil

getApplicationSessionById, getApplicationSessionByKey, getCorrespondingSipSession

Method Detail

getApplicationSessionById

SipApplicationSession getApplicationSessionById(String applicationSessionId,
                                              boolean isContainerManaged)

Returns the SipApplicationSession for a given applicationSessionId. The applicationSessionId String is the same as that obtained through SipApplicationSession.getId(). The method shall return the Application Session only if the queried application session belongs to the application from where this method is invoked. As an example if there exists a SIP Application with some J2EE component like a Message Driven Bean, bundled in the same application archive file (.war), then if the id of SipApplicationSession is known to the MDB it can get a reference to the SipApplicationSession object using this method. If this MDB were in a different application then it would not possible for it to access the SipApplicationSession. The method returns null in case the container does not find the SipApplicationSession instance matching the ID.

Parameters:

isContainerManaged - whether or not the container should bind and lock the sip application session in the same thread as the one that created it

Returns:

SipApplicationSession object

Since:

7.0.2

getApplicationSessionByKey

SipApplicationSession getApplicationSessionByKey(String applicationSessionKey,
                                               boolean create,
                                               boolean isContainerManaged)

Returns the SipApplicationSession for a given session applicationSessionKey. The applicationSessionKey String is the same as that supplied to SipFactory#createApplicationSessionByKey. The method shall return the Application Session only if the queried application session belongs to the application from where this method is invoked. The method returns null in case the container does not find the SipApplicationSession instance matching the applicationSessionKey.

Parameters:

applicationSessionKey - session applicationSessionKey of the SipApplicationSession

create - controls whether new session should be created upon lookup failure

isContainerManaged - whether or not the container should bind and lock the sip application session in the same thread as the one that created it

Returns:

SipApplicationSession object or a null if it is not found and create is set to false. If create is true, create a new SipApplicationSession with the given applicationSessionKey

Throws:

NullPointerException - if the applicationSessionKey is null.

Since:

7.0.2

scheduleAsynchronousWork

void scheduleAsynchronousWork(String sipSessionId,
                            SipSessionAsynchronousWork work)

This method allows an application to access a SipSession in an asynchronous manner. This method is useful for accessing the SipSession from Web or EJB modules in a converged application or from unmanaged threads started by the application itself. When this API is used in conjunction with the Mobicents Concurrency Control in SipSession mode, the container guarantees that the business logic contained within the SipSessionAsynchronousWork will be executed in a thread-safe manner. It has to be noted that the work may never execute if the session gets invalidated in the meantime and the work will be executed locally on the node on a cluster.

Parameters:

work - the work to be performed on this SipSession.

scheduleAsynchronousWork

void scheduleAsynchronousWork(String sipApplicationSessionId,
                            SipApplicationSessionAsynchronousWork work)

This method allows an application to access a SipApplicationSession in an asynchronous manner. This method is useful for accessing the SipApplicationSession from Web or EJB modules in a converged application or from unmanaged threads started by the application itself. When this API is used in conjunction with the Mobicents Concurrency Control in SipApplicationSession mode, the container guarantees that the business logic contained within the SipApplicationSessionAsynchronousWork will be executed in a thread-safe manner. It has to be noted that the work may never execute if the session gets invalidated in the meantime and the work will be executed locally on the node on a cluster.

Parameters:

work - the work to be performed on this SipApplicationSession.