Top Description Methods
org.apache.coyote.http11

public Interface InputFilter

extends InputBuffer
Known Direct Implementers
org.apache.coyote.http11.filters.BufferedInputFilter, org.apache.coyote.http11.filters.ChunkedInputFilter, org.apache.coyote.http11.filters.IdentityInputFilter, org.apache.coyote.http11.filters.SavedRequestInputFilter, org.apache.coyote.http11.filters.VoidInputFilter
Imports
java.io.IOException, org.apache.coyote.InputBuffer, .Request, org.apache.tomcat.util.buf.ByteChunk

Input filter interface.
Author
Remy Maucherat

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

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).
end
()

End the current request.

public ByteChunk

Returns:

The encoding name as a byte chunk to facilitate comparison with the value read from the HTTP headers which will also be a ByteChunk
getEncodingName
()

Get the name of the encoding handled by this filter.

public boolean

Returns:

true if the request body has been fully read, otherwise false
isFinished
()

Has the request body been read fully?

public void
recycle()

Make the filter ready to process the next request.

public void
setBuffer(InputBuffer
The next buffer
buffer
)

Set the next buffer in the filter pipeline.

public void
setRequest(Request
The request to be associated with this filter
request
)

Some filters need additional parameters from the request.

Inherited from org.apache.coyote.InputBuffer:
availabledoRead

Method Detail

endback to summary
public long end() throws IOException

End the current request.

Returns:long

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).

Exceptions
IOException:
If an error happens
getEncodingNameback to summary
public ByteChunk getEncodingName()

Get the name of the encoding handled by this filter.

Returns:ByteChunk

The encoding name as a byte chunk to facilitate comparison with the value read from the HTTP headers which will also be a ByteChunk

isFinishedback to summary
public boolean isFinished()

Has the request body been read fully?

Returns:boolean

true if the request body has been fully read, otherwise false

recycleback to summary
public void recycle()

Make the filter ready to process the next request.

setBufferback to summary
public void setBuffer(InputBuffer buffer)

Set the next buffer in the filter pipeline.

Parameters
buffer:InputBuffer

The next buffer

setRequestback to summary
public void setRequest(Request request)

Some filters need additional parameters from the request.

Parameters
request:Request

The request to be associated with this filter