|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.catalina.connector.RequestWrapper | +--org.apache.catalina.connector.HttpRequestWrapper
Abstract convenience class that wraps a Catalina-internal HttpRequest object. By default, all methods are delegated to the wrapped request, but subclasses can override individual methods as required to provide the functionality that they require.
Fields inherited from class org.apache.catalina.connector.RequestWrapper |
request |
Constructor Summary | |
HttpRequestWrapper(HttpRequest request)
Deprecated. Construct a wrapper for the specified request. |
Method Summary | |
void |
addCookie(javax.servlet.http.Cookie cookie)
Deprecated. Add a Cookie to the set of Cookies associated with this Request. |
void |
addHeader(java.lang.String name,
java.lang.String value)
Deprecated. Add a Header to the set of Headers associated with this Request. |
void |
addLocale(java.util.Locale locale)
Deprecated. Add a Locale to the set of preferred Locales for this Request. |
void |
clearCookies()
Deprecated. Clear the collection of Cookies associated with this Request. |
void |
clearHeaders()
Deprecated. Clear the collection of Headers associated with this Request. |
void |
clearLocales()
Deprecated. Clear the collection of Locales associated with this Request. |
void |
setAuthType(java.lang.String type)
Deprecated. Set the authentication type used for this request, if any; otherwise set the type to null . |
void |
setContextPath(java.lang.String path)
Deprecated. Set the context path for this Request. |
void |
setMethod(java.lang.String method)
Deprecated. Set the HTTP request method used for this Request. |
void |
setPathInfo(java.lang.String path)
Deprecated. Set the path information for this Request. |
void |
setQueryString(java.lang.String query)
Deprecated. Set the query string for this Request. |
void |
setRequestedSessionCookie(boolean flag)
Deprecated. Set a flag indicating whether or not the requested session ID for this request came in through a cookie. |
void |
setRequestedSessionId(java.lang.String id)
Deprecated. Set the requested session ID for this request. |
void |
setRequestedSessionURL(boolean flag)
Deprecated. Set a flag indicating whether or not the requested session ID for this request came in through a URL. |
void |
setRequestURI(java.lang.String uri)
Deprecated. Set the unparsed request URI for this Request. |
void |
setServletPath(java.lang.String path)
Deprecated. Set the servlet path for this Request. |
void |
setUserPrincipal(java.security.Principal principal)
Deprecated. Set the Principal who has been authenticated for this Request. |
Methods inherited from class org.apache.catalina.connector.RequestWrapper |
createInputStream, finishRequest, getAuthorization, getConnector, getContext, getInfo, getRequest, getResponse, getSocket, getStream, getWrappedRequest, getWrapper, recycle, setAuthorization, setConnector, setContentLength, setContentType, setContext, setProtocol, setRemoteAddr, setResponse, setScheme, setSecure, setServerName, setServerPort, setSocket, setStream, setWrapper |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.catalina.HttpRequest |
addParameter, clearParameters, getDecodedRequestURI, setDecodedRequestURI |
Methods inherited from interface org.apache.catalina.Request |
createInputStream, finishRequest, getAuthorization, getConnector, getContext, getInfo, getNote, getNoteNames, getRequest, getResponse, getSocket, getStream, getWrapper, recycle, removeNote, setAuthorization, setConnector, setContentLength, setContentType, setContext, setNote, setProtocol, setRemoteAddr, setResponse, setScheme, setSecure, setServerName, setServerPort, setSocket, setStream, setWrapper |
Constructor Detail |
public HttpRequestWrapper(HttpRequest request)
request
- The request to be wrappedMethod Detail |
public void addCookie(javax.servlet.http.Cookie cookie)
addCookie
in interface HttpRequest
cookie
- The new cookiepublic void addHeader(java.lang.String name, java.lang.String value)
addHeader
in interface HttpRequest
name
- The new header namevalue
- The new header valuepublic void addLocale(java.util.Locale locale)
addLocale
in interface HttpRequest
locale
- The new preferred Localepublic void clearCookies()
clearCookies
in interface HttpRequest
public void clearHeaders()
clearHeaders
in interface HttpRequest
public void clearLocales()
clearLocales
in interface HttpRequest
public void setAuthType(java.lang.String type)
null
. Typical values are "BASIC",
"DIGEST", or "SSL".setAuthType
in interface HttpRequest
type
- The authentication type usedpublic void setContextPath(java.lang.String path)
setContextPath
in interface HttpRequest
path
- The context pathpublic void setMethod(java.lang.String method)
setMethod
in interface HttpRequest
method
- The request methodpublic void setQueryString(java.lang.String query)
setQueryString
in interface HttpRequest
query
- The query stringpublic void setPathInfo(java.lang.String path)
setPathInfo
in interface HttpRequest
path
- The path informationpublic void setRequestedSessionCookie(boolean flag)
setRequestedSessionCookie
in interface HttpRequest
flag
- The new flagpublic void setRequestedSessionId(java.lang.String id)
setRequestedSessionId
in interface HttpRequest
id
- The new session idpublic void setRequestedSessionURL(boolean flag)
setRequestedSessionURL
in interface HttpRequest
flag
- The new flagpublic void setRequestURI(java.lang.String uri)
setRequestURI
in interface HttpRequest
uri
- The request URIpublic void setServletPath(java.lang.String path)
setServletPath
in interface HttpRequest
path
- The servlet pathpublic void setUserPrincipal(java.security.Principal principal)
getRemoteUser()
method.setUserPrincipal
in interface HttpRequest
principal
- The user Principal
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |