Tomcat 10.1.19 · org.apache.catalina.core.ApplicationHttpRequest

Modifier and Type	Class and Description
protected class	ApplicationHttpRequest.AttributeNamesEnumerator Utility class used to expose the special attributes as being available as request attributes.

Modifier and Type	Field and Description
protected final Context	context The context for this request.
protected String	contextPath The context path for this request.
protected final boolean	crossContext If this request is cross context, since this changes session access behavior.
protected DispatcherType	dispatcherType The current dispatcher type.
private HttpServletMapping	mapping The mapping for this request.
protected Map<String, String[]>	parameters The request parameters for this request.
private boolean	parsedParams Have the parameters for this request already been parsed?
protected String	pathInfo The path information for this request.
private String	queryParamString The query parameters for the current 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.
protected Session	session The currently active session for this request.
private static final int	shortestSpecialNameLength
private static final StringManager	sm
protected final Object[]	specialAttributes Special attributes.
protected static final String[]	specials The set of attribute names that are special for request dispatchers.
private static final int	SPECIALS_FIRST_FORWARD_INDEX
private static final Map<String, Integer>	specialsMap

Access	Constructor and Description
pack-priv	ApplicationHttpRequest(HttpServletRequest The servlet request being wrapped request, Context The target context for the wrapped request context, boolean `true` if the wrapped request will be a cross-context request, otherwise `false` crossContext) Construct a new wrapped request around the specified servlet request.

Method Summary

Modifier and Type	Method and Description
public Object	getAttribute(String Name of the attribute to retrieve name) Overrides jakarta.servlet.ServletRequestWrapper.getAttribute. Implements jakarta.servlet.ServletRequest.getAttribute. Override the `getAttribute()` method of the wrapped request.
public Enumeration<String>	getAttributeNames() Overrides jakarta.servlet.ServletRequestWrapper.getAttributeNames. Implements jakarta.servlet.ServletRequest.getAttributeNames. Override the `getAttributeNames()` method of the wrapped request.
public String	getContextPath() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getContextPath. Implements jakarta.servlet.http.HttpServletRequest.getContextPath. Override the `getContextPath()` method of the wrapped request.
public DispatcherType	getDispatcherType() Overrides jakarta.servlet.ServletRequestWrapper.getDispatcherType. Implements jakarta.servlet.ServletRequest.getDispatcherType. Override the getDispatcherType() method of the wrapped request.
public HttpServletMapping	getHttpServletMapping() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getHttpServletMapping. Overrides default jakarta.servlet.http.HttpServletRequest.getHttpServletMapping. The default behavior of this method is to return `HttpServletRequest#getHttpServletMapping()` on the wrapped request object.
public String	getParameter(String Name of the requested parameter name) Overrides jakarta.servlet.ServletRequestWrapper.getParameter. Implements jakarta.servlet.ServletRequest.getParameter. Override the `getParameter()` method of the wrapped request.
public Map<String, String[]>	getParameterMap() Overrides jakarta.servlet.ServletRequestWrapper.getParameterMap. Implements jakarta.servlet.ServletRequest.getParameterMap. Override the `getParameterMap()` method of the wrapped request.
public Enumeration<String>	getParameterNames() Overrides jakarta.servlet.ServletRequestWrapper.getParameterNames. Implements jakarta.servlet.ServletRequest.getParameterNames. Override the `getParameterNames()` method of the wrapped request.
public String[]	getParameterValues(String Name of the requested parameter name) Overrides jakarta.servlet.ServletRequestWrapper.getParameterValues. Implements jakarta.servlet.ServletRequest.getParameterValues. Override the `getParameterValues()` method of the wrapped request.
public String	getPathInfo() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getPathInfo. Implements jakarta.servlet.http.HttpServletRequest.getPathInfo. Override the `getPathInfo()` method of the wrapped request.
public String	getPathTranslated() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getPathTranslated. Implements jakarta.servlet.http.HttpServletRequest.getPathTranslated. Override the `getPathTranslated()` method of the wrapped request.
public String	getQueryString() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getQueryString. Implements jakarta.servlet.http.HttpServletRequest.getQueryString. Override the `getQueryString()` method of the wrapped request.
public RequestDispatcher	getRequestDispatcher(String Path of the resource to be wrapped path) Overrides jakarta.servlet.ServletRequestWrapper.getRequestDispatcher. Implements jakarta.servlet.ServletRequest.getRequestDispatcher. Return a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path.
public String	getRequestURI() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getRequestURI. Implements jakarta.servlet.http.HttpServletRequest.getRequestURI. Override the `getRequestURI()` method of the wrapped request.
public StringBuffer	getRequestURL() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getRequestURL. Implements jakarta.servlet.http.HttpServletRequest.getRequestURL. Override the `getRequestURL()` method of the wrapped request.
public ServletContext	getServletContext() Overrides jakarta.servlet.ServletRequestWrapper.getServletContext. Implements jakarta.servlet.ServletRequest.getServletContext. The default behavior of this method is to return getServletContext() on the wrapped request object.
public String	getServletPath() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getServletPath. Implements jakarta.servlet.http.HttpServletRequest.getServletPath. Override the `getServletPath()` method of the wrapped request.
public HttpSession	getSession() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getSession. Implements jakarta.servlet.http.HttpServletRequest.getSession. Return the session associated with this Request, creating one if necessary.
public HttpSession	getSession(boolean Create a new session if one does not exist create) Overrides jakarta.servlet.http.HttpServletRequestWrapper.getSession. Implements jakarta.servlet.http.HttpServletRequest.getSession. Return the session associated with this Request, creating one if necessary and requested.
protected int	Returns: the special attribute pos, or -1 if it is not a special attribute getSpecial(String name) Get a special attribute.
public boolean	Returns: true if the request specifies a JSESSIONID that is valid within the context of this ApplicationHttpRequest, false otherwise. isRequestedSessionIdValid() Overrides jakarta.servlet.http.HttpServletRequestWrapper.isRequestedSessionIdValid. Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdValid. Returns true if the request specifies a JSESSIONID that is valid within the context of this ApplicationHttpRequest, false otherwise.
protected boolean	isSpecial(String Attribute name to be tested name) Is this attribute name one of the special ones that is added only for included servlets?
private void	mergeParameters() Merge the parameters from the saved query parameter string (if any), and the parameters already present on this request (if any), such that the parameter values from the query string show up first if there are duplicate parameter names.
private String[]	mergeValues(String[] First set of values values1, String[] Second set of values values2) Merge the two sets of parameter values into a single String array.
public PushBuilder	newPushBuilder() Overrides jakarta.servlet.http.HttpServletRequestWrapper.newPushBuilder. Overrides default jakarta.servlet.http.HttpServletRequest.newPushBuilder. Obtain a builder for generating push requests.
pack-priv void	parseParameters() Parses the parameters of this request.
public void	recycle() Recycle this request
public void	removeAttribute(String Name of the attribute to remove name) Overrides jakarta.servlet.ServletRequestWrapper.removeAttribute. Implements jakarta.servlet.ServletRequest.removeAttribute. Override the `removeAttribute()` method of the wrapped request.
protected boolean	Returns: true if the attribute was a special attribute, false otherwise removeSpecial(String name) Remove a special attribute.
public void	setAttribute(String Name of the attribute to set name, Object Value of the attribute to set value) Overrides jakarta.servlet.ServletRequestWrapper.setAttribute. Implements jakarta.servlet.ServletRequest.setAttribute. Override the `setAttribute()` method of the wrapped request.
pack-priv void	setContextPath(String The new context path contextPath) Set the context path for this request.
pack-priv void	setMapping(HttpServletMapping mapping)
pack-priv void	setPathInfo(String The new path info pathInfo) Set the path information for this request.
pack-priv void	setQueryParams(String The query string containing parameters for this request queryString) Save query parameters for this request.
pack-priv void	setQueryString(String The new query string queryString) Set the query string for this request.
pack-priv void	setRequest(HttpServletRequest The new wrapped request request) Set the request that we are wrapping.
pack-priv void	setRequestURI(String The new request URI requestURI) Set the request URI for this request.
pack-priv void	setServletPath(String The new servlet path servletPath) Set the servlet path for this request.
protected boolean	Returns: true if the attribute was a special attribute, false otherwise setSpecial(String name, Object value) Set a special attribute.

