org.apache.catalina.connector
Class OutputBuffer

java.lang.Object
  java.io.Writer
      org.apache.catalina.connector.OutputBuffer

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, ByteChunk.ByteOutputChannel

public class OutputBuffer
extends java.io.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

DEFAULT_ENCODING

public static final java.lang.String DEFAULT_ENCODING

See Also:

Constant Field Values

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

encoders

protected final java.util.Map encoders

List of encoders.

conv

protected C2BConverter conv

Current char to byte converter.

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

setResponse

public void setResponse(Response coyoteResponse)

Associated Coyote response.

Parameters:

coyoteResponse - Associated Coyote response

getResponse

public Response getResponse()

Get associated Coyote response.

Returns:

the associated Coyote response

isSuspended

public boolean isSuspended()

Is the response output suspended ?

Returns:

suspended flag value

setSuspended

public void setSuspended(boolean suspended)

Set the suspended flag.

Parameters:

suspended - New suspended flag value

isClosed

public boolean isClosed()

Is the response output closed ?

Returns:

closed flag value

recycle

public void recycle()

Recycle the output buffer.

clearEncoders

public void clearEncoders()

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

close

public void close()
           throws java.io.IOException

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

Specified by:

close in interface java.io.Closeable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException - An underlying IOException occurred

flush

public void flush()
           throws java.io.IOException

Flush bytes or chars contained in the buffer.

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException - An underlying IOException occurred

doFlush

protected void doFlush(boolean realFlush)
                throws java.io.IOException

Flush bytes or chars contained in the buffer.

Throws:

java.io.IOException - An underlying IOException occurred

realWriteBytes

public void realWriteBytes(byte[] buf,
                           int off,
                           int cnt)
                    throws java.io.IOException

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

Specified by:

realWriteBytes in interface ByteChunk.ByteOutputChannel

Parameters:

buf - Byte buffer to be written to the response

off - Offset

cnt - Length

Throws:

java.io.IOException - An underlying IOException occurred

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Throws:

java.io.IOException

writeByte

public void writeByte(int b)
               throws java.io.IOException

Throws:

java.io.IOException

write

public void write(int c)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(char[] c)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(char[] c,
                  int off,
                  int len)
           throws java.io.IOException

Specified by:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String s,
                  int off,
                  int len)
           throws java.io.IOException

Append a string to the buffer

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String s)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

setEncoding

public void setEncoding(java.lang.String s)

checkConverter

public void checkConverter()
                    throws java.io.IOException

Throws:

java.io.IOException

setConverter

protected void setConverter()
                     throws java.io.IOException

Throws:

java.io.IOException

flushBytes

public void flushBytes()
                throws java.io.IOException

Real write - this buffer will be sent to the client

Throws:

java.io.IOException

getBytesWritten

public int getBytesWritten()

getCharsWritten

public int getCharsWritten()

getContentWritten

public int getContentWritten()

getContentWrittenLong

public long getContentWrittenLong()

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.

setBufferSize

public void setBufferSize(int size)

reset

public void reset()

getBufferSize

public int getBufferSize()