org.mobicents.servlet.sip.core.dispatchers

Class MessageDispatcher

java.lang.Object

org.mobicents.servlet.sip.core.dispatchers.MessageDispatcher

Direct Known Subclasses:

RequestDispatcher, ResponseDispatcher

public abstract class MessageDispatcher
extends Object

Author:

Jean Deruelle

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_ID
static String	BRANCH_MAGIC_COOKIE
static String	ROUTE_PARAM_DIRECTIVE
static String	ROUTE_PARAM_NODE_HOST
static String	ROUTE_PARAM_NODE_PORT
static String	ROUTE_PARAM_PREV_APP_ID
static String	ROUTE_PARAM_PREV_APPLICATION_NAME
static String	ROUTE_PARAM_REGION_LABEL
static String	ROUTE_PARAM_REGION_TYPE
static String	RR_PARAM_APPLICATION_NAME
static String	RR_PARAM_PROXY_APP
static String	RR_PARAM_SERVER_NAME
static String	SIP_OUTBOUND_PARAM_OB From RFC 5626: "The "ob" parameter is a SIP URI parameter that has a different meaning depending on context.
static String	SIP_OUTBOUND_PARAM_REG_ID
protected SipApplicationDispatcher	sipApplicationDispatcher

Constructor Summary

Constructors

Constructor and Description
MessageDispatcher()

Method Summary

Methods

Modifier and Type	Method and Description
static void	callServlet(MobicentsSipServletRequest request)
static void	callServlet(MobicentsSipServletResponse response)
static void	callServletForOrphanRequest(SipContext sipContext, SipServletRequestImpl request)
static void	callServletForOrphanResponse(SipContext sipContext, SipServletResponse response)
abstract void	dispatchMessage(javax.sip.SipProvider sipProvider, SipServletMessageImpl sipServletMessage) Responsible for routing and dispatching a SIP message to the correct application
ExecutorService	getConcurrencyModelExecutorService(SipContext sipContext, SipServletMessageImpl sipServletMessage) This method return an ExecutorService depending on the current concurrency strategy.
protected static SipApplicationSessionKey	makeAppSessionKey(SipContext sipContext, SipServletRequestImpl sipServletRequestImpl, String applicationName)
static boolean	securityCheck(MobicentsSipServletRequest request)
static void	sendErrorResponse(int errorCode, javax.sip.ServerTransaction transaction, javax.sip.message.Request request, javax.sip.SipProvider sipProvider)
static void	sendErrorResponse(int errorCode, SipServletRequestImpl sipServletRequest, javax.sip.SipProvider sipProvider)

Methods inherited from class java.lang.Object

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

Field Detail

ROUTE_PARAM_DIRECTIVE

public static final String ROUTE_PARAM_DIRECTIVE

See Also:

Constant Field Values

ROUTE_PARAM_REGION_LABEL

public static final String ROUTE_PARAM_REGION_LABEL

See Also:

Constant Field Values

ROUTE_PARAM_REGION_TYPE

public static final String ROUTE_PARAM_REGION_TYPE

See Also:

Constant Field Values

ROUTE_PARAM_PREV_APPLICATION_NAME

public static final String ROUTE_PARAM_PREV_APPLICATION_NAME

See Also:

Constant Field Values

ROUTE_PARAM_PREV_APP_ID

public static final String ROUTE_PARAM_PREV_APP_ID

See Also:

Constant Field Values

RR_PARAM_SERVER_NAME

public static final String RR_PARAM_SERVER_NAME

See Also:

Constant Field Values

RR_PARAM_APPLICATION_NAME

public static final String RR_PARAM_APPLICATION_NAME

See Also:

Constant Field Values

RR_PARAM_PROXY_APP

public static final String RR_PARAM_PROXY_APP

See Also:

Constant Field Values

BRANCH_MAGIC_COOKIE

public static final String BRANCH_MAGIC_COOKIE

