|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.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
Has this response been committed by the application yet? |
protected byte[] |
buffer
The buffer through which all of our output bytes are passed. |
protected int |
bufferCount
The number of data bytes currently in the buffer. |
protected boolean |
committed
Has this response been committed yet? |
protected Connector |
connector
The Connector through which this Response is returned. |
protected int |
contentCount
The actual number of bytes written to this Response. |
protected int |
contentLength
The content length associated with this Response. |
protected java.lang.String |
contentType
The content type associated with this Response. |
protected Context |
context
The Context within which this Response is being produced. |
protected java.lang.String |
encoding
The character encoding associated with this Response. |
protected boolean |
error
Error flag. |
protected ResponseFacade |
facade
The facade associated with this response. |
protected boolean |
included
Are we currently processing inside a RequestDispatcher.include()? |
protected static java.lang.String |
info
Descriptive information about this Response implementation. |
protected java.util.Locale |
locale
The Locale associated with this Response. |
protected java.io.OutputStream |
output
The output stream associated with this Response. |
protected Request |
request
The Request with which this Response is associated. |
protected static StringManager |
sm
The string manager for this package. |
protected javax.servlet.ServletOutputStream |
stream
The ServletOutputStream that has been returned by getOutputStream() , if any. |
protected boolean |
suspended
Has this response output been suspended? |
protected java.io.PrintWriter |
writer
The PrintWriter that has been returned by getWriter() , if any. |
Constructor Summary | |
ResponseBase()
|
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. |
void |
flushBuffer()
Flush the buffer and commit this response. |
int |
getBufferSize()
Return the actual buffer size used for this Response. |
java.lang.String |
getCharacterEncoding()
Return the character encoding used for this Response. |
Connector |
getConnector()
Return the Connector through which this Response will be transmitted. |
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.util.Locale |
getLocale()
Return the Locale assigned to this response. |
javax.servlet.ServletOutputStream |
getOutputStream()
Return the servlet output stream associated with this Response. |
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. |
java.io.PrintWriter |
getWriter()
Return the writer associated with this Response. |
boolean |
isAppCommitted()
Application commit flag accessor. |
boolean |
isCommitted()
Has the output of this response already been committed? |
boolean |
isError()
Error flag accessor. |
boolean |
isSuspended()
Suspended flag accessor. |
void |
recycle()
Release all object references, and initialize instance variables, in preparation for reuse of this object. |
void |
reset()
Clear any content written to the buffer. |
void |
resetBuffer()
Reset the data buffer but not any status or header information. |
void |
setAppCommitted(boolean appCommitted)
Set the application commit flag. |
void |
setBufferSize(int size)
Set the buffer size to be used for this Response. |
void |
setConnector(Connector connector)
Set the Connector through which this Response will be transmitted. |
void |
setContentLength(int length)
Set the content length (in bytes) for this Response. |
void |
setContentType(java.lang.String type)
Set the content type for this Response. |
void |
setContext(Context context)
Set the Context with which this Response is associated. |
void |
setError()
Set the error flag. |
void |
setIncluded(boolean included)
Set the "processing inside an include" flag. |
void |
setLocale(java.util.Locale locale)
Set the Locale that is appropriate for this response, including setting the appropriate character encoding. |
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. |
void |
setSuspended(boolean suspended)
Set the suspended flag. |
void |
write(byte[] b)
Write b.length bytes from the specified byte array
to our output stream. |
void |
write(byte[] b,
int off,
int len)
Write len bytes from the specified byte array, starting
at the specified offset, to our output stream. |
void |
write(int b)
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 |
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)
appCommitted
- The new application committed flag valuepublic boolean isAppCommitted()
public Connector getConnector()
public void setConnector(Connector connector)
connector
- The new connectorpublic int getContentCount()
public Context getContext()
public void setContext(Context context)
context
- The associated Contextpublic boolean getIncluded()
public void setIncluded(boolean included)
included
- true
if we are currently inside a
RequestDispatcher.include(), else false
public java.lang.String getInfo()
<description>/<version>
.public Request getRequest()
public void setRequest(Request request)
request
- The new associated requestpublic javax.servlet.ServletResponse getResponse()
ServletResponse
for which this object
is the facade.public java.io.OutputStream getStream()
public void setStream(java.io.OutputStream stream)
stream
- The new output streampublic void setSuspended(boolean suspended)
suspended
- The new suspended flag valuepublic boolean isSuspended()
public void setError()
public boolean isError()
public javax.servlet.ServletOutputStream createOutputStream() throws java.io.IOException
public void finishResponse() throws java.io.IOException
public int getContentLength()
public java.lang.String getContentType()
null
if no content type was set.public java.io.PrintWriter getReporter()
public void recycle()
public void write(int b) throws java.io.IOException
b
- The byte to be writtenpublic 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 writtenpublic 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 writtenpublic void flushBuffer() throws java.io.IOException
public int getBufferSize()
public java.lang.String getCharacterEncoding()
public javax.servlet.ServletOutputStream getOutputStream() throws java.io.IOException
getWriter
has
already been called for this responsepublic java.util.Locale getLocale()
public java.io.PrintWriter getWriter() throws java.io.IOException
getOutputStream
has
already been called for this responsepublic boolean isCommitted()
public void reset()
public void resetBuffer()
public void setBufferSize(int size)
size
- The new buffer sizepublic void setContentLength(int length)
length
- The new content lengthpublic void setContentType(java.lang.String type)
type
- The new content typepublic void setLocale(java.util.Locale locale)
locale
- The new locale
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |