Package org.apache.coyote.http11.filters
Class BufferedInputFilter
- java.lang.Object
-
- org.apache.coyote.http11.filters.BufferedInputFilter
-
- All Implemented Interfaces:
InputFilter,InputBuffer,ApplicationBufferHandler
public class BufferedInputFilter extends Object implements InputFilter, ApplicationBufferHandler
Input filter responsible for reading and buffering the request body, so that it does not interfere with client SSL handshake messages.
-
-
Field Summary
-
Fields inherited from interface org.apache.tomcat.util.net.ApplicationBufferHandler
EMPTY, EMPTY_BUFFER
-
-
Constructor Summary
Constructors Constructor Description BufferedInputFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intavailable()Obtain an estimate of the number of bytes that can be read without blocking.intdoRead(ApplicationBufferHandler handler)Fills the given ByteBuffer with the buffered request body.longend()End the current request.voidexpand(int size)ByteBuffergetByteBuffer()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.voidsetByteBuffer(ByteBuffer buffer)voidsetLimit(int limit)Set the buffering limit.voidsetRequest(Request request)Reads the request body and buffers it.
-
-
-
Method Detail
-
setLimit
public void setLimit(int limit)
Set the buffering limit. This should be reset every time the buffer is used.- Parameters:
limit- The maximum number of bytes that will be buffered
-
setRequest
public void setRequest(Request request)
Reads the request body and buffers it.- Specified by:
setRequestin interfaceInputFilter- Parameters:
request- The request to be associated with this filter
-
doRead
public int doRead(ApplicationBufferHandler handler) throws IOException
Fills the given ByteBuffer with the buffered request body.- 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
-
setBuffer
public void setBuffer(InputBuffer buffer)
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
public ByteChunk 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
public long end() throws IOExceptionDescription 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
-
setByteBuffer
public void setByteBuffer(ByteBuffer buffer)
- Specified by:
setByteBufferin interfaceApplicationBufferHandler
-
getByteBuffer
public ByteBuffer getByteBuffer()
- Specified by:
getByteBufferin interfaceApplicationBufferHandler
-
expand
public void expand(int size)
- Specified by:
expandin interfaceApplicationBufferHandler
-
-