javax.servlet.sip

Interface ForkingContext

All Superinterfaces:

AttributeStore

public interface ForkingContext
extends AttributeStore

A ForkingContext ties together SipSessions that are related by forking of the same common SIP dialog. If a SIP dialog has forked, resulting in multiple SIP dialogs, each forked SIP dialog will be represented by a SipSession derived from the another. A ForkingContext links all of such SipSession siblings. A forking context will have one to many valid SipSessions associated with it.

Since:

2.0

See Also:

SipSession.getForkingContext()

Method Summary

Methods

Modifier and Type	Method and Description
SipServletRequest	createRequest(String method) Creates a new request with a new derived session on this ForkingContext.
Set<SipSession>	getSipSessions() An immutable Set of SipSession objects which are derived sessions on the same forking context.
boolean	isValid() A forking context will be valid as long as atleast one SipSession is valid.
void	terminateDialogs(AutomaticProcessingListener listener, SipSession... exclude) Terminates dialogs of all SipSession objects in this forking context.

Methods inherited from interface javax.servlet.sip.AttributeStore

clearAttributes, getAttribute, getAttributeNameSet, removeAttribute, setAttribute

Method Detail

getSipSessions

Set<SipSession> getSipSessions()

An immutable Set of SipSession objects which are derived sessions on the same forking context. Set should maintain the order in which the dialogs are established in the container.

Returns:

A Set of the SipSession objects.

Throws:

IllegalStateException - if this method is invoked on an invalid forking context.

terminateDialogs

void terminateDialogs(AutomaticProcessingListener listener,
                    SipSession... exclude)

Terminates dialogs of all SipSession objects in this forking context. Equivalent to invoking Session.terminateDialog on all SipSession objects obtained from getSipSessions method. The container will also terminate all derived sessions that belong to the same ForkingContext, created after executing this method. This method does not terminate dialogs that belong to a proxy application.

Parameters:

listener - Instance of AutomaticProcessingListener.

exclude - List of SipSession objects that will be excluded from terminating.

Throws:

IllegalStateException - if this method is invoked on an invalid forking context or the dialogs belong to a proxy application.

See Also:

AutomaticProcessingListener

isValid

boolean isValid()

A forking context will be valid as long as atleast one SipSession is valid.

Returns:

True if any one of the SipSessions objects in this forking context is valid.

createRequest

SipServletRequest createRequest(String method)

Creates a new request with a new derived session on this ForkingContext. This method may only be used to create the requests that establish a new forked dialog. At the time of writing this, NOTIFY method as specified by RFC 6665 is the only method that establish a new forked dialog.

Parameters:

method - the SIP method of the new request

Returns:

the new request object with method, request URI, and From, To, Call-ID, CSeq, Route, Via, Max-Forwards and Allow headers filled in.

Throws:

IllegalArgumentException - if method does not establish a new forked dialog.

IllegalStateException - If the forking context represents proxy sessions.