jakarta.servlet.http.HttpServletRequest that transforms an application request object
(which might be the original one passed to a servlet.
| Modifier and Type | Class and Description |
|---|---|
| private class | DispatchedHttpServletRequest.
Utility class used to expose the special attributes as being available as request attributes. |
| private class | |
| private class | |
| private class | |
| private class |
| Modifier and Type | Field and 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. |
| private final Parameters | |
| private final ParameterMap | parameterMap
Hash map used in the getParametersMap method. |
| 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. |
| private HashMap | specialAttributes
Special attributes. |
| private static final HashSet | specials
The set of attribute names that are special for request dispatchers |
| Access | Constructor and Description |
|---|---|
| public | DispatchedHttpServletRequest(HttpServletRequest
the servlet request being wrapped request, WebappContext context, boolean crossContext, DispatcherType the dispatcher type dispatcherType)Construct a new wrapped request around the specified servlet request. |
| Modifier and Type | Method and Description |
|---|---|
| pack-priv void | |
| public Object | getAttribute(String
Name of the attribute to retrieve name)Overrides jakarta. Implements jakarta. Override the |
| public Enumeration | getAttributeNames()
Overrides jakarta. Implements jakarta. Override the |
| public String | getContextPath()
Overrides jakarta. Implements jakarta. Override the |
| public DispatcherType | getDispatcherType()
Overrides jakarta. Implements jakarta. Gets the dispatcher type of this request. |
| public String | getParameter(String
Name of the requested parameter name)Overrides jakarta. Implements jakarta. Override the |
| public Map | getParameterMap()
Overrides jakarta. Implements jakarta. Override the |
| private ParameterMap | |
| public Enumeration | getParameterNames()
Overrides jakarta. Implements jakarta. Override the |
| public String[] | getParameterValues(String
Name of the requested parameter name)Overrides jakarta. Implements jakarta. Override the |
| public String | getPathInfo()
Overrides jakarta. Implements jakarta. Override the |
| public String | getQueryString()
Overrides jakarta. Implements jakarta. Override the |
| public RequestDispatcher | getRequestDispatcher(String
Path of the resource to be wrapped path)Overrides jakarta. Implements jakarta. Return a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path. |
| public HttpServletRequestImpl | |
| public String | getRequestURI()
Overrides jakarta. Implements jakarta. Override the |
| public StringBuffer | getRequestURL()
Overrides jakarta. Implements jakarta. Override the |
| public String | getServletPath()
Overrides jakarta. Implements jakarta. Override the |
| pack-priv void | |
| protected boolean | |
| protected String[] | mergeValues(Object
First set of values values1, Object Second set of values values2)Merge the two sets of parameter values into a single String array. |
| private void | |
| public void | |
| public void | removeAttribute(String
Name of the attribute to remove name)Overrides jakarta. Implements jakarta. Override the |
| public void | setAttribute(String
Name of the attribute to set name, Object Value of the attribute to set value)Overrides jakarta. Implements jakarta. Override the |
| pack-priv void | |
| pack-priv void | |
| pack-priv void | setQueryParams(String
The query string containing parameters for this request queryString)Save query parameters for this request. |
| pack-priv void | |
| pack-priv void | |
| pack-priv void | |
| pack-priv void |
| context | back to summary |
|---|---|
| protected WebappContext context The context for this request. | |
| contextPath | back to summary |
|---|---|
| protected String contextPath The context path for this request. | |
| crossContext | back to summary |
|---|---|
| protected boolean crossContext If this request is cross context, since this changes session access behavior. | |
| dispatcherType | back to summary |
|---|---|
| protected final DispatcherType dispatcherType The dispatcher type. | |
| mergedParameters | back to summary |
|---|---|
| private final Parameters mergedParameters | |
| parameterMap | back to summary |
|---|---|
| private final ParameterMap parameterMap Hash map used in the getParametersMap method. | |
| 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. | |
| specialAttributes | back to summary |
|---|---|
| private HashMap<String, Object> specialAttributes Special attributes. | |
| specials | back to summary |
|---|---|
| private static final HashSet<String> specials The set of attribute names that are special for request dispatchers | |
| DispatchedHttpServletRequest | back to summary |
|---|---|
| public DispatchedHttpServletRequest(HttpServletRequest request, WebappContext context, boolean crossContext, DispatcherType dispatcherType) Construct a new wrapped request around the specified servlet request.
| |
| copyMap | back to summary |
|---|---|
| pack-priv void copyMap(Map<String, String[]> orig, Map<String, String[]> dest) Perform a shallow copy of the specified Map, and return the result. | |
| getAttribute | back to summary |
|---|---|
| public Object getAttribute(String name) Overrides jakarta. Implements jakarta. Override the | |
| getAttributeNames | back to summary |
|---|---|
| public Enumeration Overrides jakarta. Implements jakarta. Override the
| |
| getContextPath | back to summary |
|---|---|
| public String getContextPath() Overrides jakarta. Implements jakarta. Override the
| |
| getDispatcherType | back to summary |
|---|---|
| public DispatcherType getDispatcherType() Overrides jakarta. Implements jakarta. Doc from jakarta. Gets the dispatcher type of this request. The dispatcher type of a request is used by the container to select the filters that need to be applied to the request: Only filters with matching dispatcher type and url patterns will be applied. Allowing a filter that has been configured for multiple dispatcher types to query a request for its dispatcher type allows the filter to process the request differently depending on its dispatcher type.
The initial dispatcher type of a request is defined as
| |
| getParameter | back to summary |
|---|---|
| public String getParameter(String name) Overrides jakarta. Implements jakarta. Override the | |
| getParameterMap | back to summary |
|---|---|
| public Map Overrides jakarta. Implements jakarta. Override the
| |
| getParameterMapInternal | back to summary |
|---|---|
| private ParameterMap getParameterMapInternal() | |
| getParameterNames | back to summary |
|---|---|
| public Enumeration Overrides jakarta. Implements jakarta. Override the
| |
| getParameterValues | back to summary |
|---|---|
| public String[] getParameterValues(String name) Overrides jakarta. Implements jakarta. Override the | |
| getPathInfo | back to summary |
|---|---|
| public String getPathInfo() Overrides jakarta. Implements jakarta. Override the
| |
| getQueryString | back to summary |
|---|---|
| public String getQueryString() Overrides jakarta. Implements jakarta. Override the
| |
| getRequestDispatcher | back to summary |
|---|---|
| public RequestDispatcher getRequestDispatcher(String path) Overrides jakarta. Implements jakarta. Return a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path. | |
| getRequestFacade | back to summary |
|---|---|
| public HttpServletRequestImpl getRequestFacade() | |
| getRequestURI | back to summary |
|---|---|
| public String getRequestURI() Overrides jakarta. Implements jakarta. Override the
| |
| getRequestURL | back to summary |
|---|---|
| public StringBuffer getRequestURL() Overrides jakarta. Implements jakarta. Override the
| |
| getServletPath | back to summary |
|---|---|
| public String getServletPath() Overrides jakarta. Implements jakarta. Override the
| |
| initSpecialAttributes | back to summary |
|---|---|
| pack-priv void initSpecialAttributes(String requestUri, String contextPath, String servletPath, String pathInfo, String queryString) Initializes the special attributes of this request wrapper. | |
| 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?
| |
| mergeValues | back to summary |
|---|---|
| protected String[] mergeValues(Object values1, Object values2) Merge the two sets of parameter values into a single String array. | |
| parseParameters | back to summary |
|---|---|
| private 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() | |
| removeAttribute | back to summary |
|---|---|
| public void removeAttribute(String name) Overrides jakarta. Implements jakarta. Override the | |
| setAttribute | back to summary |
|---|---|
| public void setAttribute(String name, Object value) Overrides jakarta. Implements jakarta. Override the | |
| setContextPath | back to summary |
|---|---|
| pack-priv void setContextPath(String contextPath) Set the context path for this request.
| |
| setPathInfo | back to summary |
|---|---|
| pack-priv void setPathInfo(String pathInfo) Set the path information for this request.
| |
| setQueryParams | back to summary |
|---|---|
| pack-priv void setQueryParams(String queryString) Save query parameters for this request.
| |
| setQueryString | back to summary |
|---|---|
| pack-priv void setQueryString(String queryString) Set the query string for this request.
| |
| setRequest | back to summary |
|---|---|
| pack-priv void setRequest(HttpServletRequest request) Set the request that we are wrapping.
| |
| setRequestURI | back to summary |
|---|---|
| pack-priv void setRequestURI(String requestURI) Set the request URI for this request.
| |
| setServletPath | back to summary |
|---|---|
| pack-priv void setServletPath(String servletPath) Set the servlet path for this request.
| |
| Modifier and Type | Field and Description |
|---|---|
| pack-priv String | |
| pack-priv Enumeration | |
| private Iterator |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| protected String | |
| public boolean | hasMoreElements()
Implements java. Tests if this enumeration contains more elements. |
| public String | nextElement()
Implements java. Returns the next element of this enumeration if this enumeration object has at least one more element to provide. |
| next | back to summary |
|---|---|
| pack-priv String next | |
| parentEnumeration | back to summary |
|---|---|
| pack-priv Enumeration<String> parentEnumeration | |
| specialNames | back to summary |
|---|---|
| private Iterator<String> specialNames | |
| AttributeNamesEnumerator | back to summary |
|---|---|
public AttributeNamesEnumerator()
| |
| findNext | back to summary |
|---|---|
| protected String findNext() | |
| hasMoreElements | back to summary |
|---|---|
| public boolean hasMoreElements() Implements java. Doc from java. Tests if this enumeration contains more elements.
| |
| nextElement | back to summary |
|---|---|
| public String nextElement() Implements java. Doc from java. Returns the next element of this enumeration if this enumeration object has at least one more element to provide.
| |
| Access | Constructor and Description |
|---|---|
| private |
| Modifier and Type | Method and Description |
|---|---|
| public ParameterMap |
| GetParameterMapPrivilegedAction | back to summary |
|---|---|
| private GetParameterMapPrivilegedAction() | |
| run | back to summary |
|---|---|
| public ParameterMap run() Implements java. Doc from java. Performs the computation. This method will be called by
| |
| Access | Constructor and Description |
|---|---|
| private |
| GetParameterNamesPrivilegedAction | back to summary |
|---|---|
| private GetParameterNamesPrivilegedAction() | |
| run | back to summary |
|---|---|
| public Set Implements java. Doc from java. Performs the computation. This method will be called by
| |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public String |
| name | back to summary |
|---|---|
| public final String name | |
| GetParameterPrivilegedAction | back to summary |
|---|---|
| public GetParameterPrivilegedAction(String name) | |
| run | back to summary |
|---|---|
| public String run() Implements java. Doc from java. Performs the computation. This method will be called by
| |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public String[] |
| name | back to summary |
|---|---|
| public final String name | |
| GetParameterValuePrivilegedAction | back to summary |
|---|---|
| public GetParameterValuePrivilegedAction(String name) | |
| run | back to summary |
|---|---|
| public String[] run() Implements java. Doc from java. Performs the computation. This method will be called by
| |