Package org.apache.coyote.http11.filters
Class ChunkedInputFilter
- java.lang.Object
- 
- org.apache.coyote.http11.filters.ChunkedInputFilter
 
- 
- All Implemented Interfaces:
- InputFilter,- InputBuffer,- ApplicationBufferHandler
 
 public class ChunkedInputFilter extends java.lang.Object implements InputFilter, 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 SummaryFields Modifier and Type Field Description protected InputBufferbufferNext buffer in the pipeline.protected static ByteChunkENCODINGprotected static java.lang.StringENCODING_NAMEprotected booleanendChunkFlag set to true when the end chunk has been read.protected booleanneedCRLFParseFlag set to true if the next call to doRead() must parse a CRLF pair before doing anything else.protected java.nio.ByteBufferreadChunkByte chunk used to read bytes.protected intremainingNumber of bytes remaining in the current chunk.protected ByteChunktrailingHeadersByte chunk used to store trailing headers.- 
Fields inherited from interface org.apache.tomcat.util.net.ApplicationBufferHandlerEMPTY, EMPTY_BUFFER
 
- 
 - 
Constructor SummaryConstructors Constructor Description ChunkedInputFilter(int maxTrailerSize, java.util.Set<java.lang.String> allowedTrailerHeaders, int maxExtensionSize, int maxSwallowSize)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description intavailable()Amount of bytes still available in a buffer.intdoRead(ByteChunk chunk)Deprecated.Unused.intdoRead(ApplicationBufferHandler handler)Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.longend()End the current request.voidexpand(int size)java.nio.ByteBuffergetByteBuffer()ByteChunkgetEncodingName()Return the name of the associated encoding; Here, the value is "identity".booleanisFinished()Has the request body been read fully?protected booleanparseChunkHeader()Parse the header of a chunk.protected voidparseCRLF(boolean tolerant)Parse CRLF at end of chunk.protected voidparseEndChunk()Parse end chunk data.protected intreadBytes()Read 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(java.nio.ByteBuffer buffer)voidsetRequest(Request request)Read the content length from the request.
 
- 
- 
- 
Field Detail- 
ENCODING_NAMEprotected static final java.lang.String ENCODING_NAME - See Also:
- Constant Field Values
 
 - 
ENCODINGprotected static final ByteChunk ENCODING 
 - 
bufferprotected InputBuffer buffer Next buffer in the pipeline.
 - 
remainingprotected int remaining Number of bytes remaining in the current chunk.
 - 
readChunkprotected java.nio.ByteBuffer readChunk Byte chunk used to read bytes.
 - 
endChunkprotected boolean endChunk Flag set to true when the end chunk has been read.
 - 
trailingHeadersprotected final ByteChunk trailingHeaders Byte chunk used to store trailing headers.
 - 
needCRLFParseprotected boolean needCRLFParse Flag set to true if the next call to doRead() must parse a CRLF pair before doing anything else.
 
- 
 - 
Method Detail- 
doRead@Deprecated public int doRead(ByteChunk chunk) throws java.io.IOException Deprecated.Unused. Will be removed in Tomcat 9. UsedoRead(ApplicationBufferHandler)Description copied from interface:InputBufferRead from the input stream into the given buffer. IMPORTANT: the current model assumes that the protocol will 'own' the buffer and return a pointer to it in ByteChunk (i.e. the param will have chunk.getBytes()==null before call, and the result after the call).- 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 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 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
 
 - 
setRequestpublic void setRequest(Request request) Read the content length from the request.- Specified by:
- setRequestin interface- InputFilter
- Parameters:
- request- The request to be associated with this filter
 
 - 
endpublic long end() throws java.io.IOExceptionEnd 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() Amount of bytes still available in a buffer.- Specified by:
- availablein interface- InputBuffer
- Returns:
- The number of bytes that can be read without blocking
 
 - 
setBufferpublic void setBuffer(InputBuffer buffer) Set 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
 
 - 
getEncodingNamepublic ByteChunk getEncodingName() Return 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
 
 - 
readBytesprotected int readBytes() throws java.io.IOExceptionRead bytes from the previous buffer.- Returns:
- The byte count which has been read
- Throws:
- java.io.IOException- Read error
 
 - 
parseChunkHeaderprotected boolean parseChunkHeader() throws java.io.IOExceptionParse 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:
- java.io.IOException- Read error
 
 - 
parseCRLFprotected void parseCRLF(boolean tolerant) throws java.io.IOExceptionParse 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:
- java.io.IOException- An error occurred parsing CRLF
 
 - 
parseEndChunkprotected void parseEndChunk() throws java.io.IOExceptionParse end chunk data.- Throws:
- java.io.IOException- Error propagation
 
 - 
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
 
 
- 
 
-