|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.catalina.connector.ResponseWrapper
Abstract convenience class that wraps a Catalina-internal Response object. By default, all methods are delegated to the wrapped response, but subclasses can override individual methods as required to provide the functionality that they require.
Field Summary | |
protected Response |
response
The wrapped response. |
Constructor Summary | |
ResponseWrapper(Response response)
Construct a wrapper for the specified response. |
Method Summary | |
javax.servlet.ServletOutputStream |
createOutputStream()
Create and return a ServletOutputStream to write the content associated with this Response. |
void |
finishResponse()
Perform whatever actions are required to flush and close the output stream or writer, in a single operation. |
Connector |
getConnector()
Return the Connector through which this Response is returned. |
int |
getContentCount()
Return the number of bytes actually written to the output stream. |
int |
getContentLength()
Return the content length that was set or calculated for this Response. |
java.lang.String |
getContentType()
Return the content type that was set or calculated for this response, or null if no content type was set. |
Context |
getContext()
Return the Context with which this Response is associated. |
boolean |
getIncluded()
Return the "processing inside an include" flag. |
java.lang.String |
getInfo()
Return descriptive information about this Response implementation and the corresponding version number, in the format <description>/<version> . |
java.io.PrintWriter |
getReporter()
Return a PrintWriter that can be used to render error messages, regardless of whether a stream or writer has already been acquired. |
Request |
getRequest()
Return the Request with which this Response is associated. |
javax.servlet.ServletResponse |
getResponse()
Return the ServletResponse for which this object
is the facade. |
java.io.OutputStream |
getStream()
Return the output stream associated with this Response. |
Response |
getWrappedResponse()
Return the wrapped response. |
void |
recycle()
Release all object references, and initialize instance variables, in preparation for reuse of this object. |
void |
resetBuffer()
Reset the data buffer but not any status or header information. |
void |
setConnector(Connector connector)
Set the Connector through which this Response is returned. |
void |
setContext(Context context)
Set the Context with which this Response is associated. |
void |
setIncluded(boolean included)
Set the "processing inside an include" flag. |
void |
setRequest(Request request)
Set the Request with which this Response is associated. |
void |
setStream(java.io.OutputStream stream)
Set the output stream associated with this Response. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.catalina.Response |
isAppCommitted, isError, isSuspended, setAppCommitted, setError, setSuspended |
Field Detail |
protected Response response
Constructor Detail |
public ResponseWrapper(Response response)
response
- The response to be wrappedMethod Detail |
public Response getWrappedResponse()
public Connector getConnector()
getConnector
in interface Response
public void setConnector(Connector connector)
setConnector
in interface Response
connector
- The new connectorpublic int getContentCount()
getContentCount
in interface Response
public Context getContext()
getContext
in interface Response
public void setContext(Context context)
setContext
in interface Response
context
- The associated Contextpublic boolean getIncluded()
getIncluded
in interface Response
public void setIncluded(boolean included)
setIncluded
in interface Response
included
- true
if we are currently inside a
RequestDispatcher.include(), else false
public java.lang.String getInfo()
<description>/<version>
.
getInfo
in interface Response
public Request getRequest()
getRequest
in interface Response
public void setRequest(Request request)
setRequest
in interface Response
request
- The new associated requestpublic javax.servlet.ServletResponse getResponse()
ServletResponse
for which this object
is the facade.
getResponse
in interface Response
public java.io.OutputStream getStream()
getStream
in interface Response
public void setStream(java.io.OutputStream stream)
setStream
in interface Response
stream
- The new output streampublic javax.servlet.ServletOutputStream createOutputStream() throws java.io.IOException
createOutputStream
in interface Response
java.io.IOException
- if an input/output error occurspublic void finishResponse() throws java.io.IOException
finishResponse
in interface Response
java.io.IOException
- if an input/output error occurspublic int getContentLength()
getContentLength
in interface Response
public java.lang.String getContentType()
null
if no content type was set.
getContentType
in interface Response
public java.io.PrintWriter getReporter()
getReporter
in interface Response
public void recycle()
recycle
in interface Response
public void resetBuffer()
resetBuffer
in interface Response
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |