Package org.jainslee.resources.sip

Interface OutgoingSipRequest

All Superinterfaces:

SipMessage, SipRequest

public interface OutgoingSipRequest
extends SipRequest

Represents an outgoing SIP request and it's underlying client transaction.

Field Summary

Fields inherited from interface org.jainslee.resources.sip.SipRequest

ACK, BYE, CANCEL, INFO, INVITE, MESSAGE, NOTIFY, OPTIONS, PRACK, PUBLISH, REFER, REGISTER, SUBSCRIBE, UPDATE

Method Summary

Modifier and Type	Method	Description
OutgoingSipRequest	createCancel()
IncomingSipResponse	getFinalResponse()	Gets the final response that was received in response to this request.
IncomingSipRequest	getOriginalRequest()	If this request was created using SipSession.createRequest(IncomingSipRequest) or SipFactory.createRequest(IncomingSipRequest,boolean), this method allows the app to retrieve the original incoming request that this request was created from.
boolean	is503SuppressionEnabled()	Determine if 503 suppression is been enabled for this request.
void	send()
void	suppress503Responses(boolean suppress)	Enable or disable suppression of 503 responses to this request.

Methods inherited from interface org.jainslee.resources.sip.SipMessage

addAcceptLanguage, addAddressHeader, addHeader, addHeaderGeneric, addParameterableHeader, getAcceptLanguage, getAcceptLanguages, getAddressHeader, getAddressHeaders, getCallId, getCharacterEncoding, getContent, getContentLanguage, getContentLength, getContentType, getExpires, getFrom, getHeader, getHeaderGeneric, getHeaderNames, getHeaders, getHeadersGeneric, getLocalAddr, getLocalPort, getMethod, getParameterableHeader, getParameterableHeaders, getProtocol, getRawContent, getRemoteAddr, getRemotePort, getRemoteUser, getSequenceNumber, getSession, getSession, getTo, getTransport, getUserPrincipal, isCommitted, isExtensionRequired, isExtensionSupported, isSecure, isUserInRole, removeHeader, setAcceptLanguage, setAddressHeader, setCharacterEncoding, setContent, setContentLanguage, setContentType, setExpires, setHeader, setHeaderGeneric, setParameterableHeader

Methods inherited from interface org.jainslee.resources.sip.SipRequest

getMaxForwards, getRequestURI, isInitial, pushRoute, pushRoute, setMaxForwards, setRequestURI

Method Detail

createCancel

OutgoingSipRequest createCancel()
                         throws IllegalStateException

Throws:

IllegalStateException

send

void send()
   throws IOException

Throws:

IOException

getOriginalRequest

IncomingSipRequest getOriginalRequest()

If this request was created using SipSession.createRequest(IncomingSipRequest) or SipFactory.createRequest(IncomingSipRequest,boolean), this method allows the app to retrieve the original incoming request that this request was created from. This is a convenience method for B2BUAs.

Returns:

the original incoming request, which this request was created from, or null if this request was not created from another request.

Since:

EasySIP 1.0 - no equivalent in SIP Servlet API

getFinalResponse

IncomingSipResponse getFinalResponse()

Gets the final response that was received in response to this request.

Specified by:

getFinalResponse in interface SipRequest

Returns:

the final response, or null if no response has been received yet.

Since:

EasySIP 1.2

suppress503Responses

void suppress503Responses(boolean suppress)

Enable or disable suppression of 503 responses to this request. If enabled, 503 responses will be converted to 500 before being delivered to the service. This is to avoid redundant retries towards other SIS nodes by the upstream client. The default is disabled (leave 503 responses unchanged) which may be changed using the Suppress503Responses config property. This method overrides the Suppress503Responses config property.

Parameters:

suppress - true to suppress 503 responses for this request, false to leave them unchanged.

is503SuppressionEnabled

boolean is503SuppressionEnabled()

Determine if 503 suppression is been enabled for this request. Will be true if suppress503Responses(true) has been called, or the RA config property Suppress503Responses is true.