See Also:

Constant Field Values

APP_ID

public static final String APP_ID

See Also:

Constant Field Values

ROUTE_PARAM_NODE_HOST

public static final String ROUTE_PARAM_NODE_HOST

See Also:

Constant Field Values

ROUTE_PARAM_NODE_PORT

public static final String ROUTE_PARAM_NODE_PORT

See Also:

Constant Field Values

sipApplicationDispatcher

protected SipApplicationDispatcher sipApplicationDispatcher

SIP_OUTBOUND_PARAM_OB

public static final String SIP_OUTBOUND_PARAM_OB

From RFC 5626: "The "ob" parameter is a SIP URI parameter that has a different meaning depending on context. In a Path header field value, it is used by the first edge proxy to indicate that a flow token was added to the URI. In a Contact or Route header field value, it indicates that the UA would like other requests in the same dialog to be routed over the same flow."

See Also:

Constant Field Values

SIP_OUTBOUND_PARAM_REG_ID

public static final String SIP_OUTBOUND_PARAM_REG_ID

See Also:

Constant Field Values

Constructor Detail

MessageDispatcher

public MessageDispatcher()

Method Detail

sendErrorResponse

public static void sendErrorResponse(int errorCode,
                     SipServletRequestImpl sipServletRequest,
                     javax.sip.SipProvider sipProvider)

sendErrorResponse

public static void sendErrorResponse(int errorCode,
                     javax.sip.ServerTransaction transaction,
                     javax.sip.message.Request request,
                     javax.sip.SipProvider sipProvider)

Parameters:

errorCode -

transaction -

request -

sipProvider -

makeAppSessionKey

protected static SipApplicationSessionKey makeAppSessionKey(SipContext sipContext,
                                         SipServletRequestImpl sipServletRequestImpl,
                                         String applicationName)
                                                     throws DispatcherException

Throws:

DispatcherException

callServletForOrphanRequest

public static void callServletForOrphanRequest(SipContext sipContext,
                               SipServletRequestImpl request)
                                        throws DispatcherException,
                                               javax.servlet.ServletException,
                                               IOException

Throws:

DispatcherException

javax.servlet.ServletException

IOException

callServletForOrphanResponse

public static void callServletForOrphanResponse(SipContext sipContext,
                                SipServletResponse response)
                                         throws DispatcherException,
                                                javax.servlet.ServletException,
                                                IOException

Throws:

DispatcherException

javax.servlet.ServletException

IOException

callServlet

public static void callServlet(MobicentsSipServletRequest request)
                        throws javax.servlet.ServletException,
                               IOException

Throws:

javax.servlet.ServletException

IOException

callServlet

public static void callServlet(MobicentsSipServletResponse response)
                        throws javax.servlet.ServletException,
                               IOException

Throws:

javax.servlet.ServletException

IOException

securityCheck

public static boolean securityCheck(MobicentsSipServletRequest request)

dispatchMessage

public abstract void dispatchMessage(javax.sip.SipProvider sipProvider,
                   SipServletMessageImpl sipServletMessage)
                              throws DispatcherException

Responsible for routing and dispatching a SIP message to the correct application

Parameters:

sipProvider - use the sipProvider to route the message if needed, can be null

sipServletMessage - the SIP message to route and dispatch

Throws:

Exception - if anything wrong happens

DispatcherException

getConcurrencyModelExecutorService

public final ExecutorService getConcurrencyModelExecutorService(SipContext sipContext,
                                                 SipServletMessageImpl sipServletMessage)

This method return an ExecutorService depending on the current concurrency strategy. It can return the executor of a sip session, app session or just threadpool executor which doesn't limit concurrent processing of requests per app or sip session. Since 0.8.1 it always return threadpool executor which doesn't limit concurrent processing since concurrency is achieved through semaphore

Parameters:

sipServletMessage - the request you put here must have app and sip session associated

Returns: