Package javax.servlet.http
Class HttpServletRequestWrapper
- java.lang.Object
-
- javax.servlet.ServletRequestWrapper
-
- javax.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 javax.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 Deprecated Methods Modifier and Type Method Description booleanauthenticate(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.StringchangeSessionId()The default behavior of this method is to call changeSessionId() on the wrapped request object.java.lang.StringgetAuthType()The default behavior of this method is to return getAuthType() on the wrapped request object.java.lang.StringgetContextPath()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.longgetDateHeader(java.lang.String name)The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.java.lang.StringgetHeader(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.intgetIntHeader(java.lang.String name)The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.java.lang.StringgetMethod()The default behavior of this method is to return getMethod() on the wrapped request object.PartgetPart(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.StringgetPathInfo()The default behavior of this method is to return getPathInfo() on the wrapped request object.java.lang.StringgetPathTranslated()The default behavior of this method is to return getPathTranslated() on the wrapped request object.java.lang.StringgetQueryString()The default behavior of this method is to return getQueryString() on the wrapped request object.java.lang.StringgetRemoteUser()The default behavior of this method is to return getRemoteUser() on the wrapped request object.java.lang.StringgetRequestedSessionId()The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.java.lang.StringgetRequestURI()The default behavior of this method is to return getRequestURI() on the wrapped request object.java.lang.StringBuffergetRequestURL()The default behavior of this method is to return getRequestURL() on the wrapped request object.java.lang.StringgetServletPath()The default behavior of this method is to return getServletPath() on the wrapped request object.HttpSessiongetSession()The default behavior of this method is to return getSession() on the wrapped request object.HttpSessiongetSession(boolean create)The default behavior of this method is to return getSession(boolean create) on the wrapped request object.java.security.PrincipalgetUserPrincipal()The default behavior of this method is to return getUserPrincipal() on the wrapped request object.booleanisRequestedSessionIdFromCookie()The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.booleanisRequestedSessionIdFromUrl()Deprecated.As of Version 3.0 of the Java Servlet APIbooleanisRequestedSessionIdFromURL()The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.booleanisRequestedSessionIdValid()The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.booleanisUserInRole(java.lang.String role)The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.voidlogin(java.lang.String username, java.lang.String password)Authenticate the provided user name and password and then associated the authenticated user with the request.voidlogout()Removes any authenticated user from the request.<T extends HttpUpgradeHandler>
Tupgrade(java.lang.Class<T> httpUpgradeHandlerClass)Start the HTTP upgrade process and create and instance of the provided protocol handler class.-
Methods inherited from class javax.servlet.ServletRequestWrapper
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, startAsync
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface javax.servlet.ServletRequest
getAsyncContext, 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, startAsync
-
-
-
-
Constructor Detail
-
HttpServletRequestWrapper
public HttpServletRequestWrapper(HttpServletRequest request)
Constructs a request object wrapping the given request.- Parameters:
request- The request to wrap- Throws:
java.lang.IllegalArgumentException- if the request is null
-
-
Method Detail
-
getAuthType
public java.lang.String getAuthType()
The default behavior of this method is to return getAuthType() on the wrapped request object.- Specified by:
getAuthTypein 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
nullif 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:
getCookiesin interfaceHttpServletRequest- Returns:
- an array of all the
Cookiesincluded with this request, ornullif the request has no cookies
-
getDateHeader
public long getDateHeader(java.lang.String name)
The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.- Specified by:
getDateHeaderin interfaceHttpServletRequest- Parameters:
name- aStringspecifying 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
-
getHeader
public 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.- Specified by:
getHeaderin interfaceHttpServletRequest- Parameters:
name- aStringspecifying the header name- Returns:
- a
Stringcontaining the value of the requested header, ornullif the request does not have a header of that name
-
getHeaders
public 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.- Specified by:
getHeadersin interfaceHttpServletRequest- Parameters:
name- aStringspecifying 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
-
getHeaderNames
public java.util.Enumeration<java.lang.String> getHeaderNames()
The default behavior of this method is to return getHeaderNames() on the wrapped request object.- Specified by:
getHeaderNamesin 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(java.lang.String name)
The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.- Specified by:
getIntHeaderin interfaceHttpServletRequest- Parameters:
name- aStringspecifying 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
-
getMethod
public java.lang.String getMethod()
The default behavior of this method is to return getMethod() on the wrapped request object.- Specified by:
getMethodin interfaceHttpServletRequest- Returns:
- a
Stringspecifying the name of the method with which this request was made
-
getPathInfo
public java.lang.String getPathInfo()
The default behavior of this method is to return getPathInfo() on the wrapped request object.- Specified by:
getPathInfoin interfaceHttpServletRequest- Returns:
- a
String, decoded 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
-
getPathTranslated
public java.lang.String getPathTranslated()
The default behavior of this method is to return getPathTranslated() on the wrapped request object.- Specified by:
getPathTranslatedin interfaceHttpServletRequest- Returns:
- a
Stringspecifying the real path, ornullif the URL does not have any extra path information
-
getContextPath
public java.lang.String getContextPath()
The default behavior of this method is to return getContextPath() on the wrapped request object.- Specified by:
getContextPathin interfaceHttpServletRequest- Returns:
- a
Stringspecifying the portion of the request URI that indicates the context of the request
-
getQueryString
public java.lang.String getQueryString()
The default behavior of this method is to return getQueryString() on the wrapped request object.- Specified by:
getQueryStringin interfaceHttpServletRequest- Returns:
- a
Stringcontaining the query string ornullif the URL contains no query string. The value is not decoded by the container.
-
getRemoteUser
public java.lang.String getRemoteUser()
The default behavior of this method is to return getRemoteUser() on the wrapped request object.- Specified by:
getRemoteUserin interfaceHttpServletRequest- Returns:
- a
Stringspecifying the login of the user making this request, ornullif the user login is not known
-
isUserInRole
public boolean isUserInRole(java.lang.String role)
The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.- Specified by:
isUserInRolein interfaceHttpServletRequest- Parameters:
role- aStringspecifying 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
-
getUserPrincipal
public java.security.Principal getUserPrincipal()
The default behavior of this method is to return getUserPrincipal() on the wrapped request object.- Specified by:
getUserPrincipalin interfaceHttpServletRequest- Returns:
- a
java.security.Principalcontaining the name of the user making this request;nullif the user has not been authenticated
-
getRequestedSessionId
public java.lang.String getRequestedSessionId()
The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.- Specified by:
getRequestedSessionIdin interfaceHttpServletRequest- Returns:
- a
Stringspecifying the session ID, ornullif the request did not specify a session ID - See Also:
HttpServletRequest.isRequestedSessionIdValid()
-
getRequestURI
public java.lang.String getRequestURI()
The default behavior of this method is to return getRequestURI() on the wrapped request object.- Specified by:
getRequestURIin interfaceHttpServletRequest- Returns:
- a
Stringcontaining the part of the URL from the protocol name up to the query string - See Also:
HttpServletRequest.getRequestURL()
-
getRequestURL
public java.lang.StringBuffer getRequestURL()
The default behavior of this method is to return getRequestURL() on the wrapped request object.- Specified by:
getRequestURLin interfaceHttpServletRequest- Returns:
- a
StringBufferobject containing the reconstructed URL
-
getServletPath
public java.lang.String getServletPath()
The default behavior of this method is to return getServletPath() on the wrapped request object.- Specified by:
getServletPathin interfaceHttpServletRequest- Returns:
- a
Stringcontaining 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.
-
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:
getSessionin interfaceHttpServletRequest- Parameters:
create-trueto create a new session for this request if necessary;falseto returnnullif there's no current session- Returns:
- the
HttpSessionassociated with this request ornullifcreateisfalseand 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:
getSessionin interfaceHttpServletRequest- Returns:
- the
HttpSessionassociated with this request - See Also:
HttpServletRequest.getSession(boolean)
-
changeSessionId
public java.lang.String changeSessionId()
The default behavior of this method is to call changeSessionId() on the wrapped request object.- Specified by:
changeSessionIdin interfaceHttpServletRequest- Returns:
- the new session ID allocated to the session
- Since:
- Servlet 3.1
- See Also:
HttpSessionIdListener
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.- Specified by:
isRequestedSessionIdValidin interfaceHttpServletRequest- Returns:
trueif this request has an id for a valid session in the current session context;falseotherwise- 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:
isRequestedSessionIdFromCookiein interfaceHttpServletRequest- Returns:
trueif the session ID came in as a 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:
isRequestedSessionIdFromURLin interfaceHttpServletRequest- Returns:
trueif the session ID came in as part of a URL; otherwise,false- See Also:
HttpServletRequest.getSession(boolean)
-
isRequestedSessionIdFromUrl
public boolean isRequestedSessionIdFromUrl()
Deprecated.As of Version 3.0 of the Java Servlet APIThe default behavior of this method is to return isRequestedSessionIdFromUrl() on the wrapped request object.- Specified by:
isRequestedSessionIdFromUrlin interfaceHttpServletRequest- Returns:
HttpServletRequest.isRequestedSessionIdFromURL()
-
authenticate
public boolean authenticate(HttpServletResponse response) throws java.io.IOException, ServletException
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:
authenticatein interfaceHttpServletRequest- Parameters:
response- The response to use to return any authentication challenge- Returns:
trueif the user is successfully authenticated andfalseif not- Throws:
java.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 failure- Since:
- Servlet 3.0
-
login
public void login(java.lang.String username, java.lang.String password) throws ServletExceptionAuthenticate 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 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
public void logout() throws ServletExceptionRemoves 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 interfaceHttpServletRequest- Throws:
ServletException- If the logout fails- Since:
- Servlet 3.0
-
getParts
public java.util.Collection<Part> getParts() throws java.io.IOException, ServletException
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:
getPartsin interfaceHttpServletRequest- Returns:
- A collection of all uploaded Parts.
- Throws:
java.io.IOException- if an I/O error occursServletException- if the request is not multipart/form-data- Since:
- Servlet 3.0
-
getPart
public Part getPart(java.lang.String name) throws java.io.IOException, ServletException
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:
getPartin interfaceHttpServletRequest- Parameters:
name- The name of the Part to obtain- Returns:
- The named Part or null if the Part does not exist
- Throws:
java.io.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(java.lang.Class<T> httpUpgradeHandlerClass) throws java.io.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 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:
java.io.IOException- if an I/O error occurred during the upgradeServletException- if the given httpUpgradeHandlerClass fails to be instantiated- Since:
- Servlet 3.1
-
-