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 Summary
Fields 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.ApplicationBufferHandler
EMPTY, EMPTY_BUFFER
-
-
Constructor Summary
Constructors Constructor Description IdentityInputFilter(int maxSwallowSize)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intavailable()Amount 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)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_NAME
protected static final java.lang.String ENCODING_NAME
- See Also:
- Constant Field Values
-
ENCODING
protected static final ByteChunk ENCODING
-
contentLength
protected long contentLength
Content length.
-
remaining
protected long remaining
Remaining bytes.
-
buffer
protected InputBuffer buffer
Next buffer in the pipeline.
-
tempRead
protected java.nio.ByteBuffer tempRead
ByteBuffer used to read leftover bytes.
-
-
Method Detail
-
doRead
public 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 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:
java.io.IOException- If an I/O error occurs reading from the input stream
-
setRequest
public void setRequest(Request request)
Read the content length from the request.- Specified by:
setRequestin interfaceInputFilter- Parameters:
request- The request to be associated with this filter
-
end
public long end() throws java.io.IOExceptionDescription 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:
java.io.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
public void setBuffer(InputBuffer buffer)
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
public ByteChunk 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
public void setByteBuffer(java.nio.ByteBuffer buffer)
- Specified by:
setByteBufferin interfaceApplicationBufferHandler
-
getByteBuffer
public java.nio.ByteBuffer getByteBuffer()
- Specified by:
getByteBufferin interfaceApplicationBufferHandler
-
expand
public void expand(int size)
- Specified by:
expandin interfaceApplicationBufferHandler
-
-