Save This Page
Home » glassfish-v2ur2-b04-src » org.apache » catalina » [javadoc | source]
org.apache.catalina
public interface: Response [javadoc | source]

All Known Implementing Classes:
    PECoyoteResponse, DummyResponse, HttpResponseWrapper, HttpResponse, CoyoteResponse, CoyoteResponse

A Response is the Catalina-internal facade for a ServletResponse that is to be produced, based on the processing of a corresponding Request.
Method from org.apache.catalina.Response Summary:
createOutputStream,   finishResponse,   getConnector,   getContentCount,   getContentLength,   getContentType,   getContext,   getDetailMessage,   getIncluded,   getInfo,   getReporter,   getRequest,   getResponse,   getStream,   isAppCommitted,   isError,   isSuspended,   recycle,   resetBuffer,   sendAcknowledgement,   setAppCommitted,   setConnector,   setContext,   setDetailMessage,   setError,   setIncluded,   setRequest,   setStream,   setSuspended
Method from org.apache.catalina.Response Detail:
 public ServletOutputStream createOutputStream() throws IOException
    Create and return a ServletOutputStream to write the content associated with this Response.
 public  void finishResponse() throws IOException
    Perform whatever actions are required to flush and close the output stream or writer, in a single operation.
 public Connector getConnector()
    Return the Connector through which this Response is returned.
 public int getContentCount()
    Return the number of bytes actually written to the output stream.
 public int getContentLength()
    Return the content length that was set or calculated for this Response.
 public String getContentType()
    Return the content type that was set or calculated for this response, or null if no content type was set.
 public Context getContext()
    Return the Context with which this Response is associated.
 public String getDetailMessage()
    Gets detail error message.
 public boolean getIncluded()
    Return the "processing inside an include" flag.
 public String getInfo()
    Return descriptive information about this Response implementation and the corresponding version number, in the format <description>/<version>.
 public PrintWriter getReporter() throws IOException
    Return a PrintWriter that can be used to render error messages, regardless of whether a stream or writer has already been acquired.
 public Request getRequest()
    Return the Request with which this Response is associated.
 public ServletResponse getResponse()
    Return the ServletResponse for which this object is the facade.
 public OutputStream getStream()
    Return the output stream associated with this Response.
 public boolean isAppCommitted()
    Application commit flag accessor.
 public boolean isError()
    Error flag accessor.
 public boolean isSuspended()
    Suspended flag accessor.
 public  void recycle()
    Release all object references, and initialize instance variables, in preparation for reuse of this object.
 public  void resetBuffer()
    Reset the data buffer but not any status or header information.
 public  void sendAcknowledgement() throws IOException
    Send an acknowledgment of a request.
 public  void setAppCommitted(boolean appCommitted)
    Set the application commit flag.
 public  void setConnector(Connector connector)
    Set the Connector through which this Response is returned.
 public  void setContext(Context context)
    Set the Context with which this Response is associated. This should be called as soon as the appropriate Context is identified.
 public  void setDetailMessage(String message)
    Sets detail error message.
 public  void setError()
    Set the error flag.
 public  void setIncluded(boolean included)
    Set the "processing inside an include" flag.
 public  void setRequest(Request request)
    Set the Request with which this Response is associated.
 public  void setStream(OutputStream stream)
    Set the output stream associated with this Response.
 public  void setSuspended(boolean suspended)
    Set the suspended flag.