| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.servlet.ServletRequestWrapper
javax.servlet.http.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 | |
|  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 | getHeaderNames()The default behavior of this method is to return getHeaderNames() on the wrapped request object. | 
|  java.util.Enumeration | 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. | 
|  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. | 
| 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, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding | 
| Constructor Detail | 
public HttpServletRequestWrapper(HttpServletRequest request)
java.lang.IllegalArgumentException - if the request is null| Method Detail | 
public java.lang.String getAuthType()
getAuthType in interface HttpServletRequestnull if the request was 
			not authenticated.public Cookie[] getCookies()
getCookies in interface HttpServletRequestCookies
			included with this request, or null
			if the request has no cookiespublic long getDateHeader(java.lang.String name)
getDateHeader in interface HttpServletRequestname - 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 HttpServletRequestname - 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 getHeaders(java.lang.String name)
getHeaders in interface HttpServletRequestname - 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 getHeaderNames()
getHeaderNames in interface HttpServletRequestnullpublic int getIntHeader(java.lang.String name)
getIntHeader in interface HttpServletRequestname - a String specifying the name
				of a request header
public java.lang.String getMethod()
getMethod in interface HttpServletRequestString 
				specifying the name
				of the method with which
				this request was madepublic java.lang.String getPathInfo()
getPathInfo in interface HttpServletRequestString, 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 HttpServletRequestString specifying the
			real path, or null if
			the URL does not have any extra path
			informationpublic java.lang.String getContextPath()
getContextPath in interface HttpServletRequestString specifying the
			portion of the request URI that indicates the context
			of the requestpublic java.lang.String getQueryString()
getQueryString in interface HttpServletRequestString 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 HttpServletRequestString 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 HttpServletRequestrole - 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 HttpServletRequestjava.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 HttpServletRequestString specifying the session
			ID, or null if the request did
			not specify a session IDHttpServletRequest.isRequestedSessionIdValid()public java.lang.String getRequestURI()
getRequestURI in interface HttpServletRequestString containing
			the part of the URL from the 
			protocol name up to the query stringHttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)public java.lang.StringBuffer getRequestURL()
getRequestURL in interface HttpServletRequestStringBuffer object containing
			the reconstructed URLpublic java.lang.String getServletPath()
getServletPath in interface HttpServletRequestString 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 HttpServletRequestcreate - 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 HttpServletRequestHttpSession associated
			with this requestHttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdValid()
isRequestedSessionIdValid in interface HttpServletRequesttrue if this
				request has an id for a valid session
				in the current session context;
				false otherwiseHttpServletRequest.getRequestedSessionId(), 
HttpServletRequest.getSession(boolean), 
HttpSessionContextpublic boolean isRequestedSessionIdFromCookie()
isRequestedSessionIdFromCookie in interface HttpServletRequesttrue if the session ID
				came in as a
				cookie; otherwise, falseHttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdFromURL()
isRequestedSessionIdFromURL in interface HttpServletRequesttrue if the session ID
				came in as part of a URL; otherwise,
				falseHttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl in interface HttpServletRequest| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.