Class HttpServletRequestWrapper
- All Implemented Interfaces:
HttpServletRequest
,ServletRequest
- Since:
- Servlet 2.3
- See Also:
-
Field Summary
Fields inherited from interface jakarta.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
Constructor Summary
ConstructorDescriptionConstructs a request object wrapping the given request. -
Method Summary
Modifier and TypeMethodDescriptionboolean
authenticate
(HttpServletResponse response) Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.The default behavior of this method is to call changeSessionId() on the wrapped request object.The default behavior of this method is to return getAuthType() on the wrapped request object.The default behavior of this method is to return getContextPath() on the wrapped request object.Cookie[]
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.The default behavior of this method is to return getHeader(String name) on the wrapped request object.The default behavior of this method is to return getHeaderNames() on the wrapped request object.getHeaders
(String name) The default behavior of this method is to return getHeaders(String name) on the wrapped request object.The default behavior of this method is to returnHttpServletRequest.getHttpServletMapping()
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.The default behavior of this method is to return getMethod() on the wrapped request object.Gets the named Part or null if the Part does not exist.getParts()
Return a collection of all uploaded Parts.The default behavior of this method is to return getPathInfo() on the wrapped request object.The default behavior of this method is to return getPathTranslated() on the wrapped request object.The default behavior of this method is to return getQueryString() on the wrapped request object.The default behavior of this method is to return getRemoteUser() on the wrapped request object.The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.The default behavior of this method is to return getRequestURI() on the wrapped request object.The default behavior of this method is to return getRequestURL() on the wrapped request object.The default behavior of this method is to return getServletPath() on the wrapped request object.The default behavior of this method is to return getSession() on the wrapped request object.getSession
(boolean create) The default behavior of this method is to return getSession(boolean create) on the wrapped request object.Obtain a Map of the trailer fields that is not backed by the request object.The default behavior of this method is to return getUserPrincipal() on the wrapped request object.boolean
The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.boolean
The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.boolean
The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.boolean
Are trailer fields ready to be read (there may still be no trailers to read).boolean
isUserInRole
(String role) The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.void
Authenticate the provided user name and password and then associated the authenticated user with the request.void
logout()
Removes any authenticated user from the request.Obtain a builder for generating push requests.<T extends HttpUpgradeHandler>
TStart the HTTP upgrade process and create and instance of the provided protocol handler class.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 Details
-
HttpServletRequestWrapper
Constructs a request object wrapping the given request.- Parameters:
request
- The request to wrap- Throws:
IllegalArgumentException
- if the request is null
-
-
Method Details
-
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
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
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
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
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
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
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
The default behavior of this method is to returnHttpServletRequest.getHttpServletMapping()
on the wrapped request object.- Specified by:
getHttpServletMapping
in interfaceHttpServletRequest
- Returns:
- the mapping information for this request
- Since:
- Servlet 4.0
-
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
The default behavior of this method is to return getPathInfo() on the wrapped request object.- Specified by:
getPathInfo
in interfaceHttpServletRequest
- Returns:
- 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; ornull
if the URL does not have any extra path information
-
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
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
-
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
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
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
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
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:
-
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 - See Also:
-
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
The default behavior of this method is to return getServletPath() on the wrapped request object.- Specified by:
getServletPath
in interfaceHttpServletRequest
- Returns:
- 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.
-
getSession
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:
-
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:
-
changeSessionId
The default behavior of this method is to call changeSessionId() on the wrapped request object.- Specified by:
changeSessionId
in interfaceHttpServletRequest
- Returns:
- the new session ID allocated to the session
- Since:
- Servlet 3.1
- See Also:
-
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:
-
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 came in as a cookie; otherwise,false
- See Also:
-
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 came in as part of a URL; otherwise,false
- See Also:
-
authenticate
Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.The default behavior of this method is to return
HttpServletRequest.authenticate(HttpServletResponse)
on the wrapped request object.- Specified by:
authenticate
in interfaceHttpServletRequest
- Parameters:
response
- The response to use to return any authentication challenge- Returns:
true
if the user is successfully authenticated andfalse
if not- Throws:
IOException
- if the authentication process attempted to read from the request or write to the response and an I/O error occurredServletException
- if the authentication failed and the caller is expected to handle the failure- Since:
- Servlet 3.0
-
login
Authenticate the provided user name and password and then associated the authenticated user with the request.The default behavior of this method is to return
HttpServletRequest.login(String, String)
on the wrapped request object.- Specified by:
login
in interfaceHttpServletRequest
- Parameters:
username
- The user name to authenticatepassword
- The password to use to authenticate the user- Throws:
ServletException
- If any ofHttpServletRequest.getRemoteUser()
,HttpServletRequest.getUserPrincipal()
orHttpServletRequest.getAuthType()
are non-null, if the configured authenticator does not support user name and password authentication or if the authentication fails- Since:
- Servlet 3.0
-
logout
Removes any authenticated user from the request.The default behavior of this method is to return
HttpServletRequest.logout()
on the wrapped request object.- Specified by:
logout
in interfaceHttpServletRequest
- Throws:
ServletException
- If the logout fails- Since:
- Servlet 3.0
-
getParts
Return a collection of all uploaded Parts.The default behavior of this method is to return
HttpServletRequest.getParts()
on the wrapped request object.- Specified by:
getParts
in interfaceHttpServletRequest
- Returns:
- A collection of all uploaded Parts.
- Throws:
IOException
- if an I/O error occursServletException
- if the request is not multipart/form-data- Since:
- Servlet 3.0
-
getPart
Gets the named Part or null if the Part does not exist. Triggers upload of all Parts.The default behavior of this method is to return
HttpServletRequest.getPart(String)
on the wrapped request object.- Specified by:
getPart
in interfaceHttpServletRequest
- Parameters:
name
- The name of the Part to obtain- Returns:
- The named Part or null if the Part does not exist
- Throws:
IOException
- if an I/O error occursServletException
- if the request is not multipart/form-data- Since:
- Servlet 3.0
-
upgrade
public <T extends HttpUpgradeHandler> T upgrade(Class<T> httpUpgradeHandlerClass) throws IOException, ServletException Start the HTTP upgrade process and create and instance of the provided protocol handler class. The connection will be passed this instance once the current request/response pair has completed processing. Calling this method sets the response status toHttpServletResponse.SC_SWITCHING_PROTOCOLS
.The default behavior of this method is to return
HttpServletRequest.upgrade(Class)
on the wrapped request object.- Specified by:
upgrade
in interfaceHttpServletRequest
- Type Parameters:
T
- The type of the upgrade handler- Parameters:
httpUpgradeHandlerClass
- The class that implements the upgrade handler- Returns:
- A newly created instance of the specified upgrade handler type
- Throws:
IOException
- if an I/O error occurred during the upgradeServletException
- if the given httpUpgradeHandlerClass fails to be instantiated- Since:
- Servlet 3.1
-
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.- Specified by:
newPushBuilder
in interfaceHttpServletRequest
- Returns:
- 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 thatPushBuilder.push()
is called, it may no longer be valid to push a request and the push request will be ignored. - Since:
- Servlet 4.0
-
getTrailerFields
Obtain a Map of the trailer fields that is not backed by the request object.The default behavior of this method is to return
HttpServletRequest.getTrailerFields()
on the wrapped request object.- Specified by:
getTrailerFields
in interfaceHttpServletRequest
- Returns:
- A Map of the received trailer fields with all keys lower case or an empty Map if no trailers are present
- Since:
- Servlet 4.0
-
isTrailerFieldsReady
public boolean isTrailerFieldsReady()Are trailer fields ready to be read (there may still be no trailers to read). This method always returnstrue
if the underlying protocol does not support trailer fields. Otherwise,true
is returned once all of the following are true:- The application has ready all the request data and an EOF has been received or the content-length is zero
- All trailer fields, if any, have been received
The default behavior of this method is to return
HttpServletRequest.isTrailerFieldsReady()
on the wrapped request object.- Specified by:
isTrailerFieldsReady
in interfaceHttpServletRequest
- Returns:
true
if trailers are ready to be read- Since:
- Servlet 4.0
-