Wombat::HttpRequest - internal http request interface
This interface extends Servlet::Http::HttpServletRequest and
Wombat::Request to provide fields and methods accessible only to
the container.
addCookie($cookie)
-
Add a Cookie to the set of Cookies for this Request.
Parameters:
- $cookie
-
the Servlet::Http::Cookie
- addHeader($name, $value)
-
Add a value for the named request header.
Parameters:
- $name
-
the parameter name
- $value
-
the parameter value, scalar
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:
- $type
-
the authentication type, as defined in
Servlet::Http::HttpServletRequest
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:
- $path
-
the context path
setMethod($method)
-
Set the HTTP request method used for this Request.
Parameters:
- $method
-
the request method
setQueryString($query)
-
Set the query string for this Request. This will normally be called by
the Connector when it parses the request headers.
Parameters:
- $query
-
the query string
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:
- $path
-
the path information
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:
- $flag
-
a boolean value
setRequestedSessionId($id)
-
Set the requested session ID for this Request. This is normally called
by the Connector when it parses the request headers.
Parameters:
- $id
-
the session id
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:
- $flag
-
a boolean value
setRequestURI($uri)
-
Set the unparsed request URI for this Request. This is normally called
by the Connector when it parses the request headers.
Parameters:
- $uri
-
the request URI
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:
- $path
-
the servlet path
setSession($session)
-
Set the internal Session associated with this Request.
Parameters:
- $session
-
The Wombat::Core::Session to set
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 the Wombat::Request manpage.
Parameters:
- $principal
-
the user principal
the Servlet::Http::Cookie manpage,
the Servlet::Http::HttpServletRequest manpage,
the Wombat::Request manpage
Brian Moseley, bcm@maz.org