javax.servlet.http

Class HttpServletRequestWrapper

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: v 2.3

See Also: HttpServletRequest

Constructor Summary
HttpServletRequestWrapper(HttpServletRequest request)
Constructs a request object wrapping the given request.
Method Summary
StringgetAuthType()
The default behavior of this method is to return getAuthType() on the wrapped request object.
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(String name)
The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.
StringgetHeader(String name)
The default behavior of this method is to return getHeader(String name) on the wrapped request object.
EnumerationgetHeaderNames()
The default behavior of this method is to return getHeaderNames() on the wrapped request object.
EnumerationgetHeaders(String name)
The default behavior of this method is to return getHeaders(String name) on the wrapped request object.
intgetIntHeader(String name)
The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.
StringgetMethod()
The default behavior of this method is to return getMethod() on the wrapped request object.
StringgetPathInfo()
The default behavior of this method is to return getPathInfo() on the wrapped request object.
StringgetPathTranslated()
The default behavior of this method is to return getPathTranslated() on the wrapped request object.
StringgetQueryString()
The default behavior of this method is to return getQueryString() on the wrapped request object.
StringgetRemoteUser()
The default behavior of this method is to return getRemoteUser() on the wrapped request object.
StringgetRequestedSessionId()
The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.
StringgetRequestURI()
The default behavior of this method is to return getRequestURI() on the wrapped request object.
StringBuffergetRequestURL()
The default behavior of this method is to return getRequestURL() on the wrapped request object.
StringgetServletPath()
The default behavior of this method is to return getServletPath() 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.
HttpSessiongetSession()
The default behavior of this method is to return getSession() on the wrapped request object.
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()
The default behavior of this method is to return isRequestedSessionIdFromUrl() on the wrapped request object.
booleanisRequestedSessionIdFromURL()
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(String role)
The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.

Constructor Detail

HttpServletRequestWrapper

public HttpServletRequestWrapper(HttpServletRequest request)
Constructs a request object wrapping the given request.

Throws: java.lang.IllegalArgumentException if the request is null

Method Detail

getAuthType

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

getContextPath

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

getCookies

public Cookie[] getCookies()
The default behavior of this method is to return getCookies() on the wrapped request object.

getDateHeader

public long getDateHeader(String name)
The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.

getHeader

public String getHeader(String name)
The default behavior of this method is to return getHeader(String name) on the wrapped request object.

getHeaderNames

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

getHeaders

public Enumeration getHeaders(String name)
The default behavior of this method is to return getHeaders(String name) on the wrapped request object.

getIntHeader

public int getIntHeader(String name)
The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.

getMethod

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

getPathInfo

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

getPathTranslated

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

getQueryString

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

getRemoteUser

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

getRequestedSessionId

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

getRequestURI

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

getRequestURL

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

getServletPath

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

getSession

public HttpSession getSession(boolean create)
The default behavior of this method is to return getSession(boolean create) on the wrapped request object.

getSession

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

getUserPrincipal

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

isRequestedSessionIdFromCookie

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

isRequestedSessionIdFromUrl

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

isRequestedSessionIdFromURL

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

isRequestedSessionIdValid

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

isUserInRole

public boolean isUserInRole(String role)
The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.
Copyright © 1999-2002 The Apache Software Foundation. All Rights Reserved.