Wombat::Response - internal response interface
This interface extends Servlet::ServletResponse to provide
fields and methods accessible only to the container.
- getApplication()
 
- 
Return the Application within which this Response is being generated.
- setApplication($application)
 
- 
Set the Application within which this Response is being generated. This
must be called as soon as the appropriate Application is identified.
Parameters: 
- $application
 
- 
the Wombat::Application within which the Response is being generated
 
- getConnector()
 
- 
Return the Connector through which this Response is returned.
- setConnector($connector)
 
- 
Set the Connector through which this response is returned.
Parameters: 
- $connector
 
- 
the Wombat::Connector that will return the response
 
- getContentCount()
 
- 
Return the number of bytes actually written to the output stream.
- isError()
 
- 
Return a flag indicating whether or not this is an error response.
- setError($flag)
 
- 
Set a flag indicating whether or not this is an error response.
Parameters: 
- $flag
 
- 
a boolean value indicating whether or not this is an error response
 
- isIncluded()
 
- 
Return a flag indicating whether or not this Response is being
processed as an include.
- setIncluded($flag)
 
- 
Set a flag indicating whether or not this Response is being processed
as an include.
Parameters: 
- $flag
 
- 
a boolean value indicating whether or not this response is included
 
- getHandle()
 
- 
Return the output handle associated with this Response.
- setHandle($handle)
 
- 
Set the input handle associated with this Response.
Parameters: 
- $handle
 
- 
the IO::Handle associated with this Response
 
- getRequest()
 
- 
Return the Request with which this Response is associated.
- setRequest($request)
 
- 
Set the Request with which this Response is associated.
Parameters: 
- $request
 
- 
the Wombat::Request with which this response is associated
 
- getResponse()
 
- 
Return the ServletResponse which acts as a facade for this Response to
servlet applications.
- createOutputHandle()
 
- 
Create and return a Servlet::ServletOutputHandle to write the content
associated with this Response.
Throws: 
- Servlet::Util::IOException
 
- 
if an input or output error occurs
 
- finishResponse()
 
- 
Perform whatever actions are required to flush and close the output
handle or writer.
Throws: 
- Servlet::Util::IOException
 
- 
if an input or output error occurs
 
- getContentLength()
 
- 
Return the content length, in bytes, that was set or calculated for
this Response.
- getContentType()
 
- 
Return the MIME type that was set or calculated for this response.
- recycle()
 
- 
Release all object references and initialize instances variables in
preparation for use or reuse of this object.
the IO::Handle manpage,
the Servlet::ServletResponse manpage,
the Servlet::ServletServletOutputHandle manpage,
the Servlet::Util::Exception manpage,
the Wombat::Application manpage,
the Wombat::Connector manpage,
the Wombat::Request manpage
Brian Moseley, bcm@maz.org