HttpServletRequestWrapper (Java EE 6 ) (original) (raw)

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

HttpServletRequestWrapper

public HttpServletRequestWrapper(HttpServletRequest request)

Constructs a request object wrapping the given request.

Throws:

java.lang.IllegalArgumentException - if the request is null

getAuthType

public java.lang.String getAuthType()

The default behavior of this method is to return getAuthType() on the wrapped request object.

Specified by:

[getAuthType](../../../javax/servlet/http/HttpServletRequest.html#getAuthType%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

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, ornull if 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:

[getCookies](../../../javax/servlet/http/HttpServletRequest.html#getCookies%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

an array of all the Cookies included with this request, or null if 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:

[getDateHeader](../../../javax/servlet/http/HttpServletRequest.html#getDateHeader%28java.lang.String%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Parameters:

name - a String 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 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:

[getHeader](../../../javax/servlet/http/HttpServletRequest.html#getHeader%28java.lang.String%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Parameters:

name - a String specifying the header name

Returns:

a String containing the value of the requested header, or null if 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:

[getHeaders](../../../javax/servlet/http/HttpServletRequest.html#getHeaders%28java.lang.String%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Parameters:

name - a String 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

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:

[getHeaderNames](../../../javax/servlet/http/HttpServletRequest.html#getHeaderNames%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

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:

[getIntHeader](../../../javax/servlet/http/HttpServletRequest.html#getIntHeader%28java.lang.String%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Parameters:

name - a String 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

public java.lang.String getMethod()

The default behavior of this method is to return getMethod() on the wrapped request object.

Specified by:

[getMethod](../../../javax/servlet/http/HttpServletRequest.html#getMethod%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

a String specifying 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:

[getPathInfo](../../../javax/servlet/http/HttpServletRequest.html#getPathInfo%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

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; or null if 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:

[getPathTranslated](../../../javax/servlet/http/HttpServletRequest.html#getPathTranslated%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

a String specifying the real path, or null if 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:

[getContextPath](../../../javax/servlet/http/HttpServletRequest.html#getContextPath%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

a String specifying the portion of the request URI that indicates the context of the request

See Also:

ServletContext.getContextPath()

getQueryString

public java.lang.String getQueryString()

The default behavior of this method is to return getQueryString() on the wrapped request object.

Specified by:

[getQueryString](../../../javax/servlet/http/HttpServletRequest.html#getQueryString%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

a String containing the query string or null if 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:

[getRemoteUser](../../../javax/servlet/http/HttpServletRequest.html#getRemoteUser%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

a String specifying the login of the user making this request, or null if 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:

[isUserInRole](../../../javax/servlet/http/HttpServletRequest.html#isUserInRole%28java.lang.String%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Parameters:

role - a String 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

public java.security.Principal getUserPrincipal()

The default behavior of this method is to return getUserPrincipal() on the wrapped request object.

Specified by:

[getUserPrincipal](../../../javax/servlet/http/HttpServletRequest.html#getUserPrincipal%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

a java.security.Principal containing the name of the user making this request;null if 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:

[getRequestedSessionId](../../../javax/servlet/http/HttpServletRequest.html#getRequestedSessionId%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

a String specifying the session ID, or null if 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:

[getRequestURI](../../../javax/servlet/http/HttpServletRequest.html#getRequestURI%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

a String containing the part of the URL from the protocol name up to the query string

See Also:

HttpUtils#getRequestURL

getRequestURL

public java.lang.StringBuffer getRequestURL()

The default behavior of this method is to return getRequestURL() on the wrapped request object.

Specified by:

[getRequestURL](../../../javax/servlet/http/HttpServletRequest.html#getRequestURL%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

a StringBuffer object 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:

[getServletPath](../../../javax/servlet/http/HttpServletRequest.html#getServletPath%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

a 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.

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:

[getSession](../../../javax/servlet/http/HttpServletRequest.html#getSession%28boolean%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Parameters:

create - true to create a new session for this request if necessary; false to return null if there's no current session

Returns:

the HttpSession associated with this request or null ifcreate is false and 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:

[getSession](../../../javax/servlet/http/HttpServletRequest.html#getSession%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

the HttpSession associated with this request

See Also:

HttpServletRequest.getSession(boolean)

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.

Specified by:

[isRequestedSessionIdValid](../../../javax/servlet/http/HttpServletRequest.html#isRequestedSessionIdValid%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

true if this request has an id for a valid session in the current session context;false otherwise

See Also:

HttpServletRequest.getRequestedSessionId(), HttpServletRequest.getSession(boolean), HttpSessionContext

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.

Specified by:

[isRequestedSessionIdFromCookie](../../../javax/servlet/http/HttpServletRequest.html#isRequestedSessionIdFromCookie%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

true if 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:

[isRequestedSessionIdFromURL](../../../javax/servlet/http/HttpServletRequest.html#isRequestedSessionIdFromURL%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

true if the session ID came in as part of a URL; 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:

[isRequestedSessionIdFromUrl](../../../javax/servlet/http/HttpServletRequest.html#isRequestedSessionIdFromUrl%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

authenticate

public boolean authenticate(HttpServletResponse response) throws java.io.IOException, ServletException

The default behavior of this method is to call authenticate on the wrapped request object.

Specified by:

[authenticate](../../../javax/servlet/http/HttpServletRequest.html#authenticate%28javax.servlet.http.HttpServletResponse%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Parameters:

response - The HttpServletResponse associated with this HttpServletRequest

Returns:

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.

Throws:

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)

Since:

Servlet 3.0

login

public void login(java.lang.String username, java.lang.String password) throws ServletException

The default behavior of this method is to call login on the wrapped request object.

Specified by:

[login](../../../javax/servlet/http/HttpServletRequest.html#login%28java.lang.String, java.lang.String%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Parameters:

username - The String value corresponding to the login identifier of the user.

password - The password String corresponding to the identified user.

Throws:

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.

Since:

Servlet 3.0

logout

public void logout() throws ServletException

The default behavior of this method is to call login on the wrapped request object.

Specified by:

[logout](../../../javax/servlet/http/HttpServletRequest.html#logout%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Throws:

ServletException - if logout fails

Since:

Servlet 3.0

getParts

public java.util.Collection<Part> getParts() throws java.io.IOException, ServletException

The default behavior of this method is to call getParts on the wrapped request object.

Any changes to the returned Collection must not affect this HttpServletRequestWrapper.

Specified by:

[getParts](../../../javax/servlet/http/HttpServletRequest.html#getParts%28%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Returns:

a (possibly empty) Collection of the Part components of this request

Throws:

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 typemultipart/form-data

Since:

Servlet 3.0

See Also:

MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()

getPart

public Part getPart(java.lang.String name) throws java.io.IOException, ServletException

The default behavior of this method is to call getPart on the wrapped request object.

Specified by:

[getPart](../../../javax/servlet/http/HttpServletRequest.html#getPart%28java.lang.String%29) in interface [HttpServletRequest](../../../javax/servlet/http/HttpServletRequest.html "interface in javax.servlet.http")

Parameters:

name - the name of the requested Part

Returns:

The Part with the given name, or null if this request is of type multipart/form-data, but does not contain the requested Part

Throws:

java.io.IOException - if an I/O error occurred during the retrieval of the requested Part

ServletException - if this request is not of typemultipart/form-data

Since:

Servlet 3.0

See Also:

MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()

Submit a bug or feature

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

Scripting on this page tracks web page traffic, but does not change the content in any way.