context	back to summary
protected final Context context The context for this request.

contextPath	back to summary
protected String contextPath The context path for this request.

crossContext	back to summary
protected final boolean crossContext If this request is cross context, since this changes session access behavior.

dispatcherType	back to summary
protected DispatcherType dispatcherType The current dispatcher type.

mapping	back to summary
private HttpServletMapping mapping The mapping for this request.

parameters	back to summary
protected Map<String, String[]> parameters The request parameters for this request. This is initialized from the wrapped request.

parsedParams	back to summary
private boolean parsedParams Have the parameters for this request already been parsed?

pathInfo	back to summary
protected String pathInfo The path information for this request.

queryParamString	back to summary
private String queryParamString The query parameters for the current request.

queryString	back to summary
protected String queryString The query string for this request.

requestDispatcherPath	back to summary
protected Object requestDispatcherPath The current request dispatcher path.

requestURI	back to summary
protected String requestURI The request URI for this request.

servletPath	back to summary
protected String servletPath The servlet path for this request.

session	back to summary
protected Session session The currently active session for this request.

shortestSpecialNameLength	back to summary
private static final int shortestSpecialNameLength

sm	back to summary
private static final StringManager sm

specialAttributes	back to summary
protected final Object[] specialAttributes Special attributes.

specials	back to summary
protected static final String[] specials The set of attribute names that are special for request dispatchers.

SPECIALS_FIRST_FORWARD_INDEX	back to summary
private static final int SPECIALS_FIRST_FORWARD_INDEX

specialsMap	back to summary
private static final Map<String, Integer> specialsMap

ApplicationHttpRequest	back to summary
pack-priv ApplicationHttpRequest(HttpServletRequest request, Context context, boolean crossContext) Construct a new wrapped request around the specified servlet request. Parameters request:HttpServletRequest The servlet request being wrapped context:Context The target context for the wrapped request crossContext:boolean `true` if the wrapped request will be a cross-context request, otherwise `false`

Method Detail

getAttribute back to summary

getAttribute	back to summary
public Object getAttribute(String name) Overrides jakarta.servlet.ServletRequestWrapper.getAttribute. Implements jakarta.servlet.ServletRequest.getAttribute. Override the `getAttribute()` method of the wrapped request. Parameters name:String Name of the attribute to retrieve Returns:Object Doc from jakarta.servlet.ServletRequest.getAttribute. an `Object` containing the value of the attribute, or `null` if the attribute does not exist Annotations @Override

public Object getAttribute(String name)

Overrides jakarta.servlet.ServletRequestWrapper.getAttribute.

Implements jakarta.servlet.ServletRequest.getAttribute.

Override the getAttribute() method of the wrapped request.

Parameters

name:String: Name of the attribute to retrieve

Returns:Object

Doc from jakarta.servlet.ServletRequest.getAttribute.

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

Annotations

@Override

getAttributeNames back to summary

getAttributeNames	back to summary
public Enumeration<String> getAttributeNames() Overrides jakarta.servlet.ServletRequestWrapper.getAttributeNames. Implements jakarta.servlet.ServletRequest.getAttributeNames. Override the `getAttributeNames()` method of the wrapped request. Returns:Enumeration<String> Doc from jakarta.servlet.ServletRequest.getAttributeNames. an `Enumeration` of strings containing the names of the request's attributes Annotations @Override

public Enumeration<String> getAttributeNames()

Overrides jakarta.servlet.ServletRequestWrapper.getAttributeNames.

Implements jakarta.servlet.ServletRequest.getAttributeNames.

Override the getAttributeNames() method of the wrapped request.

Returns:Enumeration<String>

Doc from jakarta.servlet.ServletRequest.getAttributeNames.

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

Annotations

@Override

getContextPath back to summary

getContextPath	back to summary
public String getContextPath() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getContextPath. Implements jakarta.servlet.http.HttpServletRequest.getContextPath. Override the `getContextPath()` method of the wrapped request. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getContextPath. a `String` specifying the portion of the request URI that indicates the context of the request Annotations @Override

