public class HttpServletRequestWrapper extends ServletRequestWrapper implements HttpServletRequest
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)
Triggers the same authentication process as would be triggered if the
request is for a resource that is protected by a security constraint.
|
java.lang.String |
changeSessionId()
The default behavior of this method is to call changeSessionId() on the
wrapped request object.
|
java.lang.String |
getAuthType()
The default behavior of this method is to return getAuthType() on the
wrapped request object.
|
java.lang.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(java.lang.String name)
The default behavior of this method is to return getDateHeader(String
name) on the wrapped request object.
|
java.lang.String |
getHeader(java.lang.String name)
The default behavior of this method is to return getHeader(String name)
on the wrapped request object.
|
java.util.Enumeration<java.lang.String> |
getHeaderNames()
The default behavior of this method is to return getHeaderNames() on the
wrapped request object.
|
java.util.Enumeration<java.lang.String> |
getHeaders(java.lang.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 getMapping() on the
wrapped request object.
|
int |
getIntHeader(java.lang.String name)
The default behavior of this method is to return getIntHeader(String
name) on the wrapped request object.
|
java.lang.String |
getMethod()
The default behavior of this method is to return getMethod() on the
wrapped request object.
|
Part |
getPart(java.lang.String name)
Gets the named Part or null if the Part does not exist.
|
java.util.Collection<Part> |
getParts()
Return a collection of all uploaded Parts.
|
java.lang.String |
getPathInfo()
The default behavior of this method is to return getPathInfo() on the
wrapped request object.
|
java.lang.String |
getPathTranslated()
The default behavior of this method is to return getPathTranslated() on
the wrapped request object.
|
java.lang.String |
getQueryString()
The default behavior of this method is to return getQueryString() on the
wrapped request object.
|
java.lang.String |
getRemoteUser()
The default behavior of this method is to return getRemoteUser() on the
wrapped request object.
|
java.lang.String |
getRequestedSessionId()
The default behavior of this method is to return getRequestedSessionId()
on the wrapped request object.
|
java.lang.String |
getRequestURI()
The default behavior of this method is to return getRequestURI() on the
wrapped request object.
|
java.lang.StringBuffer |
getRequestURL()
The default behavior of this method is to return getRequestURL() on the
wrapped request object.
|
java.lang.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.
|
java.util.Map<java.lang.String,java.lang.String> |
getTrailerFields()
Obtain a Map of the trailer fields that is not backed by the request
object.
|
java.security.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 3.0 of the Java Servlet API
|
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()
Are trailer fields ready to be read (there may still be no trailers to
read).
|
boolean |
isUserInRole(java.lang.String role)
The default behavior of this method is to return isUserInRole(String
role) on the wrapped request object.
|
void |
login(java.lang.String username,
java.lang.String password)
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.
|
PushBuilder |
newPushBuilder()
Obtain a builder for generating push requests.
|
<T extends HttpUpgradeHandler> |
upgrade(java.lang.Class<T> httpUpgradeHandlerClass)
Start the HTTP upgrade process and pass the connection to the provided
protocol handler once the current request/response pair has completed
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 request to wrapjava.lang.IllegalArgumentException - if the request is nullpublic java.lang.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(java.lang.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 java.lang.String getHeader(java.lang.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 java.util.Enumeration<java.lang.String> getHeaders(java.lang.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 java.util.Enumeration<java.lang.String> getHeaderNames()
getHeaderNames in interface HttpServletRequestnullpublic int getIntHeader(java.lang.String name)
getIntHeader in interface HttpServletRequestname - a String specifying the name of a request headerpublic HttpServletMapping getHttpServletMapping()
getHttpServletMapping in interface HttpServletRequestpublic java.lang.String getMethod()
getMethod in interface HttpServletRequestString specifying the name of the method with
which this request was madepublic java.lang.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 java.lang.String getPathTranslated()
getPathTranslated in interface HttpServletRequestString specifying the real path, or
null if the URL does not have any extra path
informationpublic java.lang.String getContextPath()
getContextPath in interface HttpServletRequestString specifying the portion of the request URI
that indicates the context of the requestpublic java.lang.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 java.lang.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(java.lang.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 java.security.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 java.lang.String getRequestedSessionId()
getRequestedSessionId in interface HttpServletRequestString specifying the session ID, or
null if the request did not specify a session IDHttpServletRequest.isRequestedSessionIdValid()public java.lang.String getRequestURI()
getRequestURI in interface HttpServletRequestString containing the part of the URL from the
protocol name up to the query stringHttpServletRequest.getRequestURL()public java.lang.StringBuffer getRequestURL()
getRequestURL in interface HttpServletRequestStringBuffer object containing the reconstructed
URLpublic java.lang.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 java.lang.String changeSessionId()
changeSessionId in interface HttpServletRequestHttpSessionIdListenerpublic 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)public boolean isRequestedSessionIdFromCookie()
isRequestedSessionIdFromCookie in interface HttpServletRequesttrue if the session ID came in as a cookie;
otherwise, falseHttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdFromURL()
isRequestedSessionIdFromURL in interface HttpServletRequesttrue if the session ID came in as part of a URL;
otherwise, falseHttpServletRequest.getSession(boolean)@Deprecated public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl in interface HttpServletRequestHttpServletRequest.isRequestedSessionIdFromURL()public boolean authenticate(HttpServletResponse response) throws java.io.IOException, ServletException
The default behavior of this method is to return
HttpServletRequest.authenticate(HttpServletResponse)
on the wrapped request object.
authenticate in interface HttpServletRequestresponse - The response to use to return any authentication
challengetrue if the user is successfully authenticated and
false if notjava.io.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 failurepublic void login(java.lang.String username,
java.lang.String password)
throws ServletException
The default behavior of this method is to return
HttpServletRequest.login(String, String)
on the wrapped request object.
login in interface HttpServletRequestusername - The user name to authenticatepassword - The password to use to authenticate the userServletException - 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 failspublic void logout()
throws ServletException
The default behavior of this method is to return
HttpServletRequest.logout()
on the wrapped request object.
logout in interface HttpServletRequestServletException - If the logout failspublic java.util.Collection<Part> getParts() throws java.io.IOException, ServletException
The default behavior of this method is to return
HttpServletRequest.getParts()
on the wrapped request object.
getParts in interface HttpServletRequestjava.io.IOException - if an I/O error occursServletException - if the request is not multipart/form-datapublic Part getPart(java.lang.String name) throws java.io.IOException, ServletException
The default behavior of this method is to return
HttpServletRequest.getPart(String)
on the wrapped request object.
getPart in interface HttpServletRequestname - The name of the Part to obtainjava.io.IOException - if an I/O error occursServletException - if the request is not multipart/form-datapublic <T extends HttpUpgradeHandler> T upgrade(java.lang.Class<T> httpUpgradeHandlerClass) throws java.io.IOException, ServletException
HttpServletResponse.SC_SWITCHING_PROTOCOLS and flushes the response.
Protocol specific headers must have already been set before this method
is called.
The default behavior of this method is to return
HttpServletRequest.upgrade(Class) on the wrapped request object.
upgrade in interface HttpServletRequestT - The type of the upgrade handlerhttpUpgradeHandlerClass - The class that implements the upgrade
handlerjava.io.IOException - if an I/O error occurred during the upgradeServletException - if the given httpUpgradeHandlerClass fails to be instantiatedpublic PushBuilder newPushBuilder()
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.
newPushBuilder in interface HttpServletRequestnull if push is not supported. Note that
even if a PushBuilder instance is returned, by the time that
PushBuilder.push() is called, it may no longer be valid
to push a request and the push request will be ignored.public java.util.Map<java.lang.String,java.lang.String> getTrailerFields()
The default behavior of this method is to return
HttpServletRequest.getTrailerFields() on the wrapped request
object.
getTrailerFields in interface HttpServletRequestpublic boolean isTrailerFieldsReady()
true if the underlying protocol
does not support trailer fields. Otherwise, true is returned once
all of the following are true:
The default behavior of this method is to return
HttpServletRequest.isTrailerFieldsReady() on the wrapped request
object.
isTrailerFieldsReady in interface HttpServletRequesttrue if trailers are ready to be readCopyright © 2000-2019 Apache Software Foundation. All Rights Reserved.