Package com.opencloud.slee.resources.sis.script.sip.scs

Interface SipSCSActivity

All Superinterfaces:

SCSActivity

public interface SipSCSActivity
extends SCSActivity

Method Summary

Modifier and Type	Method	Description
void	forward(URI destination, Header... headers)	Forwards the request back to the network, but with a new destination address.
void	forward(Header... headers)	Forwards the request back to the network.
AddressFactory	getAddressFactory()	Get the JAIN SIP AddressFactory object, for creating SIP URIs and addresses for headers.
HeaderFactory	getHeaderFactory()	Get the JAIN SIP HeaderFactory object, for creating SIP headers to be used in responses.
boolean	isLocalSipURI(SipURI uri)	Determine if a URI is local to this SIS instance.
void	reject(int statusCode, String reasonPhrase, Header... headers)	Instruct the SIS to reject the request with an error response.

Methods inherited from interface com.opencloud.slee.resources.sis.script.scs.SCSActivity

compositionNotFound, compositionSelected, getEvent, getVariable

Method Detail

getAddressFactory

AddressFactory getAddressFactory()

Get the JAIN SIP AddressFactory object, for creating SIP URIs and addresses for headers.

Returns:

an AddressFactory instance.

getHeaderFactory

HeaderFactory getHeaderFactory()

Get the JAIN SIP HeaderFactory object, for creating SIP headers to be used in responses.

Returns:

an HeaderFactory instance.

isLocalSipURI

boolean isLocalSipURI(SipURI uri)

Determine if a URI is local to this SIS instance. This could be used by proxies to decide if a Route header in an incoming request should be removed because it refers to the local address.

Returns:

true if the host and port in the URI match an endpoint that this SIS instance is listening on, otherwise false.

forward

void forward(Header... headers)

Forwards the request back to the network. No composition is selected but the request will continue to its original destination. Additional headers may be added to the outgoing request. The routing headers Route and Record-Route will be ignored.

Parameters:

headers - an optional list of headers to be added to the outgoing request.

forward

void forward(URI destination,
             Header... headers)

Forwards the request back to the network, but with a new destination address. No composition is selected but the request will continue to its new destination. Additional headers may be added to the outgoing request. The routing headers Route and Record-Route will be ignored.

Parameters:

destination - a new destination URI for the request

headers - an optional list of headers to be added to the outgoing request.

reject

void reject(int statusCode,
            String reasonPhrase,
            Header... headers)

Instruct the SIS to reject the request with an error response.

Parameters:

statusCode - the status code of the response, must be in the range 300-699.

reasonPhrase - the reason phrase, may be null, in which case the default reason phrase for the status code will be used

headers - optional list of headers that will be inserted in the response