public String getContextPath()

Overrides jakarta.servlet.http.HttpServletRequestWrapper.getContextPath.

Implements jakarta.servlet.http.HttpServletRequest.getContextPath.

Override the getContextPath() method of the wrapped request.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getContextPath.

a String specifying the portion of the request URI that indicates the context of the request

Annotations

@Override

getDispatcherType	back to summary
public DispatcherType getDispatcherType() Overrides jakarta.servlet.ServletRequestWrapper.getDispatcherType. Implements jakarta.servlet.ServletRequest.getDispatcherType. Override the getDispatcherType() method of the wrapped request. Returns:DispatcherType Doc from jakarta.servlet.ServletRequest.getDispatcherType. TODO Annotations @Override

getDispatcherType

back to summary

public DispatcherType getDispatcherType()

Overrides jakarta.servlet.ServletRequestWrapper.getDispatcherType.

Implements jakarta.servlet.ServletRequest.getDispatcherType.

Override the getDispatcherType() method of the wrapped request.

Returns:DispatcherType

Doc from jakarta.servlet.ServletRequest.getDispatcherType.

TODO

Annotations

@Override

getHttpServletMapping back to summary

getHttpServletMapping	back to summary
public HttpServletMapping getHttpServletMapping() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getHttpServletMapping. Overrides default jakarta.servlet.http.HttpServletRequest.getHttpServletMapping. Doc from jakarta.servlet.http.HttpServletRequestWrapper.getHttpServletMapping. The default behavior of this method is to return `HttpServletRequest#getHttpServletMapping()` on the wrapped request object. Returns:HttpServletMapping Doc from jakarta.servlet.http.HttpServletRequest.getHttpServletMapping. the mapping information for this request Annotations @Override

public HttpServletMapping getHttpServletMapping()

Overrides jakarta.servlet.http.HttpServletRequestWrapper.getHttpServletMapping.

Overrides default jakarta.servlet.http.HttpServletRequest.getHttpServletMapping.

Doc from jakarta.servlet.http.HttpServletRequestWrapper.getHttpServletMapping.

The default behavior of this method is to return HttpServletRequest#getHttpServletMapping() on the wrapped request object.

Returns:HttpServletMapping

Doc from jakarta.servlet.http.HttpServletRequest.getHttpServletMapping.

the mapping information for this request

Annotations

@Override

getParameter back to summary

getParameter	back to summary
public String getParameter(String name) Overrides jakarta.servlet.ServletRequestWrapper.getParameter. Implements jakarta.servlet.ServletRequest.getParameter. Override the `getParameter()` method of the wrapped request. Parameters name:String Name of the requested parameter Returns:String Doc from jakarta.servlet.ServletRequest.getParameter. a `String` representing the single value of the parameter Annotations @Override

public String getParameter(String name)

Overrides jakarta.servlet.ServletRequestWrapper.getParameter.

Implements jakarta.servlet.ServletRequest.getParameter.

Override the getParameter() method of the wrapped request.

Parameters

name:String: Name of the requested parameter

Returns:String

Doc from jakarta.servlet.ServletRequest.getParameter.

a String representing the single value of the parameter

Annotations

@Override

getParameterMap back to summary

getParameterMap	back to summary
public Map<String, String[]> getParameterMap() Overrides jakarta.servlet.ServletRequestWrapper.getParameterMap. Implements jakarta.servlet.ServletRequest.getParameterMap. Override the `getParameterMap()` method of the wrapped request. Returns:Map<String, String[]> Doc from jakarta.servlet.ServletRequest.getParameterMap. 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. Annotations @Override

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

Overrides jakarta.servlet.ServletRequestWrapper.getParameterMap.

Implements jakarta.servlet.ServletRequest.getParameterMap.

Override the getParameterMap() method of the wrapped request.

Returns:Map<String, String[]>

Doc from jakarta.servlet.ServletRequest.getParameterMap.

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.

Annotations

@Override

getParameterNames back to summary

