Package org.apache.coyote.http11.filters
Class IdentityInputFilter
java.lang.Object
org.apache.coyote.http11.filters.IdentityInputFilter
- All Implemented Interfaces:
InputFilter,InputBuffer,ApplicationBufferHandler
Identity input filter.
- Author:
- Remy Maucherat
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected InputBufferNext buffer in the pipeline.protected longContent length.protected static final ByteChunkprotected static final Stringprotected longRemaining bytes.protected ByteBufferByteBuffer used to read leftover bytes.Fields inherited from interface org.apache.tomcat.util.net.ApplicationBufferHandler
EMPTY, EMPTY_BUFFER -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintAmount of bytes still available in a buffer.intDeprecated.Unused.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?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
-
contentLength
protected long contentLengthContent length. -
remaining
protected long remainingRemaining bytes. -
buffer
Next buffer in the pipeline. -
tempRead
ByteBuffer used to read leftover bytes.
-
-
Constructor Details
-
IdentityInputFilter
public IdentityInputFilter(int maxSwallowSize)
-
-
Method Details
-
doRead
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 interfaceInputBuffer- 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:
IOException- If an I/O error occurs reading from the input stream
-
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
Read the content length 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()Amount of bytes still available in a buffer.- Specified by:
availablein interfaceInputBuffer- Returns:
- The number of bytes that can be read without blocking
-
setBuffer
Set the next buffer in the filter pipeline.- Specified by:
setBufferin interfaceInputFilter- Parameters:
buffer- The next buffer
-
recycle
public void recycle()Make the filter ready to process the next request.- Specified by:
recyclein interfaceInputFilter
-
getEncodingName
Return the name of the associated encoding; Here, the value is "identity".- 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
-
setByteBuffer
- Specified by:
setByteBufferin interfaceApplicationBufferHandler
-
getByteBuffer
- Specified by:
getByteBufferin interfaceApplicationBufferHandler
-
expand
public void expand(int size) - Specified by:
expandin interfaceApplicationBufferHandler
-