Skip navigation links

com.convergin.common.sal.ext.api
Interface SalRequest

All Superinterfaces:

java.lang.Cloneable, SalMessage

public interface SalRequest

extends SalMessage

Represents SAL request messages. When receiving an incoming SAL request the container creates a SalRequest and passes it to the handling SalApplication. For outgoing, locally initiated requests, applications call SalFactory.createRequest(SalApplicationSession, String, String, String) to obtain a SalRequest that can then be modified and sent.

Method Summary

SalRequest	createCancel() Returns a CANCEL request object.
SalResponse	createResponse(int statusCode) Creates a response for this request with the specifies status code.
SalResponse	createResponse(int statusCode, java.lang.String reasonPhrase) Creates a response for this request with the specifies status code and reason phrase.
B2buaHelper	getB2buaHelper() Returns the B2buaHelper associated with this request.
Address	getPoppedRoute() If a top route header had been removed by the container upon receiving this request, then this method can be used to retrieve it.
URI	getRequestURI() Returns the request URI of this request.
boolean	isInitial() Returns true if this is an initial request.
void	pushRoute(Address route) Adds a Route header field value to this request with Address argument.
void	pushRoute(SipURI route) Adds a Route header field value to this request.
void	send() Causes this request to be sent.
void	setRequestURI(URI reqUri) Sets the request URI of this request.

Methods inherited from interface com.convergin.common.sal.ext.api.SalMessage

addAddressHeader, addHeader, getAddressHeader, getAddressHeaders, getApplicationSession, getApplicationSession, getContent, getContentType, getFrom, getHeader, getHeaderNames, getHeaders, getMethod, getSession, getSession, getTo, removeHeader, setAddressHeader, setContent, setContentType, setHeader

Method Detail

getPoppedRoute

Address getPoppedRoute()

If a top route header had been removed by the container upon receiving this request, then this method can be used to retrieve it. Otherwise, if no route header had been popped then this method will return null.

Returns:

the popped top route header, or null if none

pushRoute

void pushRoute(Address route)

Adds a Route header field value to this request with Address argument. The new value is added ahead of any existing Route header fields. If this request does not already contains a Route header, one is added with the value as specified in the argument.

Parameters:

route -

getRequestURI

URI getRequestURI()

Returns the request URI of this request.

Returns:

request URI of this SalRequest

setRequestURI

void setRequestURI(URI reqUri)

Sets the request URI of this request. This then becomes the destination used in a subsequent invocation of send().

Parameters:

reqUri - new request URI of this SalRequest

pushRoute

void pushRoute(SipURI route)

Adds a Route header field value to this request. The new value is added ahead of any existing Route header fields. If this request does not already contains a Route header, one is added with the value as specified in the argument.

Parameters:

route - the address that is added as a Route header value

send

void send()
          throws java.io.IOException

Causes this request to be sent. This method is used by SAL application acting as user agent clients.

Throws:

java.io.IOException

isInitial

boolean isInitial()

Returns true if this is an initial request. An initial request is one that is dispatched to applications based on the containers configured rule set, as opposed to subsequent requests which are routed based on the application path established by a previous initial request.

Returns:

true if this is an initial request

createResponse

SalResponse createResponse(int statusCode)

Creates a response for this request with the specifies status code.

Parameters:

statusCode - status code for the response

Returns:

response object with specified status code

createResponse

SalResponse createResponse(int statusCode,
                           java.lang.String reasonPhrase)

Creates a response for this request with the specifies status code and reason phrase.

Parameters:

statusCode - status code for the response

reasonPhrase - reason phrase to appear in response line

Returns:

response object with specified status code and reason phrase

createCancel

SalRequest createCancel()

Returns a CANCEL request object. This method is used by SAL applications to cancel outstanding transactions for which they act as a user agent client (UAC). The CANCEL request is sent when the application invokes send() on it.

Returns:

CANCEL request object corresponding to this request

getB2buaHelper

B2buaHelper getB2buaHelper()

Returns the B2buaHelper associated with this request.

Returns:

the B2buaHelper for this request

Skip navigation links