javax.sip.address
Interface Router

public interface Router

The Router interface defines accessor methods to retrieve the default Route and Outbound Proxy of this SipStack. The Outbound Proxy and default Route are made up one or more Hop's. This Router information is user-defined in an object that implements this interface. The location of the user-defined Router object is supplied in the Properties object passed to the SipFactory.createSipStack(Properties) method upon creation of the SIP Stack object. The Router object must accept a SipStack as an argument to the constructor in order for the Router to access attributes of the SipStack such as IP Address. The constructor of an object implementing the Router interface must be RouterImpl(SipStack sipStack, String outboundProxy) {}

The user may define a routing policy dependent on the operation of the SipStack i.e. user agent or proxy, however this routing policy can not be changed dynamically, i.e. the SipStack needs to be deleted and re-created.

Since:

1.1

Method Summary

java.util.ListIterator	getNextHops(Request request) Gets the ListIterator of the hops of the default Route.
Hop	getOutboundProxy() Gets the Outbound Proxy parameter of this Router, this method may return null if no outbound proxy is defined.

Method Detail

getOutboundProxy

public Hop getOutboundProxy()

Gets the Outbound Proxy parameter of this Router, this method may return null if no outbound proxy is defined.

Returns:

the Outbound Proxy of this Router.

See Also:

Hop

getNextHops

public java.util.ListIterator getNextHops(Request request)

Gets the ListIterator of the hops of the default Route. This method may return null if a default route is not defined.

Parameters:

request - - the Request message that determines the default route.

Returns:

the ListIterator over all the hops of this Router.

See Also:

Hop