Class HttpServletRequestWrapper
- All Implemented Interfaces:
- HttpServletRequest,- ServletRequest
- Since:
- Servlet 2.3
- See Also:
- 
Field SummaryFields inherited from interface jakarta.servlet.http.HttpServletRequestBASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs a request object wrapping the given request.
- 
Method SummaryModifier and TypeMethodDescriptionbooleanauthenticate(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.longgetDateHeader(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.intgetIntHeader(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.booleanThe default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.booleanThe default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.booleanThe default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.booleanAre trailer fields ready to be read (there may still be no trailers to read).booleanisUserInRole(String role) The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.voidAuthenticate the provided user name and password and then associated the authenticated user with the request.voidlogout()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.ServletRequestWrappergetAsyncContext, 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, startAsyncMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.servlet.ServletRequestgetAsyncContext, 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- 
HttpServletRequestWrapperConstructs a request object wrapping the given request.- Parameters:
- request- The request to wrap
- Throws:
- IllegalArgumentException- if the request is null
 
 
- 
- 
Method Details- 
getAuthTypeThe default behavior of this method is to return getAuthType() on the wrapped request object.- Specified by:
- getAuthTypein interface- HttpServletRequest
- 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
             nullif the request was not authenticated.
 
- 
getCookiesThe default behavior of this method is to return getCookies() on the wrapped request object.- Specified by:
- getCookiesin interface- HttpServletRequest
- Returns:
- an array of all the Cookiesincluded with this request, ornullif the request has no cookies
 
- 
getDateHeaderThe default behavior of this method is to return getDateHeader(String name) on the wrapped request object.- Specified by:
- getDateHeaderin interface- HttpServletRequest
- Parameters:
- name- a- Stringspecifying the name of the header
- Returns:
- a longvalue 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
 
- 
getHeaderThe default behavior of this method is to return getHeader(String name) on the wrapped request object.- Specified by:
- getHeaderin interface- HttpServletRequest
- Parameters:
- name- a- Stringspecifying the header name
- Returns:
- a Stringcontaining the value of the requested header, ornullif the request does not have a header of that name
 
- 
getHeadersThe default behavior of this method is to return getHeaders(String name) on the wrapped request object.- Specified by:
- getHeadersin interface- HttpServletRequest
- Parameters:
- name- a- Stringspecifying the header name
- Returns:
- an Enumerationcontaining 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
 
- 
getHeaderNamesThe default behavior of this method is to return getHeaderNames() on the wrapped request object.- Specified by:
- getHeaderNamesin interface- HttpServletRequest
- 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
 
- 
getIntHeaderThe default behavior of this method is to return getIntHeader(String name) on the wrapped request object.- Specified by:
- getIntHeaderin interface- HttpServletRequest
- Parameters:
- name- a- Stringspecifying 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
 
- 
getHttpServletMappingThe default behavior of this method is to returnHttpServletRequest.getHttpServletMapping()on the wrapped request object.- Specified by:
- getHttpServletMappingin interface- HttpServletRequest
- Returns:
- the mapping information for this request
- Since:
- Servlet 4.0
 
- 
getMethodThe default behavior of this method is to return getMethod() on the wrapped request object.- Specified by:
- getMethodin interface- HttpServletRequest
- Returns:
- a Stringspecifying the name of the method with which this request was made
 
- 
getPathInfoThe default behavior of this method is to return getPathInfo() on the wrapped request object.- Specified by:
- getPathInfoin interface- HttpServletRequest
- 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; ornullif the URL does not have any extra path information
 
- 
getPathTranslatedThe default behavior of this method is to return getPathTranslated() on the wrapped request object.- Specified by:
- getPathTranslatedin interface- HttpServletRequest
- Returns:
- a Stringspecifying the real path, ornullif the URL does not have any extra path information
 
- 
getContextPathThe default behavior of this method is to return getContextPath() on the wrapped request object.- Specified by:
- getContextPathin interface- HttpServletRequest
- Returns:
- a Stringspecifying the portion of the request URI that indicates the context of the request
 
- 
getQueryStringThe default behavior of this method is to return getQueryString() on the wrapped request object.- Specified by:
- getQueryStringin interface- HttpServletRequest
- Returns:
- a Stringcontaining the query string ornullif the URL contains no query string. The value is not decoded by the container.
 
- 
getRemoteUserThe default behavior of this method is to return getRemoteUser() on the wrapped request object.- Specified by:
- getRemoteUserin interface- HttpServletRequest
- Returns:
- a Stringspecifying the login of the user making this request, ornullif the user login is not known
 
- 
isUserInRoleThe default behavior of this method is to return isUserInRole(String role) on the wrapped request object.- Specified by:
- isUserInRolein interface- HttpServletRequest
- Parameters:
- role- a- Stringspecifying the name of the role
- Returns:
- a booleanindicating whether the user making this request belongs to a given role;falseif the user has not been authenticated
 
- 
getUserPrincipalThe default behavior of this method is to return getUserPrincipal() on the wrapped request object.- Specified by:
- getUserPrincipalin interface- HttpServletRequest
- Returns:
- a java.security.Principalcontaining the name of the user making this request;nullif the user has not been authenticated
 
- 
getRequestedSessionIdThe default behavior of this method is to return getRequestedSessionId() on the wrapped request object.- Specified by:
- getRequestedSessionIdin interface- HttpServletRequest
- Returns:
- a Stringspecifying the session ID, ornullif the request did not specify a session ID
- See Also:
 
- 
getRequestURIThe default behavior of this method is to return getRequestURI() on the wrapped request object.- Specified by:
- getRequestURIin interface- HttpServletRequest
- Returns:
- a Stringcontaining the part of the URL from the protocol name up to the query string
- See Also:
 
- 
getRequestURLThe default behavior of this method is to return getRequestURL() on the wrapped request object.- Specified by:
- getRequestURLin interface- HttpServletRequest
- Returns:
- a StringBufferobject containing the reconstructed URL
 
- 
getServletPathThe default behavior of this method is to return getServletPath() on the wrapped request object.- Specified by:
- getServletPathin interface- HttpServletRequest
- 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.
 
- 
getSessionThe default behavior of this method is to return getSession(boolean create) on the wrapped request object.- Specified by:
- getSessionin interface- HttpServletRequest
- Parameters:
- create-- trueto create a new session for this request if necessary;- falseto return- nullif there's no current session
- Returns:
- the HttpSessionassociated with this request ornullifcreateisfalseand the request has no valid session
- See Also:
 
- 
getSessionThe default behavior of this method is to return getSession() on the wrapped request object.- Specified by:
- getSessionin interface- HttpServletRequest
- Returns:
- the HttpSessionassociated with this request
- See Also:
 
- 
changeSessionIdThe default behavior of this method is to call changeSessionId() on the wrapped request object.- Specified by:
- changeSessionIdin interface- HttpServletRequest
- Returns:
- the new session ID allocated to the session
- Since:
- Servlet 3.1
- See Also:
 
- 
isRequestedSessionIdValidpublic boolean isRequestedSessionIdValid()The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.- Specified by:
- isRequestedSessionIdValidin interface- HttpServletRequest
- Returns:
- trueif this request has an id for a valid session in the current session context;- falseotherwise
- See Also:
 
- 
isRequestedSessionIdFromCookiepublic boolean isRequestedSessionIdFromCookie()The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.- Specified by:
- isRequestedSessionIdFromCookiein interface- HttpServletRequest
- Returns:
- trueif the session ID came in as a cookie; otherwise,- false
- See Also:
 
- 
isRequestedSessionIdFromURLpublic boolean isRequestedSessionIdFromURL()The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.- Specified by:
- isRequestedSessionIdFromURLin interface- HttpServletRequest
- Returns:
- trueif the session ID came in as part of a URL; otherwise,- false
- See Also:
 
- 
authenticateTriggers 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:
- authenticatein interface- HttpServletRequest
- Parameters:
- response- The response to use to return any authentication challenge
- Returns:
- trueif the user is successfully authenticated and- falseif not
- Throws:
- IOException- if the authentication process attempted to read from the request or write to the response and an I/O error occurred
- ServletException- if the authentication failed and the caller is expected to handle the failure
- Since:
- Servlet 3.0
 
- 
loginAuthenticate 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:
- loginin interface- HttpServletRequest
- Parameters:
- username- The user name to authenticate
- password- The password to use to authenticate the user
- Throws:
- ServletException- If any of- HttpServletRequest.getRemoteUser(),- HttpServletRequest.getUserPrincipal()or- HttpServletRequest.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
 
- 
logoutRemoves any authenticated user from the request.The default behavior of this method is to return HttpServletRequest.logout()on the wrapped request object.- Specified by:
- logoutin interface- HttpServletRequest
- Throws:
- ServletException- If the logout fails
- Since:
- Servlet 3.0
 
- 
getPartsReturn a collection of all uploaded Parts.The default behavior of this method is to return HttpServletRequest.getParts()on the wrapped request object.- Specified by:
- getPartsin interface- HttpServletRequest
- Returns:
- A collection of all uploaded Parts.
- Throws:
- IOException- if an I/O error occurs
- ServletException- if the request is not multipart/form-data
- Since:
- Servlet 3.0
 
- 
getPartGets 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:
- getPartin interface- HttpServletRequest
- 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 occurs
- ServletException- if the request is not multipart/form-data
- Since:
- Servlet 3.0
 
- 
upgradepublic <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:
- upgradein interface- HttpServletRequest
- 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 upgrade
- ServletException- if the given httpUpgradeHandlerClass fails to be instantiated
- Since:
- Servlet 3.1
 
- 
newPushBuilderObtain a builder for generating push requests.PushBuilderdocuments 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:
- newPushBuilderin interface- HttpServletRequest
- Returns:
- A builder that can be used to generate push requests based on this request or nullif 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
 
- 
getTrailerFieldsObtain 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:
- getTrailerFieldsin interface- HttpServletRequest
- 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
 
- 
isTrailerFieldsReadypublic boolean isTrailerFieldsReady()Are trailer fields ready to be read (there may still be no trailers to read). This method always returnstrueif the underlying protocol does not support trailer fields. Otherwise,trueis 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:
- isTrailerFieldsReadyin interface- HttpServletRequest
- Returns:
- trueif trailers are ready to be read
- Since:
- Servlet 4.0
 
 
-