|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HttpRequest
An HttpRequest is the Catalina internal facade for an
HttpServletRequest
that is to be processed, in order to
produce the corresponding HttpResponse
.
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 |
addParameter(java.lang.String name,
java.lang.String[] values)
Add a parameter name and corresponding set of values to 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 |
clearParameters()
Clear the collection of parameters associated with this Request. |
MessageBytes |
getContextPathMB()
Get the context path. |
java.lang.String |
getDecodedRequestURI()
Get the decoded request URI. |
MessageBytes |
getDecodedRequestURIMB()
Get the decoded request URI. |
MessageBytes |
getPathInfoMB()
Get the path info. |
MessageBytes |
getRequestPathMB()
Get the request path. |
MessageBytes |
getServletPathMB()
Get the servlet path. |
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 |
setDecodedRequestURI(java.lang.String uri)
Set the decoded request URI. |
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 interface org.apache.catalina.Request |
---|
createInputStream, finishRequest, getAuthorization, getConnector, getContext, getFilterChain, getHost, getInfo, getNote, getNoteNames, getRequest, getResponse, getSocket, getStream, getValveContext, getWrapper, recycle, removeNote, setAuthorization, setConnector, setContentLength, setContentType, setContext, setFilterChain, setHost, setNote, setProtocol, setRemoteAddr, setResponse, setScheme, setSecure, setServerName, setServerPort, setSocket, setStream, setValveContext, setWrapper |
Method Detail |
---|
void addCookie(javax.servlet.http.Cookie cookie)
cookie
- The new cookievoid addHeader(java.lang.String name, java.lang.String value)
name
- The new header namevalue
- The new header valuevoid addLocale(java.util.Locale locale)
locale
- The new preferred Localevoid addParameter(java.lang.String name, java.lang.String[] values)
name
- Name of this request parametervalues
- Corresponding values for this request parametervoid clearCookies()
void clearHeaders()
void clearLocales()
void clearParameters()
void setAuthType(java.lang.String type)
null
. Typical values are "BASIC",
"DIGEST", or "SSL".
type
- The authentication type usedMessageBytes getContextPathMB()
void setContextPath(java.lang.String path)
path
- The context pathvoid setMethod(java.lang.String method)
method
- The request methodvoid setQueryString(java.lang.String query)
query
- The query stringMessageBytes getPathInfoMB()
void setPathInfo(java.lang.String path)
path
- The path informationMessageBytes getRequestPathMB()
void setRequestedSessionCookie(boolean flag)
flag
- The new flagvoid setRequestedSessionId(java.lang.String id)
id
- The new session idvoid setRequestedSessionURL(boolean flag)
flag
- The new flagvoid setRequestURI(java.lang.String uri)
uri
- The request URIvoid setDecodedRequestURI(java.lang.String uri)
uri
- The decoded request URIjava.lang.String getDecodedRequestURI()
MessageBytes getDecodedRequestURIMB()
MessageBytes getServletPathMB()
void setServletPath(java.lang.String path)
path
- The servlet pathvoid setUserPrincipal(java.security.Principal principal)
getRemoteUser()
method.
principal
- The user Principal
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |