Package org.glassfish.grizzly.servlet

Class DispatchedHttpServletRequest

java.lang.Object

jakarta.servlet.ServletRequestWrapper

jakarta.servlet.http.HttpServletRequestWrapper

org.glassfish.grizzly.servlet.DispatchedHttpServletRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest

public class DispatchedHttpServletRequest
extends HttpServletRequestWrapper

Wrapper around a jakarta.servlet.http.HttpServletRequest that transforms an application request object (which might be the original one passed to a servlet.

Author:

Bongjae Chang

Field Summary

Fields

Modifier and Type	Field	Description
protected WebappContext	context	The context for this request.
protected String	contextPath	The context path for this request.
protected boolean	crossContext	If this request is cross context, since this changes session access behavior.
protected final DispatcherType	dispatcherType	The dispatcher type.
protected String	pathInfo	The path information for this request.
protected String	queryString	The query string for this request.
protected Object	requestDispatcherPath	The current request dispatcher path.
protected String	requestURI	The request URI for this request.
protected String	servletPath	The servlet path for this request.

Fields inherited from interface jakarta.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
DispatchedHttpServletRequest(HttpServletRequest request, WebappContext context, boolean crossContext, DispatcherType dispatcherType)	Construct a new wrapped request around the specified servlet request.

Method Summary

Modifier and Type	Method	Description
Object	getAttribute(String name)	Override the getAttribute() method of the wrapped request.
Enumeration<String>	getAttributeNames()	Override the getAttributeNames() method of the wrapped request.
String	getContextPath()	Override the getContextPath() method of the wrapped request.
DispatcherType	getDispatcherType()	Gets the dispatcher type of the wrapped request.
String	getParameter(String name)	Override the getParameter() method of the wrapped request.
Map<String,String[]>	getParameterMap()	Override the getParameterMap() method of the wrapped request.
Enumeration<String>	getParameterNames()	Override the getParameterNames() method of the wrapped request.
String[]	getParameterValues(String name)	Override the getParameterValues() method of the wrapped request.
String	getPathInfo()	Override the getPathInfo() method of the wrapped request.
String	getQueryString()	Override the getQueryString() method of the wrapped request.
RequestDispatcher	getRequestDispatcher(String path)	Return a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path.
HttpServletRequestImpl	getRequestFacade()
String	getRequestURI()	Override the getRequestURI() method of the wrapped request.
StringBuffer	getRequestURL()	Override the getRequestURL() method of the wrapped request.
String	getServletPath()	Override the getServletPath() method of the wrapped request.
protected boolean	isSpecial(String name)	Is this attribute name one of the special ones that is added only for included servlets?
protected String[]	mergeValues(Object values1, Object values2)	Merge the two sets of parameter values into a single String array.
void	recycle()
void	removeAttribute(String name)	Override the removeAttribute() method of the wrapped request.
void	setAttribute(String name, Object value)	Override the setAttribute() method of the wrapped request.

Methods inherited from class jakarta.servlet.http.HttpServletRequestWrapper

authenticate, changeSessionId, getAuthType, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathTranslated, getRemoteUser, getRequestedSessionId, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade

Methods inherited from class jakarta.servlet.ServletRequestWrapper

getAsyncContext, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, setCharacterEncoding, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jakarta.servlet.ServletRequest

getAsyncContext, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, setCharacterEncoding, startAsync, startAsync

Field Details

context

protected WebappContext context

The context for this request.

contextPath

protected String contextPath

The context path for this request.

crossContext

protected boolean crossContext

If this request is cross context, since this changes session access behavior.

dispatcherType

protected final DispatcherType dispatcherType

The dispatcher type.

pathInfo

protected String pathInfo

The path information for this request.

queryString

protected String queryString

The query string for this request.

requestDispatcherPath

protected Object requestDispatcherPath

The current request dispatcher path.

requestURI

protected String requestURI

The request URI for this request.

servletPath

protected String servletPath

The servlet path for this request.

Constructor Details

DispatchedHttpServletRequest

public DispatchedHttpServletRequest(HttpServletRequest request,
 WebappContext context,
 boolean crossContext,
 DispatcherType dispatcherType)

Construct a new wrapped request around the specified servlet request.

Parameters:

request - the servlet request being wrapped

dispatcherType - the dispatcher type

Method Details

getAttribute

public Object getAttribute(String name)

Override the getAttribute() method of the wrapped request.

Specified by:

getAttribute in interface ServletRequest

Overrides:

getAttribute in class ServletRequestWrapper

Parameters:

name - Name of the attribute to retrieve

Returns:

an Object containing the value of the attribute, or null if the attribute does not exist

getAttributeNames

public Enumeration<String> getAttributeNames()

Override the getAttributeNames() method of the wrapped request.

Specified by:

getAttributeNames in interface ServletRequest

Overrides:

getAttributeNames in class ServletRequestWrapper

Returns:

an Enumeration of strings containing the names of the request's attributes

removeAttribute

public void removeAttribute(String name)

Override the removeAttribute() method of the wrapped request.

Specified by:

removeAttribute in interface ServletRequest

Overrides:

removeAttribute in class ServletRequestWrapper

Parameters:

name - Name of the attribute to remove

setAttribute

public void setAttribute(String name,
 Object value)

Override the setAttribute() method of the wrapped request.

Specified by:

setAttribute in interface ServletRequest

Overrides:

setAttribute in class ServletRequestWrapper

Parameters:

name - Name of the attribute to set

value - Value of the attribute to set

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)

Return a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path.

Specified by:

getRequestDispatcher in interface ServletRequest

Overrides:

getRequestDispatcher in class ServletRequestWrapper

Parameters:

path - Path of the resource to be wrapped

Returns:

a RequestDispatcher object that acts as a wrapper for the resource at the specified path, or null if the servlet container cannot return a RequestDispatcher

See Also:

• RequestDispatcher
• ServletContext.getRequestDispatcher(java.lang.String)

getDispatcherType

public DispatcherType getDispatcherType()

Description copied from class: ServletRequestWrapper

Gets the dispatcher type of the wrapped request.

Specified by:

getDispatcherType in interface ServletRequest

Overrides:

getDispatcherType in class ServletRequestWrapper

Returns:

the dispatcher type of the wrapped request

See Also:

• ServletRequest.getDispatcherType()

getContextPath

public String getContextPath()

Override the getContextPath() method of the wrapped request.

Specified by:

getContextPath in interface HttpServletRequest

Overrides:

getContextPath in class HttpServletRequestWrapper

Returns:

a String specifying the portion of the request URI that indicates the context of the request. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them.

See Also:

• ServletContext.getContextPath()

getParameter

public String getParameter(String name)

Override the getParameter() method of the wrapped request.

Specified by:

getParameter in interface ServletRequest

Overrides:

getParameter in class ServletRequestWrapper

Parameters:

name - Name of the requested parameter

Returns:

a String representing the single value of the parameter

See Also:

• ServletRequest.getParameterValues(java.lang.String)

getParameterMap

public Map<String,String[]> getParameterMap()

Override the getParameterMap() method of the wrapped request.

Specified by:

getParameterMap in interface ServletRequest

Overrides:

getParameterMap in class ServletRequestWrapper

Returns:

an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.

getParameterNames

public Enumeration<String> getParameterNames()

Override the getParameterNames() method of the wrapped request.

Specified by:

getParameterNames in interface ServletRequest

Overrides:

getParameterNames in class ServletRequestWrapper

Returns:

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

getParameterValues

public String[] getParameterValues(String name)

Override the getParameterValues() method of the wrapped request.

Specified by:

getParameterValues in interface ServletRequest

Overrides:

getParameterValues in class ServletRequestWrapper

Parameters:

name - Name of the requested parameter

Returns:

an array of String objects containing the parameter's values

See Also:

• ServletRequest.getParameter(java.lang.String)

getPathInfo

public String getPathInfo()

Override the getPathInfo() method of the wrapped request.

Specified by:

getPathInfo in interface HttpServletRequest

Overrides:

getPathInfo in class HttpServletRequestWrapper

Returns:

a String specifying extra path information that comes after the servlet path but before the query string in the request URL; or null if the URL does not have any extra path information. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them.

getQueryString

public String getQueryString()

Override the getQueryString() method of the wrapped request.

Specified by:

getQueryString in interface HttpServletRequest

Overrides:

getQueryString in class HttpServletRequestWrapper

Returns:

a String containing the query string or null if the URL contains no query string. The value is not decoded by the container.

getRequestURI

public String getRequestURI()

Override the getRequestURI() method of the wrapped request.

Specified by:

getRequestURI in interface HttpServletRequest

Overrides:

getRequestURI in class HttpServletRequestWrapper

Returns:

a String containing the part of the URL from the protocol name up to the query string

getRequestURL

public StringBuffer getRequestURL()

Override the getRequestURL() method of the wrapped request.

Specified by:

getRequestURL in interface HttpServletRequest

Overrides:

getRequestURL in class HttpServletRequestWrapper

Returns:

a StringBuffer object containing the reconstructed URL

getServletPath

public String getServletPath()

Override the getServletPath() method of the wrapped request.

Specified by:

getServletPath in interface HttpServletRequest

Overrides:

getServletPath in class HttpServletRequestWrapper

Returns:

a String containing the path of the servlet being called, as specified in the request URL, or an empty string if the servlet used to process the request is matched using the "/*" pattern. The path will be canonicalized as per section 3.5 of the specification. This method will not return any encoded characters unless the container is configured specifically to allow them.

isSpecial

protected boolean isSpecial(String name)

Is this attribute name one of the special ones that is added only for included servlets?

Parameters:

name - Attribute name to be tested

mergeValues

protected String[] mergeValues(Object values1,
 Object values2)

Merge the two sets of parameter values into a single String array.

Parameters:

values1 - First set of values

values2 - Second set of values

recycle

public void recycle()

getRequestFacade

public HttpServletRequestImpl getRequestFacade()