org.echarts.servlet.sip.appRouter.DFCRouterImpl
Class StateInfo

java.lang.Object
  extended by org.echarts.servlet.sip.appRouter.DFCRouterImpl.StateInfo

public class StateInfo
extends java.lang.Object

The StateInfo class represents a set of information that the DFC router implementation wishes to be persistent and associated with an initial request. This information is used by the router to know when the subscribing address has changed between two invocations of the router and to know which applications are yet to be invoked in the current region.

Author:
khp

Constructor Summary
StateInfo()
          Constructor to initialize the object
StateInfo(Address address, java.util.Vector<Application> routeSet)
          Another constructor that uses an Address and route set vector to initialize the StateInfo object
StateInfo(java.lang.String stateInfo)
          Constructor that initializes a StateInfo object from its String representation
 
Method Summary
 Application getNextApplication()
          Get the next application to be invoked from the StateInfo object.
 java.lang.String getPreviousAddress()
          Retrieve the previous address from the StateInfo object
 void popNextApplication()
          Pop the next application off the route set.
 java.lang.String toString()
          Represent the StateInfo object as a String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StateInfo

public StateInfo()
Constructor to initialize the object


StateInfo

public StateInfo(Address address,
                 java.util.Vector<Application> routeSet)
Another constructor that uses an Address and route set vector to initialize the StateInfo object

Parameters:
address - Address to be used in initializing the new StateInfo object
routeSet - Vector of applications to be used in initializing the new StateInfo object

StateInfo

public StateInfo(java.lang.String stateInfo)
Constructor that initializes a StateInfo object from its String representation

Parameters:
stateInfo - String representation of StateInfo object
Method Detail

toString

public java.lang.String toString()
Represent the StateInfo object as a String. Because this representation may be inserted by the container or adaptation layer into the SIP request message as the value of a header, we URLEncode parts of it.

Overrides:
toString in class java.lang.Object

getPreviousAddress

public java.lang.String getPreviousAddress()
Retrieve the previous address from the StateInfo object

Returns:
String String representation of the previous address information

getNextApplication

public Application getNextApplication()
Get the next application to be invoked from the StateInfo object.

Returns:
Application next application to be invoked. If there are no more applications in the list, returns null

popNextApplication

public void popNextApplication()
Pop the next application off the route set.