NAME
Wombat::HttpRequest - internal http request interface
SYNOPSIS
DESCRIPTION
This interface extends Servlet::Http::HttpServletRequest and Wombat::Request to provide fields and methods accessible only to the container.
PUBLIC METHODS
-
Add a Cookie to the set of Cookies for this Request.
Parameters:
-
the Servlet::Http::Cookie
-
- addHeader($name, $value)
-
Add a value for the named request header.
Parameters:
- clearCookies()
-
Remove all Cookies for this Request.
- clearHeaders()
-
Unset all headers for this Request.
- setAuthType($type)
-
Set the authentication type used for this request, or
undef
for no authentication.Parameters:
- setContextPath($path)
-
Set the context path for this Request. This will normally be called when the associated Application is mapping the Request to a particular Wrapper.
Parameters:
- setMethod($method)
-
Set the HTTP request method used for this Request.
Parameters:
- setQueryString($query)
-
Set the query string for this Request. This will normally be called by the Connector when it parses the request headers.
Parameters:
- setPathInfo($path)
-
Set the path information for this Request. This will normally be called when the associated Application is mapping the Request to a particular Wrapper.
Parameters:
- setRequestedSessionCookie($flag)
-
Set a flag indicating whether or not the requested session ID for this Request came in through a cookie. This is normally called by the Connector when it parses the request headers.
Parameters:
- setRequestedSessionId($id)
-
Set the requested session ID for this Request. This is normally called by the Connector when it parses the request headers.
Parameters:
- setRequestedSessionURL($flag)
-
Set a flag indicating whether or not the requested session ID for this Request came in through the request URL. This is normally called by the Connector when it parses the request headers.
Parameters:
- setRequestURI($uri)
-
Set the unparsed request URI for this Request. This is normally called by the Connector when it parses the request headers.
Parameters:
- setServletPath($path)
-
Set the servlet path for this Request. This is normally called when the associated Application is mapping the Request to a particular Wrapper.
Parameters:
- setSession($session)
-
Set the internal Session associated with this Request.
Parameters:
- setUserPrincipal($principal)
-
Set the principal that has been authenticated for this Request. This value is also used to calculate the value to be returned by "getRemoteUser()" in Wombat::Request.
Parameters:
SEE ALSO
Servlet::Http::Cookie, Servlet::Http::HttpServletRequest, Wombat::Request
AUTHOR
Brian Moseley, bcm@maz.org