Package org.apache.coyote.http11
Interface InputFilter
- 
- All Superinterfaces:
- InputBuffer
 - All Known Implementing Classes:
- BufferedInputFilter,- ChunkedInputFilter,- IdentityInputFilter,- SavedRequestInputFilter,- VoidInputFilter
 
 public interface InputFilter extends InputBuffer Input filter interface.- Author:
- Remy Maucherat
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description longend()End the current request.ByteChunkgetEncodingName()Get the name of the encoding handled by this filter.booleanisFinished()Has the request body been read fully?voidrecycle()Make the filter ready to process the next request.voidsetBuffer(InputBuffer buffer)Set the next buffer in the filter pipeline.voidsetRequest(Request request)Some filters need additional parameters from the request.- 
Methods inherited from interface org.apache.coyote.InputBufferavailable, doRead, doRead
 
- 
 
- 
- 
- 
Method Detail- 
setRequestvoid setRequest(Request request) Some filters need additional parameters from the request.- Parameters:
- request- The request to be associated with this filter
 
 - 
recyclevoid recycle() Make the filter ready to process the next request.
 - 
getEncodingNameByteChunk getEncodingName() Get the name of the encoding handled by this filter.- 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
 
 - 
setBuffervoid setBuffer(InputBuffer buffer) Set the next buffer in the filter pipeline.- Parameters:
- buffer- The next buffer
 
 - 
endlong end() throws java.io.IOException End the current request.- 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).
- Throws:
- java.io.IOException- If an error happens
 
 - 
isFinishedboolean isFinished() Has the request body been read fully?- Returns:
- trueif the request body has been fully read, otherwise- false
 
 
- 
 
-