Package org.apache.coyote.http11.filters
Class ChunkedInputFilter
java.lang.Object
org.apache.coyote.http11.filters.ChunkedInputFilter
- All Implemented Interfaces:
InputFilter,InputBuffer,HttpHeaderParser.HeaderDataSource,ApplicationBufferHandler
public class ChunkedInputFilter
extends Object
implements InputFilter, ApplicationBufferHandler, HttpHeaderParser.HeaderDataSource
Chunked input filter. Parses chunked data according to
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6.1
- Author:
- Remy Maucherat
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected InputBufferNext buffer in the pipeline.protected static final ByteChunkprotected static final Stringprotected ByteBufferByte chunk used to read bytes.protected intNumber of bytes remaining in the current chunk.protected final ByteBufferBuffer used to store trailing headers.Fields inherited from interface org.apache.tomcat.util.net.ApplicationBufferHandler
EMPTY, EMPTY_BUFFER -
Constructor Summary
ConstructorsConstructorDescriptionChunkedInputFilter(Request request, int maxTrailerSize, Set<String> allowedTrailerHeaders, int maxExtensionSize, int maxSwallowSize) -
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.voidexpand(int size) Expand the byte buffer to at least the given size.booleanRead more data into the header buffer.Get the name of the encoding handled by this filter.Obtain a reference to the buffer containing the header data.booleanHas the request body been read fully?protected intRead bytes from the previous buffer.voidrecycle()Make the filter ready to process the next request.voidsetBuffer(InputBuffer buffer) Set the next buffer in the filter pipeline.voidsetByteBuffer(ByteBuffer buffer) Set the byte buffer.voidsetRequest(Request request) Some filters need additional parameters from the request.
-
Field Details
-
ENCODING_NAME
- See Also:
-
ENCODING
-
buffer
Next buffer in the pipeline. -
remaining
protected int remainingNumber of bytes remaining in the current chunk. -
readChunk
Byte chunk used to read bytes. -
trailingHeaders
Buffer used to store trailing headers. Is normally in read mode.
-
-
Constructor Details
-
ChunkedInputFilter
-
-
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
-
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
-
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
-
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
-
readBytes
Read bytes from the previous buffer.- Returns:
- The byte count which has been read
- Throws:
IOException- Read error
-
fillHeaderBuffer
Description copied from interface:HttpHeaderParser.HeaderDataSourceRead more data into the header buffer. The implementation is expected to determine if blocking or not blocking IO should be used.- Specified by:
fillHeaderBufferin interfaceHttpHeaderParser.HeaderDataSource- Returns:
trueif more data was added to the buffer, otherwisefalse- Throws:
IOException- If an I/O error occurred while obtaining more header data
-
setByteBuffer
Description copied from interface:ApplicationBufferHandlerSet the byte buffer.- Specified by:
setByteBufferin interfaceApplicationBufferHandler- Parameters:
buffer- the byte buffer
-
getByteBuffer
- Specified by:
getByteBufferin interfaceApplicationBufferHandler- Returns:
- the byte buffer
-
getHeaderByteBuffer
Description copied from interface:HttpHeaderParser.HeaderDataSourceObtain a reference to the buffer containing the header data.- Specified by:
getHeaderByteBufferin interfaceHttpHeaderParser.HeaderDataSource- Returns:
- The buffer containing the header data
-
expand
public void expand(int size) Description copied from interface:ApplicationBufferHandlerExpand the byte buffer to at least the given size. Some implementations may not implement this.- Specified by:
expandin interfaceApplicationBufferHandler- Parameters:
size- the desired size
-