Package javax.servlet.http
Class HttpServletRequestWrapper
java.lang.Object
javax.servlet.ServletRequestWrapper
javax.servlet.http.HttpServletRequestWrapper
- All Implemented Interfaces:
HttpServletRequest
,ServletRequest
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:
- v 2.3
- See Also:
-
Field Summary
Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a request object wrapping the given request. -
Method Summary
Modifier and TypeMethodDescriptionThe 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.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.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.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 isRequestedSessionIdFromURL() on the wrapped request object.boolean
The default behavior of this method is to return isRequestedSessionIdValid() 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.Methods inherited from class javax.servlet.ServletRequestWrapper
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest
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
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding
-
Constructor Details
-
HttpServletRequestWrapper
Constructs a request object wrapping the given request.- 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)
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 reqest
-
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
-
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
, decoded 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, ornullinvalid input: '<'/code 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
containing the name or path of the servlet being called, as specified in the request URL, decoded.
-
getSession
The default behavior of this method is to return getSession(boolean create) on the wrapped request object.- Specified by:
getSession
in interfaceHttpServletRequest
- 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:
-
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:
-
isRequestedSessionIdFromUrl
public boolean isRequestedSessionIdFromUrl()The default behavior of this method is to return isRequestedSessionIdFromUrl() on the wrapped request object.- Specified by:
isRequestedSessionIdFromUrl
in interfaceHttpServletRequest
-