javax.servlet.sip.ar
Class SipApplicationRoutingRegion

java.lang.Object
  extended by javax.servlet.sip.ar.SipApplicationRoutingRegion
All Implemented Interfaces:
java.io.Serializable

public class SipApplicationRoutingRegion
extends java.lang.Object
implements java.io.Serializable

A class that represents the application routing region. It uses the predefined regions in the Enum SipApplicationRoutingRegionType and also allows for implementations to have additional or new regions if it is so required. This could be useful in non telephony domains where the concept of of a caller and callee is not applicable.

Since:
1.1
See Also:
Serialized Form

Field Summary
static SipApplicationRoutingRegion NEUTRAL_REGION
          The NEUTRAL region contains applications that do not service a specific subscriber.
static SipApplicationRoutingRegion ORIGINATING_REGION
          The ORIGINATING region contains applications that service the caller.
static SipApplicationRoutingRegion TERMINATING_REGION
          The TERMINATING region contains applications that service the callee.
 
Constructor Summary
SipApplicationRoutingRegion(java.lang.String label, SipApplicationRoutingRegionType type)
          Deployer may define new routing region by constructing a new SipApplicationRoutingRegion object.
 
Method Summary
 java.lang.String getLabel()
          Each routing region has a String label.
 SipApplicationRoutingRegionType getType()
          Each routing region is either ORIGINATING, TERMINATING, or NEUTRAL type.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ORIGINATING_REGION

public static final SipApplicationRoutingRegion ORIGINATING_REGION
The ORIGINATING region contains applications that service the caller.


TERMINATING_REGION

public static final SipApplicationRoutingRegion TERMINATING_REGION
The TERMINATING region contains applications that service the callee.


NEUTRAL_REGION

public static final SipApplicationRoutingRegion NEUTRAL_REGION
The NEUTRAL region contains applications that do not service a specific subscriber.

Constructor Detail

SipApplicationRoutingRegion

public SipApplicationRoutingRegion(java.lang.String label,
                                   SipApplicationRoutingRegionType type)
Deployer may define new routing region by constructing a new SipApplicationRoutingRegion object. The SipApplicationRoutingRegionType may be null in cases when a custom region is defined.

Method Detail

getLabel

public java.lang.String getLabel()
Each routing region has a String label.

Returns:
The label of the routing region

getType

public final SipApplicationRoutingRegionType getType()
Each routing region is either ORIGINATING, TERMINATING, or NEUTRAL type.

Returns:
The routing region type, a null return indicates a custom region.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object