Package org.apache.coyote.http11.filters
Class ChunkedInputFilter
java.lang.Object
org.apache.coyote.http11.filters.ChunkedInputFilter
- All Implemented Interfaces:
- InputFilter,- InputBuffer,- ApplicationBufferHandler
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 booleanFlag set to true when the end chunk has been read.protected booleanFlag set to true if the next call to doRead() must parse a CRLF pair before doing anything else.protected ByteBufferByte chunk used to read bytes.protected intNumber of bytes remaining in the current chunk.protected final ByteChunkByte chunk used to store trailing headers.Fields inherited from interface org.apache.tomcat.util.net.ApplicationBufferHandlerEMPTY, EMPTY_BUFFER
- 
Constructor SummaryConstructorsConstructorDescriptionChunkedInputFilter(int maxTrailerSize, Set<String> allowedTrailerHeaders, int maxExtensionSize, int maxSwallowSize) 
- 
Method SummaryModifier and TypeMethodDescriptionintAmount of bytes still available in a buffer.intdoRead(ApplicationBufferHandler handler) Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.longend()End the current request.voidexpand(int size) Return the name of the associated encoding; Here, the value is "identity".booleanHas the request body been read fully?protected booleanParse the header of a chunk.protected voidparseCRLF(boolean tolerant) Parse CRLF at end of chunk.protected voidParse end chunk data.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) voidsetRequest(Request request) Read the content length 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.
- 
endChunkprotected boolean endChunkFlag set to true when the end chunk has been read.
- 
trailingHeadersByte chunk used to store trailing headers.
- 
needCRLFParseprotected boolean needCRLFParseFlag set to true if the next call to doRead() must parse a CRLF pair before doing anything else.
 
- 
- 
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
 
- 
setRequestRead the content length from the request.- Specified by:
- setRequestin interface- InputFilter
- Parameters:
- request- The request to be associated with this filter
 
- 
endEnd 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()Amount of bytes still available in a buffer.- Specified by:
- availablein interface- InputBuffer
- Returns:
- The number of bytes that can be read without blocking
 
- 
setBufferSet the next buffer in the filter pipeline.- Specified by:
- setBufferin interface- InputFilter
- Parameters:
- buffer- The next buffer
 
- 
recyclepublic void recycle()Make the filter ready to process the next request.- Specified by:
- recyclein interface- InputFilter
 
- 
getEncodingNameReturn the name of the associated encoding; Here, the value is "identity".- 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
 
- 
parseChunkHeaderParse the header of a chunk. A chunk header can look like one of the following:
 A10CRLF
 F23;chunk-extension to be ignoredCRLFThe letters before CRLF or ';' (whatever comes first) must be valid hex digits. We should not parse F23IAMGONNAMESSTHISUP34CRLF as a valid header according to the spec. - Returns:
- trueif the chunk header has been successfully parsed
- Throws:
- IOException- Read error
 
- 
parseCRLFParse CRLF at end of chunk.- Parameters:
- tolerant- Should tolerant parsing (LF and CRLF) be used? This is recommended (RFC2616, section 19.3) for message headers.
- Throws:
- IOException- An error occurred parsing CRLF
 
- 
parseEndChunkParse end chunk data.- Throws:
- IOException- Error propagation
 
- 
setByteBuffer- Specified by:
- setByteBufferin interface- ApplicationBufferHandler
 
- 
getByteBuffer- Specified by:
- getByteBufferin interface- ApplicationBufferHandler
 
- 
expandpublic void expand(int size) - Specified by:
- expandin interface- ApplicationBufferHandler
 
 
-