org.cafesip.sipexchange.inservice.shared
Class RerouteResponse

java.lang.Object
  extended by org.cafesip.sipexchange.inservice.shared.Response
      extended by org.cafesip.sipexchange.inservice.shared.RerouteResponse
All Implemented Interfaces:
java.io.Serializable

public class RerouteResponse
extends Response
implements java.io.Serializable

This class is returned by by the SCP as a response to an invocation to indicate that the call in question must be re-routed based on the information supplied by this object.

The setter methods are used by the SCP to set the attributes and the getter methods are used by SipExchange server to retrieve the attributes.

See Also:
Serialized Form

Constructor Summary
RerouteResponse()
          A constructor for this class.
 
Method Summary
 java.lang.String[] getContactAddresses()
          Getter method for the contact addresses.
 java.lang.String[] getRerouteAddresses()
          Getter method for the reroute addresses.
 boolean isRedirect()
          Getter method for the redirect option.
 void setContactAddresses(java.lang.String[] contactAddresses)
          Setter method for the contact addresses
 void setRedirect(boolean redirect)
          Setter for the redirect option.
 void setRerouteAddresses(java.lang.String[] rerouteAddresses)
          Setter method for the reroute addresses.
 
Methods inherited from class org.cafesip.sipexchange.inservice.shared.Response
getCdrs, setCdrs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RerouteResponse

public RerouteResponse()
A constructor for this class.

Method Detail

getContactAddresses

public java.lang.String[] getContactAddresses()
Getter method for the contact addresses. When the SCP sets the contact addresses, the SipExchange server uses these addresses to reroute the call to these addresses. The contact addresses are expected to by valid SIP locations with valid host name or IP addresses. The SipExchange server does not lookup the location database to retrieve the locations but these addresses serve as the location.

Returns:
the contact addresses.

setContactAddresses

public void setContactAddresses(java.lang.String[] contactAddresses)
Setter method for the contact addresses

Parameters:
contactAddresses - contact addresses to set.

getRerouteAddresses

public java.lang.String[] getRerouteAddresses()
Getter method for the reroute addresses. When the SCP sets the reroute addresses, the SupExchange server uses these addresses to to reroute the call to these addresses. The SipExchange server looks up the location database to translated these addresses into locations and uses the locations to reroute.

Returns:
the reroute addresses.

setRerouteAddresses

public void setRerouteAddresses(java.lang.String[] rerouteAddresses)
Setter method for the reroute addresses.

Parameters:
rerouteAddresses - the addresses to set.

isRedirect

public boolean isRedirect()
Getter method for the redirect option. If the SCP sets this redirect option to true, the SipExchange server sends a reroute response to the SCP. Otherwise, it forwards the call to the returned addresses or locations.

Returns:
the redirect option.

setRedirect

public void setRedirect(boolean redirect)
Setter for the redirect option.

Parameters:
redirect - true or false.


http://www.cafesip.org