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 java.lang.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.ApplicationBufferHandlerEMPTY, EMPTY_BUFFER
 
- 
 - 
Constructor SummaryConstructors Constructor Description BufferedInputFilter(int maxSwallowSize)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description intavailable()Obtain an estimate of the number of bytes that can be read without blocking.intdoRead(ByteChunk chunk)Deprecated.Unused.intdoRead(ApplicationBufferHandler handler)Fills the given ByteBuffer with the buffered request body.longend()End the current request.voidexpand(int size)java.nio.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(java.nio.ByteBuffer buffer)voidsetLimit(int limit)Set the buffering limit.voidsetRequest(Request request)Reads the request body and buffers it.
 
- 
- 
- 
Method Detail- 
setLimitpublic 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
 
 - 
setRequestpublic void setRequest(Request request) Reads the request body and buffers it.- Specified by:
- setRequestin interface- InputFilter
- Parameters:
- request- The request to be associated with this filter
 
 - 
doRead@Deprecated public int doRead(ByteChunk chunk) throws java.io.IOException Deprecated.Unused. Will be removed in Tomcat 9. UsedoRead(ApplicationBufferHandler)Fills the given ByteChunk with the buffered request body.- Specified by:
- doReadin interface- InputBuffer
- Parameters:
- chunk- 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:
- java.io.IOException- If an I/O error occurs reading from the input stream
 
 - 
doReadpublic int doRead(ApplicationBufferHandler handler) throws java.io.IOException Fills the given ByteBuffer with the buffered request body.- 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:
- java.io.IOException- If an I/O error occurs reading from the input stream
 
 - 
setBufferpublic void setBuffer(InputBuffer buffer) Description 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
 
 - 
getEncodingNamepublic ByteChunk getEncodingName() Description 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
 
 - 
endpublic long end() throws java.io.IOExceptionDescription 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:
- java.io.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
 
 - 
setByteBufferpublic void setByteBuffer(java.nio.ByteBuffer buffer) - Specified by:
- setByteBufferin interface- ApplicationBufferHandler
 
 - 
getByteBufferpublic java.nio.ByteBuffer getByteBuffer() - Specified by:
- getByteBufferin interface- ApplicationBufferHandler
 
 - 
expandpublic void expand(int size) - Specified by:
- expandin interface- ApplicationBufferHandler
 
 
- 
 
-