FileDocCategorySizeDatePackage
InputFilter.javaAPI DocApache Tomcat 6.0.142485Fri Jul 20 04:20:32 BST 2007org.apache.coyote.http11

InputFilter

public interface InputFilter implements org.apache.coyote.InputBuffer
Input filter interface.
author
Remy Maucherat

Fields Summary
Constructors Summary
Methods Summary
public intavailable()
Amount of bytes still available in a buffer.

public intdoRead(org.apache.tomcat.util.buf.ByteChunk chunk, org.apache.coyote.Request unused)
Read bytes.

return
Number of bytes read.

public longend()
End the current request.

return
0 is the expected return value. A positive value indicates that too many bytes were read. This method is allowed to use buffer.doRead to consume extra bytes. The result of this method can't be negative (if an error happens, an IOException should be thrown instead).

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.InputBuffer buffer)
Set the next buffer in the filter pipeline.

public voidsetRequest(org.apache.coyote.Request request)
Some filters need additional parameters from the request. All the necessary reading can occur in that method, as this method is called after the request header processing is complete.