OutputFilter.javaAPI DocApache Tomcat 6.0.142491Fri Jul 20 04:20:32 BST 2007org.apache.coyote.http11


public interface OutputFilter implements org.apache.coyote.OutputBuffer
Output filter.
Remy Maucherat

Fields Summary
Constructors Summary
Methods Summary
public intdoWrite(org.apache.tomcat.util.buf.ByteChunk chunk, org.apache.coyote.Response unused)
Write some bytes.

number of bytes written by the filter

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

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.

public org.apache.tomcat.util.buf.ByteChunkgetEncodingName()
Get the name of the encoding handled by this filter.

public voidrecycle()
Make the filter ready to process the next request.

public voidsetBuffer(org.apache.coyote.OutputBuffer buffer)
Set the next buffer in the filter pipeline.

public voidsetResponse(org.apache.coyote.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.