|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.catalina.connector.ResponseBase
Convenience base implementation of the Response interface, which can be used for the Response implementation required by most Connectors. Only the connector-specific methods need to be implemented.
| Field Summary | |
protected boolean |
appCommitted
Deprecated. Has this response been committed by the application yet? |
protected byte[] |
buffer
Deprecated. The buffer through which all of our output bytes are passed. |
protected int |
bufferCount
Deprecated. The number of data bytes currently in the buffer. |
protected boolean |
committed
Deprecated. Has this response been committed yet? |
protected Connector |
connector
Deprecated. The Connector through which this Response is returned. |
protected int |
contentCount
Deprecated. The actual number of bytes written to this Response. |
protected int |
contentLength
Deprecated. The content length associated with this Response. |
protected java.lang.String |
contentType
Deprecated. The content type associated with this Response. |
protected Context |
context
Deprecated. The Context within which this Response is being produced. |
protected java.lang.String |
encoding
Deprecated. The character encoding associated with this Response. |
protected boolean |
error
Deprecated. Error flag. |
protected ResponseFacade |
facade
Deprecated. The facade associated with this response. |
protected boolean |
included
Deprecated. Are we currently processing inside a RequestDispatcher.include()? |
protected static java.lang.String |
info
Deprecated. Descriptive information about this Response implementation. |
protected java.util.Locale |
locale
Deprecated. The Locale associated with this Response. |
protected java.io.OutputStream |
output
Deprecated. The output stream associated with this Response. |
protected Request |
request
Deprecated. The Request with which this Response is associated. |
protected static StringManager |
sm
Deprecated. The string manager for this package. |
protected javax.servlet.ServletOutputStream |
stream
Deprecated. The ServletOutputStream that has been returned by getOutputStream(), if any. |
protected boolean |
suspended
Deprecated. Has this response output been suspended? |
protected java.io.PrintWriter |
writer
Deprecated. The PrintWriter that has been returned by getWriter(), if any. |
| Constructor Summary | |
ResponseBase()
Deprecated. |
|
| Method Summary | |
javax.servlet.ServletOutputStream |
createOutputStream()
Deprecated. Create and return a ServletOutputStream to write the content associated with this Response. |
void |
finishResponse()
Deprecated. Perform whatever actions are required to flush and close the output stream or writer, in a single operation. |
void |
flushBuffer()
Deprecated. Flush the buffer and commit this response. |
int |
getBufferSize()
Deprecated. Return the actual buffer size used for this Response. |
java.lang.String |
getCharacterEncoding()
Deprecated. Return the character encoding used for this Response. |
Connector |
getConnector()
Deprecated. Return the Connector through which this Response will be transmitted. |
int |
getContentCount()
Deprecated. Return the number of bytes actually written to the output stream. |
int |
getContentLength()
Deprecated. Return the content length that was set or calculated for this Response. |
java.lang.String |
getContentType()
Deprecated. Return the content type that was set or calculated for this response, or null if no content type was set. |
Context |
getContext()
Deprecated. Return the Context with which this Response is associated. |
boolean |
getIncluded()
Deprecated. Return the "processing inside an include" flag. |
java.lang.String |
getInfo()
Deprecated. Return descriptive information about this Response implementation and the corresponding version number, in the format <description>/<version>. |
java.util.Locale |
getLocale()
Deprecated. Return the Locale assigned to this response. |
javax.servlet.ServletOutputStream |
getOutputStream()
Deprecated. Return the servlet output stream associated with this Response. |
java.io.PrintWriter |
getReporter()
Deprecated. Return a PrintWriter that can be used to render error messages, regardless of whether a stream or writer has already been acquired. |
Request |
getRequest()
Deprecated. Return the Request with which this Response is associated. |
javax.servlet.ServletResponse |
getResponse()
Deprecated. Return the ServletResponse for which this object
is the facade. |
java.io.OutputStream |
getStream()
Deprecated. Return the output stream associated with this Response. |
java.io.PrintWriter |
getWriter()
Deprecated. Return the writer associated with this Response. |
boolean |
isAppCommitted()
Deprecated. Application commit flag accessor. |
boolean |
isCommitted()
Deprecated. Has the output of this response already been committed? |
boolean |
isError()
Deprecated. Error flag accessor. |
boolean |
isSuspended()
Deprecated. Suspended flag accessor. |
void |
recycle()
Deprecated. Release all object references, and initialize instance variables, in preparation for reuse of this object. |
void |
reset()
Deprecated. Clear any content written to the buffer. |
void |
resetBuffer()
Deprecated. Reset the data buffer but not any status or header information. |
void |
setAppCommitted(boolean appCommitted)
Deprecated. Set the application commit flag. |
void |
setBufferSize(int size)
Deprecated. Set the buffer size to be used for this Response. |
void |
setConnector(Connector connector)
Deprecated. Set the Connector through which this Response will be transmitted. |
void |
setContentLength(int length)
Deprecated. Set the content length (in bytes) for this Response. |
void |
setContentType(java.lang.String type)
Deprecated. Set the content type for this Response. |
void |
setContext(Context context)
Deprecated. Set the Context with which this Response is associated. |
void |
setError()
Deprecated. Set the error flag. |
void |
setIncluded(boolean included)
Deprecated. Set the "processing inside an include" flag. |
void |
setLocale(java.util.Locale locale)
Deprecated. Set the Locale that is appropriate for this response, including setting the appropriate character encoding. |
void |
setRequest(Request request)
Deprecated. Set the Request with which this Response is associated. |
void |
setStream(java.io.OutputStream stream)
Deprecated. Set the output stream associated with this Response. |
void |
setSuspended(boolean suspended)
Deprecated. Set the suspended flag. |
void |
write(byte[] b)
Deprecated. Write b.length bytes from the specified byte array
to our output stream. |
void |
write(byte[] b,
int off,
int len)
Deprecated. Write len bytes from the specified byte array, starting
at the specified offset, to our output stream. |
void |
write(int b)
Deprecated. Write the specified byte to our output stream, flushing if necessary. |
| 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 |
sendAcknowledgement |
| Field Detail |
protected boolean appCommitted
protected byte[] buffer
protected int bufferCount
protected boolean committed
protected Connector connector
protected int contentCount
protected int contentLength
protected java.lang.String contentType
protected Context context
protected java.lang.String encoding
protected ResponseFacade facade
protected boolean included
protected static final java.lang.String info
protected java.util.Locale locale
protected java.io.OutputStream output
protected Request request
protected static StringManager sm
protected javax.servlet.ServletOutputStream stream
getOutputStream(), if any.
protected boolean suspended
protected java.io.PrintWriter writer
getWriter(), if any.
protected boolean error
| Constructor Detail |
public ResponseBase()
| Method Detail |
public void setAppCommitted(boolean appCommitted)
setAppCommitted in interface ResponseappCommitted - The new application committed flag valuepublic boolean isAppCommitted()
isAppCommitted in interface Responsepublic Connector getConnector()
getConnector in interface Responsepublic void setConnector(Connector connector)
setConnector in interface Responseconnector - The new connectorpublic int getContentCount()
getContentCount in interface Responsepublic Context getContext()
getContext in interface Responsepublic void setContext(Context context)
setContext in interface Responsecontext - The associated Contextpublic boolean getIncluded()
getIncluded in interface Responsepublic void setIncluded(boolean included)
setIncluded in interface Responseincluded - true if we are currently inside a
RequestDispatcher.include(), else falsepublic java.lang.String getInfo()
<description>/<version>.
getInfo in interface Responsepublic Request getRequest()
getRequest in interface Responsepublic void setRequest(Request request)
setRequest in interface Responserequest - The new associated requestpublic javax.servlet.ServletResponse getResponse()
ServletResponse for which this object
is the facade.
getResponse in interface Responsepublic java.io.OutputStream getStream()
getStream in interface Responsepublic void setStream(java.io.OutputStream stream)
setStream in interface Responsestream - The new output streampublic void setSuspended(boolean suspended)
setSuspended in interface Responsesuspended - The new suspended flag valuepublic boolean isSuspended()
isSuspended in interface Responsepublic void setError()
setError in interface Responsepublic boolean isError()
isError in interface Response
public javax.servlet.ServletOutputStream createOutputStream()
throws java.io.IOException
createOutputStream in interface Responsejava.io.IOException - if an input/output error occurs
public void finishResponse()
throws java.io.IOException
finishResponse in interface Responsejava.io.IOException - if an input/output error occurspublic int getContentLength()
getContentLength in interface Responsepublic java.lang.String getContentType()
null if no content type was set.
getContentType in interface Responsepublic java.io.PrintWriter getReporter()
getReporter in interface Responsepublic void recycle()
recycle in interface Response
public void write(int b)
throws java.io.IOException
b - The byte to be written
java.io.IOException - if an input/output error occurs
public void write(byte[] b)
throws java.io.IOException
b.length bytes from the specified byte array
to our output stream. Flush the output stream as necessary.
b - The byte array to be written
java.io.IOException - if an input/output error occurs
public void write(byte[] b,
int off,
int len)
throws java.io.IOException
len bytes from the specified byte array, starting
at the specified offset, to our output stream. Flush the output
stream as necessary.
b - The byte array containing the bytes to be writtenoff - Zero-relative starting offset of the bytes to be writtenlen - The number of bytes to be written
java.io.IOException - if an input/output error occurs
public void flushBuffer()
throws java.io.IOException
flushBuffer in interface javax.servlet.ServletResponsejava.io.IOException - if an input/output error occurspublic int getBufferSize()
getBufferSize in interface javax.servlet.ServletResponsepublic java.lang.String getCharacterEncoding()
getCharacterEncoding in interface javax.servlet.ServletResponse
public javax.servlet.ServletOutputStream getOutputStream()
throws java.io.IOException
getOutputStream in interface javax.servlet.ServletResponsejava.lang.IllegalStateException - if getWriter has
already been called for this response
java.io.IOException - if an input/output error occurspublic java.util.Locale getLocale()
getLocale in interface javax.servlet.ServletResponse
public java.io.PrintWriter getWriter()
throws java.io.IOException
getWriter in interface javax.servlet.ServletResponsejava.lang.IllegalStateException - if getOutputStream has
already been called for this response
java.io.IOException - if an input/output error occurspublic boolean isCommitted()
isCommitted in interface javax.servlet.ServletResponsepublic void reset()
reset in interface javax.servlet.ServletResponsejava.lang.IllegalStateException - if this response has already
been committedpublic void resetBuffer()
resetBuffer in interface Responsejava.lang.IllegalStateException - if the response has already
been committedpublic void setBufferSize(int size)
setBufferSize in interface javax.servlet.ServletResponsesize - The new buffer size
java.lang.IllegalStateException - if this method is called after
output has been committed for this responsepublic void setContentLength(int length)
setContentLength in interface javax.servlet.ServletResponselength - The new content lengthpublic void setContentType(java.lang.String type)
setContentType in interface javax.servlet.ServletResponsetype - The new content typepublic void setLocale(java.util.Locale locale)
setLocale in interface javax.servlet.ServletResponselocale - The new locale
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||