getParameterNames	back to summary
public Enumeration<String> getParameterNames() Overrides jakarta.servlet.ServletRequestWrapper.getParameterNames. Implements jakarta.servlet.ServletRequest.getParameterNames. Override the `getParameterNames()` method of the wrapped request. Returns:Enumeration<String> Doc from jakarta.servlet.ServletRequest.getParameterNames. an `Enumeration` of `String` objects, each `String` containing the name of a request parameter; or an empty `Enumeration` if the request has no parameters Annotations @Override

public Enumeration<String> getParameterNames()

Overrides jakarta.servlet.ServletRequestWrapper.getParameterNames.

Implements jakarta.servlet.ServletRequest.getParameterNames.

Override the getParameterNames() method of the wrapped request.

Returns:Enumeration<String>

Doc from jakarta.servlet.ServletRequest.getParameterNames.

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

Annotations

@Override

getParameterValues back to summary

getParameterValues	back to summary
public String[] getParameterValues(String name) Overrides jakarta.servlet.ServletRequestWrapper.getParameterValues. Implements jakarta.servlet.ServletRequest.getParameterValues. Override the `getParameterValues()` method of the wrapped request. Parameters name:String Name of the requested parameter Returns:String[] Doc from jakarta.servlet.ServletRequest.getParameterValues. an array of `String` objects containing the parameter's values Annotations @Override

public String[] getParameterValues(String name)

Overrides jakarta.servlet.ServletRequestWrapper.getParameterValues.

Implements jakarta.servlet.ServletRequest.getParameterValues.

Override the getParameterValues() method of the wrapped request.

Parameters

name:String: Name of the requested parameter

Returns:String[]

Doc from jakarta.servlet.ServletRequest.getParameterValues.

an array of String objects containing the parameter's values

Annotations

@Override

getPathInfo back to summary

getPathInfo	back to summary
public String getPathInfo() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getPathInfo. Implements jakarta.servlet.http.HttpServletRequest.getPathInfo. Override the `getPathInfo()` method of the wrapped request. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getPathInfo. a `String`, canonicalized by the web container, 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 Annotations @Override

public String getPathInfo()

Overrides jakarta.servlet.http.HttpServletRequestWrapper.getPathInfo.

Implements jakarta.servlet.http.HttpServletRequest.getPathInfo.

Override the getPathInfo() method of the wrapped request.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getPathInfo.

a String, canonicalized by the web container, 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

Annotations

@Override

getPathTranslated back to summary

getPathTranslated	back to summary
public String getPathTranslated() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getPathTranslated. Implements jakarta.servlet.http.HttpServletRequest.getPathTranslated. Override the `getPathTranslated()` method of the wrapped request. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getPathTranslated. a `String` specifying the real path, or `null` if the URL does not have any extra path information Annotations @Override

public String getPathTranslated()

Overrides jakarta.servlet.http.HttpServletRequestWrapper.getPathTranslated.

Implements jakarta.servlet.http.HttpServletRequest.getPathTranslated.

Override the getPathTranslated() method of the wrapped request.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getPathTranslated.

a String specifying the real path, or null if the URL does not have any extra path information

Annotations

@Override

getQueryString back to summary

getQueryString	back to summary
public String getQueryString() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getQueryString. Implements jakarta.servlet.http.HttpServletRequest.getQueryString. Override the `getQueryString()` method of the wrapped request. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getQueryString. a `String` containing the query string or `null` if the URL contains no query string. The value is not decoded by the container. Annotations @Override

public String getQueryString()

Overrides jakarta.servlet.http.HttpServletRequestWrapper.getQueryString.

Implements jakarta.servlet.http.HttpServletRequest.getQueryString.

Override the getQueryString() method of the wrapped request.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getQueryString.

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

Annotations

@Override

getRequestDispatcher back to summary

