NAME

Apache::Wombat::Request - Apache connector request class


SYNOPSIS


DESCRIPTION

Apache connector request class. Extends Wombat::Connector::HttpRequestBase. Overrides many superclass methods to delegate to an underlying Apache::Request instance.


CONSTRUCTOR

new()
Create and return an instance, initializing fields to default values.


METHODS

getAttribute($name)
Return the value of the named attribute from the Apache pnotes table.

Parameters:

$name
the name of the attribute

getAttributeNames()
Return an array containing the names of the attributes available in the Apache pnotes table.

removeAttribute($name)
Remove the named attribute from the Apache pnotes table.

Parameters:

$name
the name of the attribute

setAttribute($name, $value)
Set the named attribute in the Apache pnotes table.

Parameters:

$name
the name of the attribute

$value
the value to be set, a scalar or a reference

getAuthType()
Return the authentication type used for this Request.

setAuthType($type)
Set the authentication type used for this request.

Parameters:

$type
the authentication type, as defined in Servlet::Http::HttpServletRequest

getDateHeader($name)
Return the value of the named header from the Apache headers_in table as the number of seconds since the epoch, or -1.

Parameters:

$name
the header name

addHeader($name, $value)
Add a value for the named request header to the Apache headers_in table.

Parameters:

$name
the parameter name

$value
the parameter value, scalar

getHeader($name)
Return the first value for the named request header from the Apache headers_in table.

getHeaderNames()
Return the names of all the request headers from the Apache headers_in table.

getHeaders($name)
Return the list of values for the named request header from the Apache headers_in table.

Parameters:

$name
the header name

clearHeaders()
Unset all request headers from the Apache headers_in table.

getMethod()
Return the HTTP request method used for this Request.

setMethod($method)
Set the HTTP request method used for this Request.

Parameters:

$method
the request method

getParameter($name)
Return the value of the named request parameter from the Apache::Request params structure. If more than one value is defined, return only the first one.

Parameters:

$name
the name of the parameter

getParameterNames()
Return an array containing the names of the parameters contained in the Apache::Request params structure.

getParameterValues($name)
Return an array containing all of the values of the named request parameter from the Apache::Request params structure.

Parameters:

$name
the name of the parameter

addParameter($name, @values)
Add a named parameter with one or more values to the Apache::Request params table.

Parameters:

$name
the name of the parameter to add

@values
a list of one or more parameter values, scalar or undef

clearParameters()
Clear the set of parameters from the Apache::Request params table.

getProtocol()
Return the name and version of the protocol used for the request.

setProtocol($protocol)
Set the name and version of the protocol used for the request in the form protocol/majorVersion.minorVersion.

Parameters:

$protocol
the name and version of the protocol

getQueryString()
Return the query string for this Request.

setQueryString($query)
Set the query string for this Request. This is normally called by the Connector when it parses the request headers.

Parameters:

$query
the query string

getRemoteAddr()
Return the remote IP address of the client making this request.

setRemoteAddr($addr)
Set the remote IP address of the client making this request. This value will be used to resolve the name of the remote host if necessary (see getRemoteHost()).

Parameters:

$addr
the remote IP address

getRemoteHost()
Return the remote host name of the client making this request.

setRemoteHost($host)
Set the remote host name of the client making this request.

Parameters:

$host
the remote host name

getRequestRec()
Return the Apache request record for this Request.

setRequestRec($apr)
Set the Apache request record for this Request.

Parameters:

$apr
the Apache::Request instance

getRequestURI()
Return the request URI for this Request.

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

recycle()
Release all object references and initialize instances variables in preparation for use or reuse of this object.


SEE ALSO

Apache, the Apache::Request manpage, the Apache::Table manpage, the Apache::Util manpage, the Wombat::Connector::HttpRequestBase manpage


AUTHOR

Brian Moseley, bcm@maz.org