org.apache.coyote.http11.filters

Class GzipOutputFilter

public class GzipOutputFilter extends Object implements OutputFilter

Gzip output filter.

Author: Remy Maucherat

Nested Class Summary
protected class	GzipOutputFilter.FakeOutputStream

Field Summary
protected OutputBuffer	buffer Next buffer in the pipeline.
protected GZIPOutputStream	compressionStream Compression output stream.
protected static ByteChunk	ENCODING
protected static String	ENCODING_NAME
protected OutputStream	fakeOutputStream Fake internal output stream.

Method Summary
int	doWrite(ByteChunk chunk, Response res) Write some bytes.
long	end() End the current request.
ByteChunk	getEncodingName() Return the name of the associated encoding; Here, the value is "identity".
void	recycle() Make the filter ready to process the next request.
void	setBuffer(OutputBuffer buffer) Set the next buffer in the filter pipeline.
void	setResponse(Response response) Some filters need additional parameters from the response.

Field Detail

buffer

protected OutputBuffer buffer

Next buffer in the pipeline.

compressionStream

protected GZIPOutputStream compressionStream

Compression output stream.

ENCODING

protected static final ByteChunk ENCODING

ENCODING_NAME

protected static final String ENCODING_NAME

fakeOutputStream

protected OutputStream fakeOutputStream

Fake internal output stream.

Method Detail

doWrite

public int doWrite(ByteChunk chunk, Response res)

Write some bytes.

Returns: number of bytes written by the filter

end

public long end()

End the current request. It is acceptable to write extra bytes using buffer.doWrite during the execution of this method.

getEncodingName

public ByteChunk getEncodingName()

Return the name of the associated encoding; Here, the value is "identity".

recycle

public void recycle()

Make the filter ready to process the next request.

setBuffer

public void setBuffer(OutputBuffer buffer)

Set the next buffer in the filter pipeline.

setResponse

public void setResponse(Response response)

Some filters need additional parameters from the response. All the necessary reading can occur in that method, as this method is called after the response header processing is complete.