getRequestDispatcher	back to summary
public RequestDispatcher getRequestDispatcher(String path) Overrides jakarta.servlet.ServletRequestWrapper.getRequestDispatcher. Implements jakarta.servlet.ServletRequest.getRequestDispatcher. Return a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path. Parameters path:String Path of the resource to be wrapped Returns:RequestDispatcher Doc from jakarta.servlet.ServletRequest.getRequestDispatcher. 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` Annotations @Override

public RequestDispatcher getRequestDispatcher(String path)

Overrides jakarta.servlet.ServletRequestWrapper.getRequestDispatcher.

Implements jakarta.servlet.ServletRequest.getRequestDispatcher.

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

Parameters

path:String: Path of the resource to be wrapped

Returns:RequestDispatcher

Doc from jakarta.servlet.ServletRequest.getRequestDispatcher.

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

Annotations

@Override

getRequestURI back to summary

getRequestURI	back to summary
public String getRequestURI() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getRequestURI. Implements jakarta.servlet.http.HttpServletRequest.getRequestURI. Override the `getRequestURI()` method of the wrapped request. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getRequestURI. a `String` containing the part of the URL from the protocol name up to the query string Annotations @Override

public String getRequestURI()

Overrides jakarta.servlet.http.HttpServletRequestWrapper.getRequestURI.

Implements jakarta.servlet.http.HttpServletRequest.getRequestURI.

Override the getRequestURI() method of the wrapped request.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getRequestURI.

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

Annotations

@Override

getRequestURL back to summary

getRequestURL	back to summary
public StringBuffer getRequestURL() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getRequestURL. Implements jakarta.servlet.http.HttpServletRequest.getRequestURL. Override the `getRequestURL()` method of the wrapped request. Returns:StringBuffer Doc from jakarta.servlet.http.HttpServletRequest.getRequestURL. a `StringBuffer` object containing the reconstructed URL Annotations @Override

public StringBuffer getRequestURL()

Overrides jakarta.servlet.http.HttpServletRequestWrapper.getRequestURL.

Implements jakarta.servlet.http.HttpServletRequest.getRequestURL.

Override the getRequestURL() method of the wrapped request.

Returns:StringBuffer

Doc from jakarta.servlet.http.HttpServletRequest.getRequestURL.

a StringBuffer object containing the reconstructed URL

Annotations

@Override

getServletContext	back to summary
public ServletContext getServletContext() Overrides jakarta.servlet.ServletRequestWrapper.getServletContext. Implements jakarta.servlet.ServletRequest.getServletContext. Doc from jakarta.servlet.ServletRequestWrapper.getServletContext. The default behavior of this method is to return getServletContext() on the wrapped request object. Returns:ServletContext Doc from jakarta.servlet.ServletRequest.getServletContext. TODO Annotations @Override

getServletContext

back to summary

public ServletContext getServletContext()

Overrides jakarta.servlet.ServletRequestWrapper.getServletContext.

Implements jakarta.servlet.ServletRequest.getServletContext.

Doc from jakarta.servlet.ServletRequestWrapper.getServletContext.

The default behavior of this method is to return getServletContext() on the wrapped request object.

Returns:ServletContext

Doc from jakarta.servlet.ServletRequest.getServletContext.

TODO

Annotations

@Override

getServletPath back to summary

getServletPath	back to summary
public String getServletPath() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getServletPath. Implements jakarta.servlet.http.HttpServletRequest.getServletPath. Override the `getServletPath()` method of the wrapped request. Returns:String Doc from jakarta.servlet.http.HttpServletRequest.getServletPath. a `String`, canonicalized by the web container, containing the name or 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. Annotations @Override

public String getServletPath()

Overrides jakarta.servlet.http.HttpServletRequestWrapper.getServletPath.

Implements jakarta.servlet.http.HttpServletRequest.getServletPath.

Override the getServletPath() method of the wrapped request.

Returns:String

Doc from jakarta.servlet.http.HttpServletRequest.getServletPath.

a String, canonicalized by the web container, containing the name or 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.

Annotations

@Override

getSession back to summary

getSession	back to summary
public HttpSession getSession() Overrides jakarta.servlet.http.HttpServletRequestWrapper.getSession. Implements jakarta.servlet.http.HttpServletRequest.getSession. Return the session associated with this Request, creating one if necessary. Returns:HttpSession Doc from jakarta.servlet.http.HttpServletRequest.getSession. the `HttpSession` associated with this request Annotations @Override

public HttpSession getSession()

Overrides jakarta.servlet.http.HttpServletRequestWrapper.getSession.

Implements jakarta.servlet.http.HttpServletRequest.getSession.

Return the session associated with this Request, creating one if necessary.

Returns:HttpSession

Doc from jakarta.servlet.http.HttpServletRequest.getSession.

the HttpSession associated with this request

Annotations

@Override

getSession back to summary

getSession	back to summary
public HttpSession getSession(boolean create) Overrides jakarta.servlet.http.HttpServletRequestWrapper.getSession. Implements jakarta.servlet.http.HttpServletRequest.getSession. Return the session associated with this Request, creating one if necessary and requested. Parameters create:boolean Create a new session if one does not exist Returns:HttpSession Doc from jakarta.servlet.http.HttpServletRequest.getSession. the `HttpSession` associated with this request or `null` if `create` is `false` and the request has no valid session Annotations @Override

public HttpSession getSession(boolean create)

Overrides jakarta.servlet.http.HttpServletRequestWrapper.getSession.

Implements jakarta.servlet.http.HttpServletRequest.getSession.

Return the session associated with this Request, creating one if necessary and requested.

Parameters

create:boolean: Create a new session if one does not exist

Returns:HttpSession

Doc from jakarta.servlet.http.HttpServletRequest.getSession.

the HttpSession associated with this request or null if create is false and the request has no valid session

Annotations

@Override

getSpecial	back to summary
protected int getSpecial(String name) Get a special attribute. Returns:int the special attribute pos, or -1 if it is not a special attribute

getSpecial

back to summary

protected int getSpecial(String name)

Get a special attribute.

Returns:int: the special attribute pos, or -1 if it is not a special attribute

isRequestedSessionIdValid	back to summary
public boolean isRequestedSessionIdValid() Overrides jakarta.servlet.http.HttpServletRequestWrapper.isRequestedSessionIdValid. Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdValid. Returns true if the request specifies a JSESSIONID that is valid within the context of this ApplicationHttpRequest, false otherwise. Returns:boolean true if the request specifies a JSESSIONID that is valid within the context of this ApplicationHttpRequest, false otherwise. Annotations @Override

isRequestedSessionIdValid

back to summary

public boolean isRequestedSessionIdValid()

Overrides jakarta.servlet.http.HttpServletRequestWrapper.isRequestedSessionIdValid.

Implements jakarta.servlet.http.HttpServletRequest.isRequestedSessionIdValid.

Returns true if the request specifies a JSESSIONID that is valid within the context of this ApplicationHttpRequest, false otherwise.

Returns:boolean

true if the request specifies a JSESSIONID that is valid within the context of this ApplicationHttpRequest, false otherwise.

Annotations

@Override

isSpecial	back to summary
protected boolean isSpecial(String name) Is this attribute name one of the special ones that is added only for included servlets? Parameters name:String Attribute name to be tested

isSpecial

back to summary

protected boolean isSpecial(String name)

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

Parameters

name:String: Attribute name to be tested

mergeParameters	back to summary
private void mergeParameters() Merge the parameters from the saved query parameter string (if any), and the parameters already present on this request (if any), such that the parameter values from the query string show up first if there are duplicate parameter names.

mergeValues	back to summary
private String[] mergeValues(String[] values1, String[] values2) Merge the two sets of parameter values into a single String array. Parameters values1:String[] First set of values values2:String[] Second set of values

mergeValues

back to summary

private String[] mergeValues(String[] values1, String[] values2)

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

Parameters

values1:String[]: First set of values
values2:String[]: Second set of values

newPushBuilder back to summary

newPushBuilder	back to summary
public PushBuilder newPushBuilder() Overrides jakarta.servlet.http.HttpServletRequestWrapper.newPushBuilder. Overrides default jakarta.servlet.http.HttpServletRequest.newPushBuilder. Doc from jakarta.servlet.http.HttpServletRequestWrapper.newPushBuilder. Obtain a builder for generating push requests. `PushBuilder` documents how this request will be used as the basis for a push request. Each call to this method will return a new instance, independent of any previous instance obtained. The default behavior of this method is to return `HttpServletRequest#newPushBuilder()` on the wrapped request object. Returns:PushBuilder Doc from jakarta.servlet.http.HttpServletRequest.newPushBuilder. A builder that can be used to generate push requests based on this request or `null` if push is not supported. Note that even if a PushBuilder instance is returned, by the time that `PushBuilder#push()` is called, it may no longer be valid to push a request and the push request will be ignored. Annotations @Override

