org.apache.coyote.http11

Interface OutputFilter

All Superinterfaces:
OutputBuffer
Known Implementing Classes:
ChunkedOutputFilter, GzipOutputFilter, IdentityOutputFilter, VoidOutputFilter

public interface OutputFilter
extends OutputBuffer

Output filter.

Author:
Remy Maucherat

Method Summary

int
doWrite(ByteChunk chunk, Response unused)
Write some bytes.
long
end()
End the current request.
ByteChunk
getEncodingName()
Get the name of the encoding handled by this filter.
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.

Methods inherited from interface org.apache.coyote.OutputBuffer

doWrite

Method Details

doWrite

public int doWrite(ByteChunk chunk,
                   Response unused)
            throws IOException
Write some bytes.
Specified by:
doWrite in interface OutputBuffer

Returns:
number of bytes written by the filter


end

public long end()
            throws IOException
End the current request. It is acceptable to write extra bytes using buffer.doWrite during the execution of this method.

Returns:
Should return 0 unless the filter does some content length delimitation, in which case the number is the amount of extra bytes or missing bytes, which would indicate an error. Note: It is recommended that extra bytes be swallowed by the filter.


getEncodingName

public ByteChunk getEncodingName()
Get the name of the encoding handled by this filter.


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.


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.