|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.servlet.ServletRequestWrapper javax.servlet.http.HttpServletRequestWrapper
public class HttpServletRequestWrapper
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.
HttpServletRequest
Field Summary |
---|
Fields inherited from interface javax.servlet.http.HttpServletRequest |
---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Constructor Summary | |
---|---|
HttpServletRequestWrapper(HttpServletRequest request)
Constructs a request object wrapping the given request. |
Method Summary | |
---|---|
boolean |
authenticate(HttpServletResponse response)
The default behavior of this method is to call authenticate 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. |
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)
The default behavior of this method is to call getPart on the wrapped request object. |
java.util.Collection<Part> |
getParts()
The default behavior of this method is to call getParts on the wrapped request object. |
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.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()
The default behavior of this method is to return isRequestedSessionIdFromUrl() on the wrapped request object. |
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 |
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)
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HttpServletRequestWrapper(HttpServletRequest request)
java.lang.IllegalArgumentException
- if the request is nullMethod Detail |
---|
public java.lang.String getAuthType()
getAuthType
in interface HttpServletRequest
null
if the request was
not authenticated.public Cookie[] getCookies()
getCookies
in interface HttpServletRequest
Cookies
included with this request, or null
if the request has no cookiespublic long getDateHeader(java.lang.String name)
getDateHeader
in interface HttpServletRequest
name
- a String
specifying the
name of the header
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
requestpublic java.lang.String getHeader(java.lang.String name)
getHeader
in interface HttpServletRequest
name
- a String
specifying the
header name
String
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 HttpServletRequest
name
- a String
specifying the
header name
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 nullpublic java.util.Enumeration<java.lang.String> getHeaderNames()
getHeaderNames
in interface HttpServletRequest
null
public int getIntHeader(java.lang.String name)
getIntHeader
in interface HttpServletRequest
name
- a String
specifying the name
of a request header
public java.lang.String getMethod()
getMethod
in interface HttpServletRequest
String
specifying the name
of the method with which
this request was madepublic java.lang.String getPathInfo()
getPathInfo
in interface HttpServletRequest
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;
or null
if the URL does not have
any extra path informationpublic java.lang.String getPathTranslated()
getPathTranslated
in interface HttpServletRequest
String
specifying the
real path, or null
if
the URL does not have any extra path
informationpublic java.lang.String getContextPath()
getContextPath
in interface HttpServletRequest
String
specifying the
portion of the request URI that indicates the context
of the requestServletContext.getContextPath()
public java.lang.String getQueryString()
getQueryString
in interface HttpServletRequest
String
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 HttpServletRequest
String
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 HttpServletRequest
role
- a String
specifying the name
of the role
boolean
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 HttpServletRequest
java.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 HttpServletRequest
String
specifying the session
ID, or null
if the request did
not specify a session IDHttpServletRequest.isRequestedSessionIdValid()
public java.lang.String getRequestURI()
getRequestURI
in interface HttpServletRequest
String
containing
the part of the URL from the
protocol name up to the query stringHttpUtils#getRequestURL
public java.lang.StringBuffer getRequestURL()
getRequestURL
in interface HttpServletRequest
StringBuffer
object containing
the reconstructed URLpublic java.lang.String getServletPath()
getServletPath
in interface HttpServletRequest
String
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 HttpServletRequest
create
- true
to create
a new session for this request if necessary;
false
to return null
if there's no current session
HttpSession
associated
with this request or null
if
create
is false
and the request has no valid sessionHttpServletRequest.getSession()
public HttpSession getSession()
getSession
in interface HttpServletRequest
HttpSession
associated
with this requestHttpServletRequest.getSession(boolean)
public boolean isRequestedSessionIdValid()
isRequestedSessionIdValid
in interface HttpServletRequest
true
if this
request has an id for a valid session
in the current session context;
false
otherwiseHttpServletRequest.getRequestedSessionId()
,
HttpServletRequest.getSession(boolean)
,
HttpSessionContext
public boolean isRequestedSessionIdFromCookie()
isRequestedSessionIdFromCookie
in interface HttpServletRequest
true
if the session ID
came in as a
cookie; otherwise, false
HttpServletRequest.getSession(boolean)
public boolean isRequestedSessionIdFromURL()
isRequestedSessionIdFromURL
in interface HttpServletRequest
true
if the session ID
came in as part of a URL; otherwise,
false
HttpServletRequest.getSession(boolean)
public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl
in interface HttpServletRequest
public boolean authenticate(HttpServletResponse response) throws java.io.IOException, ServletException
authenticate
in interface HttpServletRequest
response
- The HttpServletResponse
associated with this HttpServletRequest
true
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.
java.io.IOException
- if an input or output error occurred while
reading from this request or writing to the given response
ServletException
- 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(java.lang.String username, java.lang.String password) throws ServletException
login
in interface HttpServletRequest
username
- 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 HttpServletRequest
ServletException
- if logout failspublic java.util.Collection<Part> getParts() throws java.io.IOException, ServletException
Any changes to the returned Collection
must not
affect this HttpServletRequestWrapper
.
getParts
in interface HttpServletRequest
Collection
of the
Part components of this request
java.io.IOException
- if an I/O error occurred during the retrieval
of the Part
components of this request
ServletException
- if this request is not of type
multipart/form-dataMultipartConfig.maxFileSize()
,
MultipartConfig.maxRequestSize()
public Part getPart(java.lang.String name) throws java.io.IOException, ServletException
getPart
in interface HttpServletRequest
name
- the name of the requested Part
java.io.IOException
- if an I/O error occurred during the retrieval
of the requested Part
ServletException
- if this request is not of type
multipart/form-dataMultipartConfig.maxFileSize()
,
MultipartConfig.maxRequestSize()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2009-2011, Oracle Corporation and/or its affiliates. All Rights Reserved. Use is subject to license terms.
Generated on 10-February-2011 12:41