public PushBuilder newPushBuilder()

Overrides jakarta.servlet.http.HttpServletRequestWrapper.newPushBuilder.

Overrides default jakarta.servlet.http.HttpServletRequest.newPushBuilder.

Doc from jakarta.servlet.http.HttpServletRequestWrapper.newPushBuilder.

Obtain a builder for generating push requests. PushBuilder documents how this request will be used as the basis for a push request. Each call to this method will return a new instance, independent of any previous instance obtained.

The default behavior of this method is to return HttpServletRequest#newPushBuilder() on the wrapped request object.

Returns:PushBuilder

Doc from jakarta.servlet.http.HttpServletRequest.newPushBuilder.

A builder that can be used to generate push requests based on this request or null if push is not supported. Note that even if a PushBuilder instance is returned, by the time that PushBuilder#push() is called, it may no longer be valid to push a request and the push request will be ignored.

Annotations

@Override

parseParameters	back to summary
pack-priv void parseParameters() Parses the parameters of this request. If parameters are present in both the query string and the request content, they are merged.

recycle	back to summary
public void recycle() Recycle this request

removeAttribute back to summary

public void removeAttribute(String name)

Overrides jakarta.servlet.ServletRequestWrapper.removeAttribute.

Implements jakarta.servlet.ServletRequest.removeAttribute.

