javax.servlet.sip.ar
Class SipApplicationRouterInfo

java.lang.Object
  javax.servlet.sip.ar.SipApplicationRouterInfo

public class SipApplicationRouterInfo
extends Object

The SipApplicationRouterInfo class encapsulates the different pieces of information that the application router returns to the container when the container calls the SipApplicationRouter.getNextApplication() method.

Since:

1.1

Constructor Summary

SipApplicationRouterInfo(String nextApplicationName, SipApplicationRoutingRegion routingRegion, String subscriberURI, String[] routes, SipRouteModifier mod, Serializable stateInfo)
Creates a SipApplicationRouterInfo object containing the information necessary for the conatiner to perform its routing decision.

Method Summary

String	getNextApplicationName()
SipRouteModifier	getRouteModifier()
String[]	getRoutes() An array of SIP routes of the same type (internal or external).
SipApplicationRoutingRegion	getRoutingRegion()
Serializable	getStateInfo()
String	getSubscriberURI()

Methods inherited from class java.lang.Object

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

Constructor Detail

SipApplicationRouterInfo

public SipApplicationRouterInfo(String nextApplicationName,
                                SipApplicationRoutingRegion routingRegion,
                                String subscriberURI,
                                String[] routes,
                                SipRouteModifier mod,
                                Serializable stateInfo)

Creates a SipApplicationRouterInfo object containing the information necessary for the conatiner to perform its routing decision.

Parameters:

nextApplicationName - The name of the application that the application router selects to service this request. If no further application is needed in the current region, this is set to null.

subscriberURI - The URI that the application is selected to serve

route - The route header that could either be an external or internal route, the internal route replaces the route popped by the container

mod - An enum modifier which qualifies the route returned and the router behavior

stateInfo - Arbitrary state information of the application router that it wishes the container to store on its behalf

Method Detail

getNextApplicationName

public String getNextApplicationName()

getRoutes

public String[] getRoutes()

An array of SIP routes of the same type (internal or external). If the top (first) is external, they are to be used by the container to route the request to the external entities. The container pushes the external routes onto the request by iterating over the array starting with the last element until the top (first) element, inclusive. If the top (first) route is internal, it indicates the route which led the request to the container. This internal route is not used for any routing purposes but to let application router potentially modify the route popped by the container. Only the first internal route from the array is used for this purpose, the rest (if any) are ignored by the container.

Returns:

The SIP route headers which could be internal or external. An empty array is returned when no routes are present.

getRouteModifier

public SipRouteModifier getRouteModifier()

getRoutingRegion

public SipApplicationRoutingRegion getRoutingRegion()

getStateInfo

public Serializable getStateInfo()

getSubscriberURI

public String getSubscriberURI()