BEA WebLogic SIP Server 3.0 API Reference

com.bea.wcp.sip
Interface WlssProxy

All Superinterfaces:

Proxy

public interface WlssProxy

extends Proxy

This class is a WebLogic SIP Server specific extension of the interface javax.servlet.sip.Proxy. It adds the functionality required to support the Path header, RFC 3327. This extension adds a parameter :

addToPath:

Whether to add this Proxy URI in the Path header to the REGISTER. The defualt is false.

The effect of this parameters is explained further below.

Copyright © 2006 BEA Systems, Inc. All Rights Reserved.

Method Summary

boolean	getAddToPath() Returns true if subsequent invocations of proxyTo(URI) will add a Path header to the proxied request, false otherwise.
SipURI	getPathURI() Returns a SipURI that the application can use to add parameters to the Path header.
void	setAddToPath(boolean p) Specifies whether branches initiated in this proxy operation should include a Path header for the REGISTER request for this servlet engine or not.

Methods inherited from interface javax.servlet.sip.Proxy

cancel, getOriginalRequest, getParallel, getRecordRoute, getRecordRouteURI, getRecurse, getSequentialSearchTimeout, getStateful, getSupervised, proxyTo, proxyTo, setParallel, setRecordRoute, setRecurse, setSequentialSearchTimeout, setStateful, setSupervised

Method Detail

getAddToPath

public boolean getAddToPath()

Returns true if subsequent invocations of proxyTo(URI) will add a Path header to the proxied request, false otherwise.

Returns:

value of the "addToPath" flag

getPathURI

public SipURI getPathURI()

Returns a SipURI that the application can use to add parameters to the Path header. This may be used by Path header adding proxy applications in order to push state to the Registar and have it returned in subsequent requests for the Registerd UA.

Parameters added through a URI returned by this method can be retrieved from a subsequent request in the same dialog by calling ServletRequest.getParameter(java.lang.String).

Note that the URI returned is good only for specifying a set of parameters that the application can retrieve when invoked to handle subsequent requests Other components of the URI are irrelevant and cannot be trusted to reflect the actual values that the container will be using when inserting a Path header into proxied request.

Returns:

SIP URI whose parameters can be modified and then retrieved by this application when processing subsequent requests for the UA

Throws:

java.lang.IllegalStateException - if addToPath is not enabled

setAddToPath

public void setAddToPath(boolean p)

Specifies whether branches initiated in this proxy operation should include a Path header for the REGISTER request for this servlet engine or not.

Path header is used to specify that this Proxy must stay on the signaling path of subsequent requests sent to the Registered UA from the Home Proxy in the network. The detailed procedure of Path header handling is defined in RFC 3327.

Parameters:

p - if true the engine will add Path header, otherwise it won't