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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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 usingSipSession.createRequest(IncomingSipRequest)
orSipFactory.createRequest(IncomingSipRequest,boolean)
, this method allows the app to retrieve the original incoming request that this request was created from.void
send()
-
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 usingSipSession.createRequest(IncomingSipRequest)
orSipFactory.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 interfaceSipRequest
- Returns:
- the final response, or
null
if no response has been received yet. - Since:
- EasySIP 1.2
-
-