|
|||||||||
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)
Construct a wrapper for the specified request. |
Method Summary | |
void |
addCookie(javax.servlet.http.Cookie cookie)
Add a Cookie to the set of Cookies associated with this Request. |
void |
addHeader(java.lang.String name,
java.lang.String value)
Add a Header to the set of Headers associated with this Request. |
void |
addLocale(java.util.Locale locale)
Add a Locale to the set of preferred Locales for this Request. |
void |
clearCookies()
Clear the collection of Cookies associated with this Request. |
void |
clearHeaders()
Clear the collection of Headers associated with this Request. |
void |
clearLocales()
Clear the collection of Locales associated with this Request. |
void |
setAuthType(java.lang.String type)
Set the authentication type used for this request, if any; otherwise set the type to null . |
void |
setContextPath(java.lang.String path)
Set the context path for this Request. |
void |
setMethod(java.lang.String method)
Set the HTTP request method used for this Request. |
void |
setPathInfo(java.lang.String path)
Set the path information for this Request. |
void |
setQueryString(java.lang.String query)
Set the query string for this Request. |
void |
setRequestedSessionCookie(boolean flag)
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)
Set the requested session ID for this request. |
void |
setRequestedSessionURL(boolean flag)
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)
Set the unparsed request URI for this Request. |
void |
setServletPath(java.lang.String path)
Set the servlet path for this Request. |
void |
setUserPrincipal(java.security.Principal principal)
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 |
Constructor Detail |
public HttpRequestWrapper(HttpRequest request)
request
- The request to be wrappedMethod Detail |
public void addCookie(javax.servlet.http.Cookie cookie)
cookie
- The new cookiepublic void addHeader(java.lang.String name, java.lang.String value)
name
- The new header namevalue
- The new header valuepublic void addLocale(java.util.Locale locale)
locale
- The new preferred Localepublic void clearCookies()
public void clearHeaders()
public void clearLocales()
public void setAuthType(java.lang.String type)
null
. Typical values are "BASIC",
"DIGEST", or "SSL".type
- The authentication type usedpublic void setContextPath(java.lang.String path)
path
- The context pathpublic void setMethod(java.lang.String method)
method
- The request methodpublic void setQueryString(java.lang.String query)
query
- The query stringpublic void setPathInfo(java.lang.String path)
path
- The path informationpublic void setRequestedSessionCookie(boolean flag)
flag
- The new flagpublic void setRequestedSessionId(java.lang.String id)
id
- The new session idpublic void setRequestedSessionURL(boolean flag)
flag
- The new flagpublic void setRequestURI(java.lang.String uri)
uri
- The request URIpublic void setServletPath(java.lang.String path)
path
- The servlet pathpublic void setUserPrincipal(java.security.Principal principal)
getRemoteUser()
method.principal
- The user Principal
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |