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 InputBuffer
buffer
Next buffer in the pipeline.protected long
contentLength
Content length.protected static ByteChunk
ENCODING
protected static java.lang.String
ENCODING_NAME
protected long
remaining
Remaining bytes.protected java.nio.ByteBuffer
tempRead
ByteBuffer 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 int
available()
Obtain an estimate of the number of bytes that can be read without blocking.int
doRead(ApplicationBufferHandler handler)
Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.long
end()
End the current request.void
expand(int size)
Expand the byte buffer to at least the given size.java.nio.ByteBuffer
getByteBuffer()
ByteChunk
getEncodingName()
Get the name of the encoding handled by this filter.boolean
isFinished()
Has the request body been read fully?void
recycle()
Make the filter ready to process the next request.void
setBuffer(InputBuffer buffer)
Set the next buffer in the filter pipeline.void
setByteBuffer(java.nio.ByteBuffer buffer)
Set the byte buffer.void
setRequest(Request request)
Some filters need additional parameters 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:InputBuffer
Read 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:
doRead
in 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)
Some filters need additional parameters from the request. Read the content length from the request.- Specified by:
setRequest
in interfaceInputFilter
- Parameters:
request
- The request to be associated with this filter
-
end
public long end() throws java.io.IOException
Description copied from interface:InputFilter
End the current request.- Specified by:
end
in 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()
Description copied from interface:InputBuffer
Obtain an estimate of the number of bytes that can be read without blocking. Typically, this will be the number of available bytes known to be buffered.- Specified by:
available
in interfaceInputBuffer
- Returns:
- The number of bytes that can be read without blocking
-
setBuffer
public void setBuffer(InputBuffer buffer)
Description copied from interface:InputFilter
Set the next buffer in the filter pipeline.- Specified by:
setBuffer
in interfaceInputFilter
- Parameters:
buffer
- The next buffer
-
recycle
public void recycle()
Description copied from interface:InputFilter
Make the filter ready to process the next request.- Specified by:
recycle
in interfaceInputFilter
-
getEncodingName
public ByteChunk getEncodingName()
Description copied from interface:InputFilter
Get the name of the encoding handled by this filter.- Specified by:
getEncodingName
in 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:InputFilter
Has the request body been read fully?- Specified by:
isFinished
in interfaceInputFilter
- Returns:
true
if the request body has been fully read, otherwisefalse
-
setByteBuffer
public void setByteBuffer(java.nio.ByteBuffer buffer)
Description copied from interface:ApplicationBufferHandler
Set the byte buffer.- Specified by:
setByteBuffer
in interfaceApplicationBufferHandler
- Parameters:
buffer
- the byte buffer
-
getByteBuffer
public java.nio.ByteBuffer getByteBuffer()
- Specified by:
getByteBuffer
in interfaceApplicationBufferHandler
- Returns:
- the byte buffer
-
expand
public void expand(int size)
Description copied from interface:ApplicationBufferHandler
Expand the byte buffer to at least the given size. Some implementations may not implement this.- Specified by:
expand
in interfaceApplicationBufferHandler
- Parameters:
size
- the desired size
-
-