Package jakarta.servlet.http
Class HttpServletRequestWrapper
- java.lang.Object
-
- jakarta.servlet.ServletRequestWrapper
-
- jakarta.servlet.http.HttpServletRequestWrapper
-
- All Implemented Interfaces:
HttpServletRequest
,ServletRequest
public class HttpServletRequestWrapper extends ServletRequestWrapper implements HttpServletRequest
Provides a convenient implementation of the HttpServletRequest interface that can be subclassed by developers wishing to adapt the request to a Servlet.This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.
- Since:
- Servlet 2.3
- See Also:
HttpServletRequest
-
-
Field Summary
-
Fields inherited from interface jakarta.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
-
Constructor Summary
Constructors Constructor Description HttpServletRequestWrapper(HttpServletRequest request)
Constructs a request object wrapping the given request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
authenticate(HttpServletResponse response)
The default behavior of this method is to call authenticate on the wrapped request object.String
changeSessionId()
The default behavior of this method is to return changeSessionId() on the wrapped request object.String
getAuthType()
The default behavior of this method is to return getAuthType() on the wrapped request object.String
getContextPath()
The default behavior of this method is to return getContextPath() on the wrapped request object.Cookie[]
getCookies()
The default behavior of this method is to return getCookies() on the wrapped request object.long
getDateHeader(String name)
The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.String
getHeader(String name)
The default behavior of this method is to return getHeader(String name) on the wrapped request object.Enumeration<String>
getHeaderNames()
The default behavior of this method is to return getHeaderNames() on the wrapped request object.Enumeration<String>
getHeaders(String name)
The default behavior of this method is to return getHeaders(String name) on the wrapped request object.HttpServletMapping
getHttpServletMapping()
The default behavior of this method is to return getServletMapping() on the wrapped request object.int
getIntHeader(String name)
The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.String
getMethod()
The default behavior of this method is to return getMethod() on the wrapped request object.Part
getPart(String name)
The default behavior of this method is to call getPart on the wrapped request object.Collection<Part>
getParts()
The default behavior of this method is to call getParts on the wrapped request object.String
getPathInfo()
The default behavior of this method is to return getPathInfo() on the wrapped request object.String
getPathTranslated()
The default behavior of this method is to return getPathTranslated() on the wrapped request object.String
getQueryString()
The default behavior of this method is to return getQueryString() on the wrapped request object.String
getRemoteUser()
The default behavior of this method is to return getRemoteUser() on the wrapped request object.String
getRequestedSessionId()
The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.String
getRequestURI()
The default behavior of this method is to return getRequestURI() on the wrapped request object.StringBuffer
getRequestURL()
The default behavior of this method is to return getRequestURL() on the wrapped request object.String
getServletPath()
The default behavior of this method is to return getServletPath() on the wrapped request object.HttpSession
getSession()
The default behavior of this method is to return getSession() on the wrapped request object.HttpSession
getSession(boolean create)
The default behavior of this method is to return getSession(boolean create) on the wrapped request object.Map<String,String>
getTrailerFields()
The default behavior of this method is to call getTrailerFields on the wrapped request object.Principal
getUserPrincipal()
The default behavior of this method is to return getUserPrincipal() on the wrapped request object.boolean
isRequestedSessionIdFromCookie()
The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.boolean
isRequestedSessionIdFromURL()
The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.boolean
isRequestedSessionIdValid()
The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.boolean
isTrailerFieldsReady()
The default behavior of this method is to call isTrailerFieldsReady on the wrapped request object.boolean
isUserInRole(String role)
The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.void
login(String username, String password)
The default behavior of this method is to call login on the wrapped request object.void
logout()
The default behavior of this method is to call login on the wrapped request object.PushBuilder
newPushBuilder()
The default behavior of this method is to call newPushBuilder on the wrapped request object.<T extends HttpUpgradeHandler>
Tupgrade(Class<T> handlerClass)
Create an instance ofHttpUpgradeHandler
for a given class and uses it for the http protocol upgrade processing.-
Methods inherited from class jakarta.servlet.ServletRequestWrapper
getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, 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, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync
-
-
-
-
Constructor Detail
-
HttpServletRequestWrapper
public HttpServletRequestWrapper(HttpServletRequest request)
Constructs a request object wrapping the given request.- Parameters:
request
- theHttpServletRequest
to be wrapped.- Throws:
IllegalArgumentException
- if the request is null
-
-
Method Detail
-
getAuthType
public String getAuthType()
The default behavior of this method is to return getAuthType() on the wrapped request object.- Specified by:
getAuthType
in interfaceHttpServletRequest
- Returns:
- one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison)
or the container-specific string indicating the authentication scheme, or
null
if the request was not authenticated.
-
getCookies
public Cookie[] getCookies()
The default behavior of this method is to return getCookies() on the wrapped request object.- Specified by:
getCookies
in interfaceHttpServletRequest
- Returns:
- an array of all the
Cookies
included with this request, ornull
if the request has no cookies
-
getDateHeader
public long getDateHeader(String name)
The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.- Specified by:
getDateHeader
in interfaceHttpServletRequest
- Parameters:
name
- aString
specifying the name of the header- Returns:
- a
long
value representing the date specified in the header expressed as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header was not included with the request
-
getHeader
public String getHeader(String name)
The default behavior of this method is to return getHeader(String name) on the wrapped request object.- Specified by:
getHeader
in interfaceHttpServletRequest
- Parameters:
name
- aString
specifying the header name- Returns:
- a
String
containing the value of the requested header, ornull
if the request does not have a header of that name
-
getHeaders
public Enumeration<String> getHeaders(String name)
The default behavior of this method is to return getHeaders(String name) on the wrapped request object.- Specified by:
getHeaders
in interfaceHttpServletRequest
- Parameters:
name
- aString
specifying the header name- Returns:
- an
Enumeration
containing the values of the requested header. If the request does not have any headers of that name return an empty enumeration. If the container does not allow access to header information, return null
-
getHeaderNames
public Enumeration<String> getHeaderNames()
The default behavior of this method is to return getHeaderNames() on the wrapped request object.- Specified by:
getHeaderNames
in interfaceHttpServletRequest
- Returns:
- an enumeration of all the header names sent with this request; if the request has no headers, an empty
enumeration; if the servlet container does not allow servlets to use this method,
null
-
getIntHeader
public int getIntHeader(String name)
The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.- Specified by:
getIntHeader
in interfaceHttpServletRequest
- Parameters:
name
- aString
specifying the name of a request header- Returns:
- an integer expressing the value of the request header or -1 if the request doesn't have a header of this name
-
getHttpServletMapping
public HttpServletMapping getHttpServletMapping()
The default behavior of this method is to return getServletMapping() on the wrapped request object.- Specified by:
getHttpServletMapping
in interfaceHttpServletRequest
- Returns:
- An instance of
HttpServletMapping
describing the manner in which the current request was invoked. - Since:
- Servlet 4.0
-
getMethod
public String getMethod()
The default behavior of this method is to return getMethod() on the wrapped request object.- Specified by:
getMethod
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the name of the method with which this request was made
-
getPathInfo
public String getPathInfo()
The default behavior of this method is to return getPathInfo() on the wrapped request object.- Specified by:
getPathInfo
in interfaceHttpServletRequest
- Returns:
- a
String
specifying extra path information that comes after the servlet path but before the query string in the request URL; ornull
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.
-
getPathTranslated
public String getPathTranslated()
The default behavior of this method is to return getPathTranslated() on the wrapped request object.- Specified by:
getPathTranslated
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the real path, ornull
if the URL does not have any extra path information
-
getContextPath
public String getContextPath()
The default behavior of this method is to return getContextPath() on the wrapped request object.- Specified by:
getContextPath
in interfaceHttpServletRequest
- 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()
-
getQueryString
public String getQueryString()
The default behavior of this method is to return getQueryString() on the wrapped request object.- Specified by:
getQueryString
in interfaceHttpServletRequest
- Returns:
- a
String
containing the query string ornull
if the URL contains no query string. The value is not decoded by the container.
-
getRemoteUser
public String getRemoteUser()
The default behavior of this method is to return getRemoteUser() on the wrapped request object.- Specified by:
getRemoteUser
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the login of the user making this request, ornull
if the user login is not known
-
isUserInRole
public boolean isUserInRole(String role)
The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.- Specified by:
isUserInRole
in interfaceHttpServletRequest
- Parameters:
role
- aString
specifying the name of the role- Returns:
- a
boolean
indicating whether the user making this request belongs to a given role;false
if the user has not been authenticated
-
getUserPrincipal
public Principal getUserPrincipal()
The default behavior of this method is to return getUserPrincipal() on the wrapped request object.- Specified by:
getUserPrincipal
in interfaceHttpServletRequest
- Returns:
- a
java.security.Principal
containing the name of the user making this request;null
if the user has not been authenticated
-
getRequestedSessionId
public String getRequestedSessionId()
The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.- Specified by:
getRequestedSessionId
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the session ID, ornull
if the request did not specify a session ID - See Also:
HttpServletRequest.isRequestedSessionIdValid()
-
getRequestURI
public String getRequestURI()
The default behavior of this method is to return getRequestURI() on the wrapped request object.- Specified by:
getRequestURI
in interfaceHttpServletRequest
- Returns:
- a
String
containing the part of the URL from the protocol name up to the query string
-
getRequestURL
public StringBuffer getRequestURL()
The default behavior of this method is to return getRequestURL() on the wrapped request object.- Specified by:
getRequestURL
in interfaceHttpServletRequest
- Returns:
- a
StringBuffer
object containing the reconstructed URL
-
getServletPath
public String getServletPath()
The default behavior of this method is to return getServletPath() on the wrapped request object.- Specified by:
getServletPath
in interfaceHttpServletRequest
- 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.
-
getSession
public HttpSession getSession(boolean create)
The default behavior of this method is to return getSession(boolean create) on the wrapped request object.- Specified by:
getSession
in interfaceHttpServletRequest
- Parameters:
create
-true
to create a new session for this request if necessary;false
to returnnull
if there's no current session- Returns:
- the
HttpSession
associated with this request ornull
ifcreate
isfalse
and the request has no valid session - See Also:
HttpServletRequest.getSession()
-
getSession
public HttpSession getSession()
The default behavior of this method is to return getSession() on the wrapped request object.- Specified by:
getSession
in interfaceHttpServletRequest
- Returns:
- the
HttpSession
associated with this request - See Also:
HttpServletRequest.getSession(boolean)
-
changeSessionId
public String changeSessionId()
The default behavior of this method is to return changeSessionId() on the wrapped request object.- Specified by:
changeSessionId
in interfaceHttpServletRequest
- Returns:
- the new session id
- Since:
- Servlet 3.1
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.- Specified by:
isRequestedSessionIdValid
in interfaceHttpServletRequest
- Returns:
true
if this request has an id for a valid session in the current session context;false
otherwise- See Also:
HttpServletRequest.getRequestedSessionId()
,HttpServletRequest.getSession(boolean)
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()
The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.- Specified by:
isRequestedSessionIdFromCookie
in interfaceHttpServletRequest
- Returns:
true
if the session ID was conveyed to the server an an HTTP cookie; otherwise,false
- See Also:
HttpServletRequest.getSession(boolean)
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()
The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.- Specified by:
isRequestedSessionIdFromURL
in interfaceHttpServletRequest
- Returns:
true
if the session ID was conveyed to the server as part of a URL; otherwise,false
- See Also:
HttpServletRequest.getSession(boolean)
-
authenticate
public boolean authenticate(HttpServletResponse response) throws IOException, ServletException
The default behavior of this method is to call authenticate on the wrapped request object.- Specified by:
authenticate
in interfaceHttpServletRequest
- Parameters:
response
- TheHttpServletResponse
associated with thisHttpServletRequest
- Returns:
true
when non-null values were or have been established as the values returned bygetUserPrincipal
,getRemoteUser
, andgetAuthType
. Returnfalse
if authentication is incomplete and the underlying login mechanism has committed, in the response, the message (e.g., challenge) and HTTP status code to be returned to the user.- Throws:
IOException
- if an input or output error occurred while reading from this request or writing to the given responseServletException
- if the authentication failed and the caller is responsible for handling the error (i.e., the underlying login mechanism did NOT establish the message and HTTP status code to be returned to the user)- Since:
- Servlet 3.0
-
login
public void login(String username, String password) throws ServletException
The default behavior of this method is to call login on the wrapped request object.- Specified by:
login
in interfaceHttpServletRequest
- Parameters:
username
- TheString
value corresponding to the login identifier of the user.password
- The passwordString
corresponding to the identified user.- Throws:
ServletException
- if the configured login mechanism does not support username password authentication, or if a non-null caller identity had already been established (prior to the call to login), or if validation of the provided username and password fails.- Since:
- Servlet 3.0
-
logout
public void logout() throws ServletException
The default behavior of this method is to call login on the wrapped request object.- Specified by:
logout
in interfaceHttpServletRequest
- Throws:
ServletException
- if logout fails- Since:
- Servlet 3.0
-
getParts
public Collection<Part> getParts() throws IOException, ServletException
The default behavior of this method is to call getParts on the wrapped request object.Any changes to the returned
Collection
must not affect thisHttpServletRequestWrapper
.- Specified by:
getParts
in interfaceHttpServletRequest
- Returns:
- a (possibly empty)
Collection
of thePart
components of this request - Throws:
IOException
- if an I/O error occurred during the retrieval of thePart
components of this requestServletException
- if this request is not of typemultipart/form-data
- Since:
- Servlet 3.0
- See Also:
MultipartConfig.maxFileSize()
,MultipartConfig.maxRequestSize()
-
getPart
public Part getPart(String name) throws IOException, ServletException
The default behavior of this method is to call getPart on the wrapped request object.- Specified by:
getPart
in interfaceHttpServletRequest
- Parameters:
name
- the name of the requestedPart
- Returns:
- The
Part
with the given name, ornull
if this request is of typemultipart/form-data
, but does not contain the requestedPart
- Throws:
IOException
- if an I/O error occurred during the retrieval of the requestedPart
ServletException
- if this request is not of typemultipart/form-data
- Since:
- Servlet 3.0
- See Also:
MultipartConfig.maxFileSize()
,MultipartConfig.maxRequestSize()
-
upgrade
public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException, ServletException
Create an instance ofHttpUpgradeHandler
for a given class and uses it for the http protocol upgrade processing.- Specified by:
upgrade
in interfaceHttpServletRequest
- Type Parameters:
T
- TheClass
, which extendsHttpUpgradeHandler
, of thehandlerClass
.- Parameters:
handlerClass
- TheHttpUpgradeHandler
class used for the upgrade.- Returns:
- an instance of the
HttpUpgradeHandler
- Throws:
IOException
- if an I/O error occurred during the upgradeServletException
- if the givenhandlerClass
fails to be instantiated- Since:
- Servlet 3.1
- See Also:
HttpUpgradeHandler
,WebConnection
-
newPushBuilder
public PushBuilder newPushBuilder()
The default behavior of this method is to call newPushBuilder on the wrapped request object.- Specified by:
newPushBuilder
in interfaceHttpServletRequest
- Returns:
- a
PushBuilder
for issuing server push responses from the current request, or null if push is not supported - Since:
- Servlet 4.0
-
getTrailerFields
public Map<String,String> getTrailerFields()
The default behavior of this method is to call getTrailerFields on the wrapped request object.- Specified by:
getTrailerFields
in interfaceHttpServletRequest
- Returns:
- A map of trailer fields in which all the keys are in lowercase, regardless of the case they had at the
protocol level. If there are no trailer fields, yet
HttpServletRequest.isTrailerFieldsReady()
is returning true, the empty map is returned. - Since:
- Servlet 4.0
-
isTrailerFieldsReady
public boolean isTrailerFieldsReady()
The default behavior of this method is to call isTrailerFieldsReady on the wrapped request object.- Specified by:
isTrailerFieldsReady
in interfaceHttpServletRequest
- Returns:
- a boolean whether trailer fields are ready to read
- Since:
- Servlet 4.0
-
-