Override the removeAttribute() method of the wrapped request.

Parameters

name:String: Name of the attribute to remove

Annotations

@Override

removeSpecial

back to summary

protected boolean removeSpecial(String name)

Remove a special attribute.

Returns:boolean: true if the attribute was a special attribute, false otherwise

setAttribute back to summary

public void setAttribute(String name, Object value)

Overrides jakarta.servlet.ServletRequestWrapper.setAttribute.

Implements jakarta.servlet.ServletRequest.setAttribute.

Override the setAttribute() method of the wrapped request.

Parameters

name:String: Name of the attribute to set
value:Object: Value of the attribute to set

Annotations

@Override

setContextPath

back to summary

pack-priv void setContextPath(String contextPath)

Set the context path for this request.

Parameters

contextPath:String: The new context path

setMapping	back to summary
pack-priv void setMapping(HttpServletMapping mapping)

setPathInfo

back to summary

pack-priv void setPathInfo(String pathInfo)

Set the path information for this request.

Parameters

pathInfo:String: The new path info

setQueryParams

back to summary

pack-priv void setQueryParams(String queryString)

Save query parameters for this request.

Parameters

queryString:String: The query string containing parameters for this request

setQueryString

back to summary

pack-priv void setQueryString(String queryString)

Set the query string for this request.

Parameters

queryString:String: The new query string

setRequest

back to summary

pack-priv void setRequest(HttpServletRequest request)

Set the request that we are wrapping.

Parameters

request:HttpServletRequest: The new wrapped request

setRequestURI

back to summary

pack-priv void setRequestURI(String requestURI)

Set the request URI for this request.

Parameters

requestURI:String: The new request URI

setServletPath

back to summary

pack-priv void setServletPath(String servletPath)

Set the servlet path for this request.

Parameters

servletPath:String: The new servlet path

setSpecial

back to summary

protected boolean setSpecial(String name, Object value)

Set a special attribute.

Returns:boolean: true if the attribute was a special attribute, false otherwise

pack-priv Class ApplicationHttpRequest

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class ApplicationHttpRequest.AttributeNamesEnumerator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
protected final int	last
protected String	next
protected final Enumeration<String>	parentEnumeration
protected int	pos

Modifier and Type	Method and Description
protected String	findNext()
public boolean	hasMoreElements() Implements java.util.Enumeration.hasMoreElements. Tests if this enumeration contains more elements.
public String	nextElement() Implements java.util.Enumeration.nextElement. Returns the next element of this enumeration if this enumeration object has at least one more element to provide.