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 SummaryFieldsModifier 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.ApplicationBufferHandlerEMPTY, EMPTY_BUFFER
- 
Constructor SummaryConstructorsConstructorDescriptionChunkedInputFilter(Request request, int maxTrailerSize, Set<String> allowedTrailerHeaders, int maxExtensionSize, int maxSwallowSize) 
- 
Method SummaryModifier 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
- 
bufferNext buffer in the pipeline.
- 
remainingprotected int remainingNumber of bytes remaining in the current chunk.
- 
readChunkByte chunk used to read bytes.
- 
trailingHeadersBuffer used to store trailing headers. Is normally in read mode.
 
- 
- 
Constructor Details- 
ChunkedInputFilter
 
- 
- 
Method Details- 
doReadDescription 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 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:
- IOException- If an I/O error occurs reading from the input stream
 
- 
setRequestDescription copied from interface:InputFilterSome filters need additional parameters from the request.- Specified by:
- setRequestin interface- InputFilter
- Parameters:
- request- The request to be associated with this filter
 
- 
endDescription 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:
- 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
 
- 
setBufferDescription 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
 
- 
getEncodingNameDescription 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
 
- 
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
 
- 
readBytesRead bytes from the previous buffer.- Returns:
- The byte count which has been read
- Throws:
- IOException- Read error
 
- 
fillHeaderBufferDescription 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 interface- HttpHeaderParser.HeaderDataSource
- Returns:
- trueif more data was added to the buffer, otherwise- false
- Throws:
- IOException- If an I/O error occurred while obtaining more header data
 
- 
setByteBufferDescription copied from interface:ApplicationBufferHandlerSet the byte buffer.- Specified by:
- setByteBufferin interface- ApplicationBufferHandler
- Parameters:
- buffer- the byte buffer
 
- 
getByteBuffer- Specified by:
- getByteBufferin interface- ApplicationBufferHandler
- Returns:
- the byte buffer
 
- 
getHeaderByteBufferDescription copied from interface:HttpHeaderParser.HeaderDataSourceObtain a reference to the buffer containing the header data.- Specified by:
- getHeaderByteBufferin interface- HttpHeaderParser.HeaderDataSource
- Returns:
- The buffer containing the header data
 
- 
expandpublic 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 interface- ApplicationBufferHandler
- Parameters:
- size- the desired size
 
 
-