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 Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier 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
-
VoidInputFilter
public VoidInputFilter()
-
-
Method Details
-
doRead
Description 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 interfaceInputBuffer- 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
-
setRequest
Description copied from interface:InputFilterSome filters need additional parameters from the request.- Specified by:
setRequestin interfaceInputFilter- Parameters:
request- The request to be associated with this filter
-
setBuffer
Description copied from interface:InputFilterSet the next buffer in the filter pipeline.- Specified by:
setBufferin interfaceInputFilter- Parameters:
buffer- The next buffer
-
recycle
public void recycle()Description copied from interface:InputFilterMake the filter ready to process the next request.- Specified by:
recyclein interfaceInputFilter
-
getEncodingName
Description copied from interface:InputFilterGet the name of the encoding handled by this filter.- Specified by:
getEncodingNamein interfaceInputFilter- 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
-
end
Description copied from interface:InputFilterEnd the current request.- Specified by:
endin interfaceInputFilter- 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
-
available
public 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 interfaceInputBuffer- Returns:
- The number of bytes that can be read without blocking
-
isFinished
public boolean isFinished()Description copied from interface:InputFilterHas the request body been read fully?- Specified by:
isFinishedin interfaceInputFilter- Returns:
trueif the request body has been fully read, otherwisefalse
-