Package org.apache.coyote.http11.filters
Class IdentityInputFilter
- java.lang.Object
- 
- org.apache.coyote.http11.filters.IdentityInputFilter
 
- 
- All Implemented Interfaces:
- InputFilter,- InputBuffer,- ApplicationBufferHandler
 
 public class IdentityInputFilter extends java.lang.Object implements InputFilter, ApplicationBufferHandler Identity input filter.- Author:
- Remy Maucherat
 
- 
- 
Field SummaryFields Modifier and Type Field Description protected InputBufferbufferNext buffer in the pipeline.protected longcontentLengthContent length.protected static ByteChunkENCODINGprotected static java.lang.StringENCODING_NAMEprotected longremainingRemaining bytes.protected java.nio.ByteBuffertempReadByteBuffer used to read leftover bytes.- 
Fields inherited from interface org.apache.tomcat.util.net.ApplicationBufferHandlerEMPTY, EMPTY_BUFFER
 
- 
 - 
Constructor SummaryConstructors Constructor Description IdentityInputFilter(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?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 
 - 
contentLengthprotected long contentLength Content length.
 - 
remainingprotected long remaining Remaining bytes.
 - 
bufferprotected InputBuffer buffer Next buffer in the pipeline.
 - 
tempReadprotected java.nio.ByteBuffer tempRead ByteBuffer used to read leftover bytes.
 
- 
 - 
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.IOExceptionDescription 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:
- 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
 
 - 
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
 
 
- 
 
-