Class VoidInputFilter
java.lang.Object
org.apache.coyote.http11.filters.VoidInputFilter
- All Implemented Interfaces:
- InputFilter,- InputBuffer
Void input filter, which returns -1 when attempting a read. Used with a GET, HEAD, or a similar request.
- Author:
- Remy Maucherat
- 
Field SummaryFields
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionintObtain an estimate of the number of bytes that can be read without blocking.intdoRead(ApplicationBufferHandler handler) Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.longend()End the current request.Get the name of the encoding handled by this filter.booleanHas 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.
- 
Field Details- 
ENCODING_NAME- See Also:
 
- 
ENCODING
 
- 
- 
Constructor Details- 
VoidInputFilterpublic VoidInputFilter()
 
- 
- 
Method Details- 
doReadDescription copied from interface:InputBufferRead from the input stream into the ByteBuffer provided by the ApplicationBufferHandler. IMPORTANT: the current model assumes that the protocol will 'own' the ByteBuffer and return a pointer to it.- Specified by:
- doReadin interface- InputBuffer
- Parameters:
- handler- ApplicationBufferHandler that provides the buffer to read data into.
- Returns:
- The number of bytes that have been added to the buffer or -1 for end of stream
- Throws:
- IOException- If an I/O error occurs reading from the input stream
 
- 
setRequestDescription copied from interface:InputFilterSome filters need additional parameters from the request.- Specified by:
- setRequestin interface- InputFilter
- Parameters:
- request- The request to be associated with this filter
 
- 
setBufferDescription copied from interface:InputFilterSet the next buffer in the filter pipeline.- Specified by:
- setBufferin interface- InputFilter
- Parameters:
- buffer- The next buffer
 
- 
recyclepublic void recycle()Description copied from interface:InputFilterMake the filter ready to process the next request.- Specified by:
- recyclein interface- InputFilter
 
- 
getEncodingNameDescription copied from interface:InputFilterGet the name of the encoding handled by this filter.- Specified by:
- getEncodingNamein interface- InputFilter
- 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
 
- 
endDescription copied from interface:InputFilterEnd the current request.- Specified by:
- endin interface- InputFilter
- 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:
- IOException- If an error happens
 
- 
availablepublic int available()Description copied from interface:InputBufferObtain an estimate of the number of bytes that can be read without blocking. Typically, this will be the number of available bytes known to be buffered.- Specified by:
- availablein interface- InputBuffer
- Returns:
- The number of bytes that can be read without blocking
 
- 
isFinishedpublic boolean isFinished()Description copied from interface:InputFilterHas the request body been read fully?- Specified by:
- isFinishedin interface- InputFilter
- Returns:
- trueif the request body has been fully read, otherwise- false
 
 
-