public class HttpServletRequestWrapper extends ServletRequestWrapper implements HttpServletRequest
This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.
HttpServletRequestBASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH| Constructor and Description |
|---|
HttpServletRequestWrapper(HttpServletRequest request)
Constructs a request object wrapping the given request.
|
| Modifier and Type | Method and 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()
Deprecated.
As of Version 4.0 of the Java Servlet API,
use
isRequestedSessionIdFromURL() instead. |
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> |
upgrade(Class<T> handlerClass)
Create an instance of
HttpUpgradeHandler for a given
class and uses it for the http protocol upgrade processing. |
getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsyncclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsyncpublic HttpServletRequestWrapper(HttpServletRequest request)
request - the HttpServletRequest to be wrapped.IllegalArgumentException - if the request is nullpublic String getAuthType()
getAuthType in interface HttpServletRequestnull if the request was
not authenticated.public Cookie[] getCookies()
getCookies in interface HttpServletRequestCookies
included with this request, or null
if the request has no cookiespublic long getDateHeader(String name)
getDateHeader in interface HttpServletRequestname - a String specifying the
name of the headerlong 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
requestpublic String getHeader(String name)
getHeader in interface HttpServletRequestname - a String specifying the
header nameString containing the
value of the requested
header, or null
if the request does not
have a header of that namepublic Enumeration<String> getHeaders(String name)
getHeaders in interface HttpServletRequestname - a String specifying the
header nameEnumeration 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 nullpublic Enumeration<String> getHeaderNames()
getHeaderNames in interface HttpServletRequestnullpublic int getIntHeader(String name)
getIntHeader in interface HttpServletRequestname - a String specifying the name
of a request headerpublic HttpServletMapping getHttpServletMapping()
The default behavior of this method is to return getServletMapping() on the wrapped request object.
getHttpServletMapping in interface HttpServletRequestHttpServletMapping describing the manner in which
the current request was invoked.public String getMethod()
getMethod in interface HttpServletRequestString
specifying the name
of the method with which
this request was madepublic String getPathInfo()
getPathInfo in interface HttpServletRequestString, decoded 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 informationpublic String getPathTranslated()
getPathTranslated in interface HttpServletRequestString specifying the
real path, or null if
the URL does not have any extra path
informationpublic String getContextPath()
getContextPath in interface HttpServletRequestString specifying the
portion of the request URI that indicates the context
of the requestServletContext.getContextPath()public String getQueryString()
getQueryString in interface HttpServletRequestString containing the query
string or null if the URL
contains no query string. The value is not
decoded by the container.public String getRemoteUser()
getRemoteUser in interface HttpServletRequestString specifying the login
of the user making this request, or null
if the user login is not knownpublic boolean isUserInRole(String role)
isUserInRole in interface HttpServletRequestrole - a String specifying the name
of the roleboolean indicating whether
the user making this request belongs to a given role;
false if the user has not been
authenticatedpublic Principal getUserPrincipal()
getUserPrincipal in interface HttpServletRequestjava.security.Principal containing
the name of the user making this request;
null if the user has not been
authenticatedpublic String getRequestedSessionId()
getRequestedSessionId in interface HttpServletRequestString specifying the session
ID, or null if the request did
not specify a session IDHttpServletRequest.isRequestedSessionIdValid()public String getRequestURI()
getRequestURI in interface HttpServletRequestString containing
the part of the URL from the
protocol name up to the query stringHttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)public StringBuffer getRequestURL()
getRequestURL in interface HttpServletRequestStringBuffer object containing
the reconstructed URLpublic String getServletPath()
getServletPath in interface HttpServletRequestString containing
the name or path of the servlet being
called, as specified in the request URL,
decoded, or an empty string if the servlet
used to process the request is matched
using the "/*" pattern.public HttpSession getSession(boolean create)
getSession in interface HttpServletRequestcreate - true to create
a new session for this request if necessary;
false to return null
if there's no current sessionHttpSession associated
with this request or null if
create is false
and the request has no valid sessionHttpServletRequest.getSession()public HttpSession getSession()
getSession in interface HttpServletRequestHttpSession associated
with this requestHttpServletRequest.getSession(boolean)public String changeSessionId()
changeSessionId in interface HttpServletRequestpublic boolean isRequestedSessionIdValid()
isRequestedSessionIdValid in interface HttpServletRequesttrue if this
request has an id for a valid session
in the current session context;
false otherwiseHttpServletRequest.getRequestedSessionId(),
HttpServletRequest.getSession(boolean),
HttpSessionContextpublic boolean isRequestedSessionIdFromCookie()
isRequestedSessionIdFromCookie in interface HttpServletRequesttrue if the session ID
was conveyed to the server an an HTTP
cookie; otherwise, falseHttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdFromURL()
isRequestedSessionIdFromURL in interface HttpServletRequesttrue if the session ID was conveyed to the
server as part of a URL; otherwise,
falseHttpServletRequest.getSession(boolean)@Deprecated public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromURL() instead.isRequestedSessionIdFromUrl in interface HttpServletRequesttrue if the session ID was conveyed to the
server as part of a URL; otherwise,
falsepublic boolean authenticate(HttpServletResponse response) throws IOException, ServletException
authenticate in interface HttpServletRequestresponse - The HttpServletResponse
associated with this HttpServletRequesttrue when non-null values were or have been
established as the values returned by getUserPrincipal,
getRemoteUser, and getAuthType. Return
false 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.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)public void login(String username, String password) throws ServletException
login in interface HttpServletRequestusername - The String value corresponding to
the login identifier of the user.password - The password String corresponding
to the identified user.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.public void logout()
throws ServletException
logout in interface HttpServletRequestServletException - if logout failspublic Collection<Part> getParts() throws IOException, ServletException
Any changes to the returned Collection must not
affect this HttpServletRequestWrapper.
getParts in interface HttpServletRequestCollection of the
Part components of this requestIOException - if an I/O error occurred during the retrieval
of the Part components of this requestServletException - if this request is not of type
multipart/form-dataMultipartConfig.maxFileSize(),
MultipartConfig.maxRequestSize()public Part getPart(String name) throws IOException, ServletException
getPart in interface HttpServletRequestname - the name of the requested PartPart with the given name, or
null if this request is of type
multipart/form-data, but does not
contain the requested PartIOException - if an I/O error occurred during the retrieval
of the requested PartServletException - if this request is not of type
multipart/form-dataMultipartConfig.maxFileSize(),
MultipartConfig.maxRequestSize()public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException, ServletException
HttpUpgradeHandler for a given
class and uses it for the http protocol upgrade processing.upgrade in interface HttpServletRequestT - The Class, which extends HttpUpgradeHandler, of the handlerClass.handlerClass - The HttpUpgradeHandler class used for the upgrade.HttpUpgradeHandlerIOException - if an I/O error occurred during the upgradeServletException - if the given handlerClass fails to
be instantiatedHttpUpgradeHandler,
WebConnectionpublic PushBuilder newPushBuilder()
newPushBuilder in interface HttpServletRequestPushBuilder for issuing server push responses
from the current request, or null if push is not supportedpublic Map<String,String> getTrailerFields()
getTrailerFields in interface HttpServletRequestHttpServletRequest.isTrailerFieldsReady() is returning true,
the empty map is returned.public boolean isTrailerFieldsReady()
isTrailerFieldsReady in interface HttpServletRequestCopyright © 1999-2017, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms. Portions Copyright © 1999-2002 The Apache Software Foundation.