Package org.apache.coyote.http11.filters
Class GzipOutputFilter
java.lang.Object
org.apache.coyote.http11.filters.GzipOutputFilter
- All Implemented Interfaces:
- HttpOutputBuffer,- OutputFilter,- OutputBuffer
Gzip output filter.
- Author:
- Remy Maucherat
- 
Nested Class SummaryNested Classes
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected HttpOutputBufferNext buffer in the pipeline.protected GZIPOutputStreamCompression output stream.protected final OutputStreamFake internal output stream.protected static final Log
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionintdoWrite(ByteBuffer chunk) Write the given data to the response.voidend()Finish writing the current response.voidflush()Added to allow flushing to happen for the gzip'ed outputstreamlongBytes written to the underlying socket.voidrecycle()Make the filter ready to process the next request.voidsetBuffer(HttpOutputBuffer buffer) Set the next buffer in the filter pipeline.voidsetResponse(Response response) Some filters need additional parameters from the response.
- 
Field Details- 
log
- 
bufferNext buffer in the pipeline.
- 
compressionStreamCompression output stream.
- 
fakeOutputStreamFake internal output stream.
 
- 
- 
Constructor Details- 
GzipOutputFilterpublic GzipOutputFilter()
 
- 
- 
Method Details- 
doWriteDescription copied from interface:OutputBufferWrite the given data to the response. The caller owns the chunks.- Specified by:
- doWritein interface- OutputBuffer
- Parameters:
- chunk- data to write
- Returns:
- The number of bytes written which may be less than available in the input chunk
- Throws:
- IOException- an underlying I/O error occurred
 
- 
getBytesWrittenpublic long getBytesWritten()Description copied from interface:OutputBufferBytes written to the underlying socket. This includes the effects of chunking, compression, etc.- Specified by:
- getBytesWrittenin interface- OutputBuffer
- Returns:
- Bytes written for the current request
 
- 
flushAdded to allow flushing to happen for the gzip'ed outputstream- Specified by:
- flushin interface- HttpOutputBuffer
- Throws:
- IOException- If an I/O error occurs while flushing
 
- 
setResponseDescription copied from interface:OutputFilterSome 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.- Specified by:
- setResponsein interface- OutputFilter
- Parameters:
- response- The response to associate with this OutputFilter
 
- 
setBufferDescription copied from interface:OutputFilterSet the next buffer in the filter pipeline.- Specified by:
- setBufferin interface- OutputFilter
- Parameters:
- buffer- The next buffer instance
 
- 
endDescription copied from interface:HttpOutputBufferFinish writing the current response. It is acceptable to write extra bytes usingOutputBuffer.doWrite(java.nio.ByteBuffer)during the execution of this method.- Specified by:
- endin interface- HttpOutputBuffer
- Throws:
- IOException- If an I/O error occurs while writing to the client
 
- 
recyclepublic void recycle()Make the filter ready to process the next request.- Specified by:
- recyclein interface- OutputFilter
 
 
-