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.ApplicationBufferHandler
EMPTY, EMPTY_BUFFER
-
-
Constructor Summary
Constructors Constructor Description BufferedInputFilter(int maxSwallowSize)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
available()
Obtain an estimate of the number of bytes that can be read without blocking.int
doRead(ByteChunk chunk)
Deprecated.Unused.int
doRead(ApplicationBufferHandler handler)
Fills the given ByteBuffer with the buffered request body.long
end()
End the current request.void
expand(int size)
java.nio.ByteBuffer
getByteBuffer()
ByteChunk
getEncodingName()
Get the name of the encoding handled by this filter.boolean
isFinished()
Has the request body been read fully?void
recycle()
Make the filter ready to process the next request.void
setBuffer(InputBuffer buffer)
Set the next buffer in the filter pipeline.void
setByteBuffer(java.nio.ByteBuffer buffer)
void
setLimit(int limit)
Set the buffering limit.void
setRequest(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:
setRequest
in interfaceInputFilter
- 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:
doRead
in interfaceInputBuffer
- 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
-
doRead
public int doRead(ApplicationBufferHandler handler) throws java.io.IOException
Fills the given ByteBuffer with the buffered request body.- Specified by:
doRead
in 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:
java.io.IOException
- If an I/O error occurs reading from the input stream
-
setBuffer
public void setBuffer(InputBuffer buffer)
Description copied from interface:InputFilter
Set the next buffer in the filter pipeline.- Specified by:
setBuffer
in interfaceInputFilter
- Parameters:
buffer
- The next buffer
-
recycle
public void recycle()
Description copied from interface:InputFilter
Make the filter ready to process the next request.- Specified by:
recycle
in interfaceInputFilter
-
getEncodingName
public ByteChunk getEncodingName()
Description copied from interface:InputFilter
Get the name of the encoding handled by this filter.- Specified by:
getEncodingName
in 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 java.io.IOException
Description copied from interface:InputFilter
End the current request.- Specified by:
end
in 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:
java.io.IOException
- If an error happens
-
available
public int available()
Description copied from interface:InputBuffer
Obtain 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:
available
in interfaceInputBuffer
- Returns:
- The number of bytes that can be read without blocking
-
isFinished
public boolean isFinished()
Description copied from interface:InputFilter
Has the request body been read fully?- Specified by:
isFinished
in interfaceInputFilter
- Returns:
true
if the request body has been fully read, otherwisefalse
-
setByteBuffer
public void setByteBuffer(java.nio.ByteBuffer buffer)
- Specified by:
setByteBuffer
in interfaceApplicationBufferHandler
-
getByteBuffer
public java.nio.ByteBuffer getByteBuffer()
- Specified by:
getByteBuffer
in interfaceApplicationBufferHandler
-
expand
public void expand(int size)
- Specified by:
expand
in interfaceApplicationBufferHandler
-
-