org.apache.catalina.connector

Class OutputBuffer

public class OutputBuffer extends Writer implements ByteChunk.ByteOutputChannel

The buffer used by Tomcat response. This is a derivative of the Tomcat 3.3 OutputBuffer, with the removal of some of the state handling (which in Coyote is mostly the Processor's responsability).

Author: Costin Manolache Remy Maucherat

Field Summary
protected C2BConverter	conv Current char to byte converter.
static int	DEFAULT_BUFFER_SIZE
static String	DEFAULT_ENCODING
protected HashMap	encoders List of encoders.

Constructor Summary
	OutputBuffer() Default constructor.
	OutputBuffer(int size) Alternate constructor which allows specifying the initial buffer size.

Method Summary
void	checkConverter()
void	clearEncoders() Clear cached encoders (to save memory for Comet requests).
void	close() Close the output buffer.
protected void	doFlush(boolean realFlush) Flush bytes or chars contained in the buffer.
void	flush() Flush bytes or chars contained in the buffer.
void	flushBytes() Real write - this buffer will be sent to the client
int	getBufferSize()
int	getBytesWritten()
int	getCharsWritten()
int	getContentWritten()
long	getContentWrittenLong()
Response	getResponse() Get associated Coyote response.
boolean	isClosed() Is the response output closed ?
boolean	isNew() True if this buffer hasn't been used ( since recycle() ) - i.e. no chars or bytes have been added to the buffer.
boolean	isSuspended() Is the response output suspended ?
void	realWriteBytes(byte[] buf, int off, int cnt) Sends the buffer data to the client output, checking the state of Response and calling the right interceptors.
void	recycle() Recycle the output buffer.
void	reset()
void	setBufferSize(int size)
protected void	setConverter()
void	setEncoding(String s)
void	setResponse(Response coyoteResponse) Associated Coyote response.
void	setSuspended(boolean suspended) Set the suspended flag.
void	write(byte[] b, int off, int len)
void	write(int c)
void	write(char[] c)
void	write(char[] c, int off, int len)
void	write(String s, int off, int len) Append a string to the buffer
void	write(String s)
void	writeByte(int b)

Field Detail

conv

protected C2BConverter conv

Current char to byte converter.

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

encoders

protected HashMap encoders

List of encoders.

Constructor Detail

OutputBuffer

public OutputBuffer()

Default constructor. Allocate the buffer with the default buffer size.

OutputBuffer

public OutputBuffer(int size)

Alternate constructor which allows specifying the initial buffer size.

Parameters: size Buffer size to use

Method Detail

checkConverter

public void checkConverter()

clearEncoders

public void clearEncoders()

Clear cached encoders (to save memory for Comet requests).

close

public void close()

Close the output buffer. This tries to calculate the response size if the response has not been committed yet.

Throws: IOException An underlying IOException occurred

doFlush

protected void doFlush(boolean realFlush)

Flush bytes or chars contained in the buffer.

Throws: IOException An underlying IOException occurred

flush

public void flush()

Flush bytes or chars contained in the buffer.

Throws: IOException An underlying IOException occurred

flushBytes

public void flushBytes()

Real write - this buffer will be sent to the client

getBufferSize

public int getBufferSize()

getBytesWritten

public int getBytesWritten()

getCharsWritten

public int getCharsWritten()

getContentWritten

public int getContentWritten()

getContentWrittenLong

public long getContentWrittenLong()

getResponse

public Response getResponse()

Get associated Coyote response.

Returns: the associated Coyote response

isClosed

public boolean isClosed()

Is the response output closed ?

Returns: closed flag value

isNew

public boolean isNew()

True if this buffer hasn't been used ( since recycle() ) - i.e. no chars or bytes have been added to the buffer.

isSuspended

public boolean isSuspended()

Is the response output suspended ?

Returns: suspended flag value

realWriteBytes

public void realWriteBytes(byte[] buf, int off, int cnt)

Sends the buffer data to the client output, checking the state of Response and calling the right interceptors.

Parameters: buf Byte buffer to be written to the response off Offset cnt Length

Throws: IOException An underlying IOException occurred

Parameters: coyoteResponse Associated Coyote response

setSuspended

public void setSuspended(boolean suspended)

Set the suspended flag.

Parameters: suspended New suspended flag value