org.mobicents.javax.servlet.sip

Interface SipServletRequestExt

All Superinterfaces:

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 :

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

Methods

Modifier and Type	Method and Description
void	addAuthHeader(SipServletResponse challengeResponse, AuthInfo authInfo, boolean cacheCredentials) This method allows the addition of the appropriate authentication header(s) to the request that was challenged with a challenge response. It allows also to cache the credentials so that if a response containing an Authentication-Info header with a nextnonce, the credentials can be reused to generate the correct header
void	addAuthHeader(SipServletResponse challengeResponse, String username, String password, boolean cacheCredentials) This method allows the addition of the appropriate authentication header(s) to the request that was challenged with a challenge response without needing the creation and/or maintenance of the AuthInfo object. It allows also to cache the credentials so that if a response containing an Authentication-Info header with a nextnonce, the credentials can be reused to generate the correct header
boolean	isOrphan() This flag indicates that the sessions for this request has been lost.
void	setOrphan(boolean orphan) This flag indicates that the sessions for this request has been lost.

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

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

Method Detail

addAuthHeader

void addAuthHeader(SipServletResponse challengeResponse,
                 AuthInfo authInfo,
                 boolean cacheCredentials)

This method allows the addition of the appropriate authentication header(s) to the request that was challenged with a challenge response.
It allows also to cache the credentials so that if a response containing an Authentication-Info header with a nextnonce, the credentials can be reused to generate the correct header

Parameters:

challengeResponse - The challenge response (401/407) receieved from a UAS/Proxy.

authInfo - The AuthInfo object that will add the Authentication headers to the request.

cacheCredentials - true if the user's credentials should be cached

addAuthHeader

void addAuthHeader(SipServletResponse challengeResponse,
                 String username,
                 String password,
                 boolean cacheCredentials)

This method allows the addition of the appropriate authentication header(s) to the request that was challenged with a challenge response without needing the creation and/or maintenance of the AuthInfo object.
It allows also to cache the credentials so that if a response containing an Authentication-Info header with a nextnonce, the credentials can be reused to generate the correct header

Parameters:

challengeResponse - the challenge response (401/407) receieved from a UAS/Proxy.

username - username

password - password

cacheCredentials - true if the user's credentials should be cached for that realm

isOrphan

boolean isOrphan()

This flag indicates that the sessions for this request has been lost. getSession and getApplicationSession() will return null and these request will just be proxied outside the container. This feature can only work for proxy applications with main-servlet declarations. This feature is enabled by the setRouteOrphanRequests method in SipFactoryExt.

Returns:

setOrphan

void setOrphan(boolean orphan)

This flag indicates that the sessions for this request has been lost. getSession and getApplicationSession() will return null and these request will just be proxied outside the container. This feature can only work for proxy applications with main-servlet declarations. This feature is enabled by the setRouteOrphanRequests method in SipFactoryExt.