HttpServletRequestWrapper (Java EE 5 SDK)

javax.servlet.http Class HttpServletRequestWrapper

java.lang.Object
  javax.servlet.ServletRequestWrapper
      javax.servlet.http.HttpServletRequestWrapper

所有已实现的接口:

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.

从以下版本开始:

v 2.3

另请参见:

HttpServletRequest

HttpServletRequestWrapper

public HttpServletRequestWrapper(HttpServletRequest request)

Constructs a request object wrapping the given request.

抛出异常:

IllegalArgumentException - if the request is null

getAuthType

public String getAuthType()

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

规范说明:

getAuthType in interface HttpServletRequest

返回:

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

规范说明:

getCookies in interface HttpServletRequest

返回:

an array of all the Cookies included with this request, or null if the request has no cookies

getDateHeader

public long getDateHeader(String name)

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

规范说明:

getDateHeader in interface HttpServletRequest

参数:

name - a String specifying the name of the header

返回:

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 String getHeader(String name)

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

规范说明:

getHeader in interface HttpServletRequest

参数:

name - a String specifying the header name

返回:

a String containing the value of the requested header, or null if the request does not have a header of that name

getHeaders

public Enumeration getHeaders(String name)

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

规范说明:

getHeaders in interface HttpServletRequest

参数:

name - a String specifying the header name

返回:

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 Enumeration getHeaderNames()

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

规范说明:

getHeaderNames in interface HttpServletRequest

返回:

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(String name)

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

规范说明:

getIntHeader in interface HttpServletRequest

参数:

name - a String specifying the name of a request header

返回:

an integer expressing the value of the request header or -1 if the request doesn't have a header of this name

getMethod

public String getMethod()

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

规范说明:

getMethod in interface HttpServletRequest

返回:

a String specifying the name of the method with which this request was made

getPathInfo

public String getPathInfo()

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

规范说明:

getPathInfo in interface HttpServletRequest

返回:

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 String getPathTranslated()

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

规范说明:

getPathTranslated in interface HttpServletRequest

返回:

a String specifying the real path, or null if the URL does not have any extra path information

getContextPath

public String getContextPath()

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

规范说明:

getContextPath in interface HttpServletRequest

返回:

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

另请参见:

ServletContext.getContextPath()

getQueryString

public String getQueryString()

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

规范说明:

getQueryString in interface HttpServletRequest

返回:

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 String getRemoteUser()

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

规范说明:

getRemoteUser in interface HttpServletRequest

返回:

a String specifying the login of the user making this request, or null if the user login is not known

isUserInRole

public boolean isUserInRole(String role)

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

规范说明:

isUserInRole in interface HttpServletRequest

参数:

role - a String specifying the name of the role

返回:

a boolean indicating whether the user making this request belongs to a given role; false if the user has not been authenticated

getUserPrincipal

public Principal getUserPrincipal()

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

规范说明:

getUserPrincipal in interface HttpServletRequest

返回:

a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated

getRequestedSessionId

public String getRequestedSessionId()

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

规范说明:

getRequestedSessionId in interface HttpServletRequest

返回:

a String specifying the session ID, or null if the request did not specify a session ID

另请参见:

HttpServletRequest.isRequestedSessionIdValid()

getRequestURI

public String getRequestURI()

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

规范说明:

getRequestURI in interface HttpServletRequest

返回:

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

另请参见:

HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)

getRequestURL

public StringBuffer getRequestURL()

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

规范说明:

getRequestURL in interface HttpServletRequest

返回:

a StringBuffer object containing the reconstructed URL

getServletPath

public String getServletPath()

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

规范说明:

getServletPath in interface HttpServletRequest

返回:

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.

规范说明:

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

返回:

the HttpSession associated with this request or null if create is false and the request has no valid session

另请参见:

HttpServletRequest.getSession()

getSession

public HttpSession getSession()

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

规范说明:

getSession in interface HttpServletRequest

返回:

the HttpSession associated with this request

另请参见:

HttpServletRequest.getSession(boolean)

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

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

规范说明:

isRequestedSessionIdValid in interface HttpServletRequest

返回:

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

另请参见:

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.

规范说明:

isRequestedSessionIdFromCookie in interface HttpServletRequest

返回:

true if the session ID came in as a cookie; otherwise, false

另请参见:

HttpServletRequest.getSession(boolean)

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

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

规范说明:

isRequestedSessionIdFromURL in interface HttpServletRequest

返回:

true if the session ID came in as part of a URL; otherwise, false

另请参见:

HttpServletRequest.getSession(boolean)

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

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

规范说明:

isRequestedSessionIdFromUrl in interface HttpServletRequest

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。深圳电信培训中心.徐海蛟老师教学参考.