org.mobicents.javax.servlet.sip
Interface SipServletRequestExt

All Superinterfaces:

java.lang.Cloneable, javax.servlet.ServletRequest, SipServletMessage, SipServletRequest

public interface SipServletRequestExt
extends SipServletRequest

Interface Extension that adds extra features to the JSR 289 SipServetRequest interface.
It adds the following capabilities :

• Allows for applications to copy the record route headers on the responses to subsequent INVITE requests where the dialog route set shouldn't normally be changed to cope with non compliant RFC 3261 servers.

Since:

1.5

Author:

jean.deruelle@gmail.com

Nested Class Summary

Nested classes/interfaces inherited from interface javax.servlet.sip.SipServletMessage

SipServletMessage.HeaderForm

Method Summary

SipServletResponse

createResponse(int statusCode, java.lang.String reasonPhrase, boolean copyRecordRouteHeaders) Creates a response for this request with the specified status code and reason phrase.

Methods inherited from interface javax.servlet.sip.SipServletRequest

addAuthHeader, addAuthHeader, createCancel, createResponse, createResponse, getB2buaHelper, getInitialPoppedRoute, getInputStream, getMaxForwards, getPoppedRoute, getProxy, getProxy, getReader, getRegion, getRequestURI, getRoutingDirective, getSubscriberURI, isInitial, pushPath, pushRoute, pushRoute, send, setMaxForwards, setRequestURI, setRoutingDirective

Methods inherited from interface javax.servlet.sip.SipServletMessage

addAcceptLanguage, addAddressHeader, addHeader, addParameterableHeader, getAcceptLanguage, getAcceptLanguages, getAddressHeader, getAddressHeaders, getApplicationSession, getApplicationSession, getAttribute, getAttributeNames, getCallId, getCharacterEncoding, getContent, getContentLanguage, getContentLength, getContentType, getExpires, getFrom, getHeader, getHeaderForm, getHeaderNames, getHeaders, getInitialRemoteAddr, getInitialRemotePort, getInitialTransport, getLocalAddr, getLocalPort, getMethod, getParameterableHeader, getParameterableHeaders, getProtocol, getRawContent, getRemoteAddr, getRemotePort, getRemoteUser, getSession, getSession, getTo, getTransport, getUserPrincipal, isCommitted, isSecure, isUserInRole, removeAttribute, removeHeader, setAcceptLanguage, setAddressHeader, setAttribute, setCharacterEncoding, setContent, setContentLanguage, setContentLength, setContentType, setExpires, setHeader, setHeaderForm, setParameterableHeader

Methods inherited from interface javax.servlet.ServletRequest

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding

Method Detail

createResponse

SipServletResponse createResponse(int statusCode,
                                  java.lang.String reasonPhrase,
                                  boolean copyRecordRouteHeaders)

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

Parameters:

statusCode - the status code for the response

reasonPhrase - reason phrase to appear in response line

copyRecordRouteHeaders - whether or not to copy the record route headers on the response to a subsequent INVITE request

Returns:

response object with specified status code and reason phrase and eventually the record route from the request copied in the response

Throws:

java.lang.IllegalArgumentException - if the statuscode is not a valid SIP status code

java.lang.IllegalStateException - if this request has already been responded to with a final status code