Tomcat 10.1.19 · org.apache.coyote.http11.filters.IdentityInputFilter

Modifier and Type	Field and Description
protected InputBuffer	buffer Next buffer in the pipeline.
protected long	contentLength Content length.
protected static final ByteChunk	ENCODING
protected static final String	ENCODING_NAME
private final int	maxSwallowSize
protected long	remaining Remaining bytes.
private static final StringManager	sm
protected ByteBuffer	tempRead ByteBuffer used to read leftover bytes.

Access	Constructor and Description
public	IdentityInputFilter(int maxSwallowSize)

Method Summary

Modifier and Type	Method and Description
public int	available() Implements org.apache.coyote.InputBuffer.available. Amount of bytes still available in a buffer.
public int	doRead(ApplicationBufferHandler ApplicationBufferHandler that provides the buffer to read data into. handler) Implements org.apache.coyote.InputBuffer.doRead. Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.
public long	end() Implements org.apache.coyote.http11.InputFilter.end. End the current request.
public void	expand(int size) Implements org.apache.tomcat.util.net.ApplicationBufferHandler.expand.
public ByteBuffer	getByteBuffer() Implements org.apache.tomcat.util.net.ApplicationBufferHandler.getByteBuffer.
public ByteChunk	getEncodingName() Implements org.apache.coyote.http11.InputFilter.getEncodingName. Return the name of the associated encoding; Here, the value is "identity".
public boolean	isFinished() Implements org.apache.coyote.http11.InputFilter.isFinished. Has the request body been read fully?
public void	recycle() Implements org.apache.coyote.http11.InputFilter.recycle. Make the filter ready to process the next request.
public void	setBuffer(InputBuffer The next buffer buffer) Implements org.apache.coyote.http11.InputFilter.setBuffer. Set the next buffer in the filter pipeline.
public void	setByteBuffer(ByteBuffer buffer) Implements org.apache.tomcat.util.net.ApplicationBufferHandler.setByteBuffer.
public void	setRequest(Request The request to be associated with this filter request) Implements org.apache.coyote.http11.InputFilter.setRequest. Read the content length from the request.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

buffer	back to summary
protected InputBuffer buffer Next buffer in the pipeline.

contentLength	back to summary
protected long contentLength Content length.

ENCODING	back to summary
protected static final ByteChunk ENCODING

ENCODING_NAME	back to summary
protected static final String ENCODING_NAME

maxSwallowSize	back to summary
private final int maxSwallowSize

remaining	back to summary
protected long remaining Remaining bytes.

sm	back to summary
private static final StringManager sm

tempRead	back to summary
protected ByteBuffer tempRead ByteBuffer used to read leftover bytes.

IdentityInputFilter	back to summary
public IdentityInputFilter(int maxSwallowSize)

Method Detail

available	back to summary
public int available() Implements org.apache.coyote.InputBuffer.available. Amount of bytes still available in a buffer. Returns:int Doc from org.apache.coyote.InputBuffer.available. The number of bytes that can be read without blocking Annotations @Override

available

back to summary

public int available()

Implements org.apache.coyote.InputBuffer.available.

Amount of bytes still available in a buffer.

Returns:int

Doc from org.apache.coyote.InputBuffer.available.

The number of bytes that can be read without blocking

Annotations

@Override

doRead	back to summary
public int doRead(ApplicationBufferHandler handler) throws IOException Implements org.apache.coyote.InputBuffer.doRead. Doc from org.apache.coyote.InputBuffer.doRead. Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler. Important Note the current model assumes that the protocol will 'own' the ByteBuffer and return a pointer to it. Parameters handler:ApplicationBufferHandler ApplicationBufferHandler that provides the buffer to read data into. Returns:int The number of bytes that have been added to the buffer or -1 for end of stream Annotations @Override Exceptions IOException: If an I/O error occurs reading from the input stream

doRead

back to summary

public int doRead(ApplicationBufferHandler handler) throws IOException

Implements org.apache.coyote.InputBuffer.doRead.

Doc from org.apache.coyote.InputBuffer.doRead.

Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.

Important Note

the current model assumes that the protocol will 'own' the ByteBuffer and return a pointer to it.

Parameters

handler:ApplicationBufferHandler: ApplicationBufferHandler that provides the buffer to read data into.

Returns:int

The number of bytes that have been added to the buffer or -1 for end of stream

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs reading from the input stream

end	back to summary
public long end() throws IOException Implements org.apache.coyote.http11.InputFilter.end. Doc from org.apache.coyote.http11.InputFilter.end. End the current request. Returns:long 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). Annotations @Override Exceptions IOException: If an error happens

end

back to summary

public long end() throws IOException

Implements org.apache.coyote.http11.InputFilter.end.

Doc from org.apache.coyote.http11.InputFilter.end.

End the current request.

Returns:long

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).

Annotations

@Override

Exceptions

IOException:: If an error happens

expand	back to summary
public void expand(int size) Implements org.apache.tomcat.util.net.ApplicationBufferHandler.expand. Annotations @Override

expand

back to summary

public void expand(int size)

Implements org.apache.tomcat.util.net.ApplicationBufferHandler.expand.

Annotations

@Override

getByteBuffer	back to summary
public ByteBuffer getByteBuffer() Implements org.apache.tomcat.util.net.ApplicationBufferHandler.getByteBuffer. Annotations @Override

getByteBuffer

back to summary

public ByteBuffer getByteBuffer()

Implements org.apache.tomcat.util.net.ApplicationBufferHandler.getByteBuffer.

Annotations

@Override

getEncodingName	back to summary
public ByteChunk getEncodingName() Implements org.apache.coyote.http11.InputFilter.getEncodingName. Return the name of the associated encoding; Here, the value is "identity". Returns:ByteChunk Doc from org.apache.coyote.http11.InputFilter.getEncodingName. The encoding name as a byte chunk to facilitate comparison with the value read from the HTTP headers which will also be a ByteChunk Annotations @Override

getEncodingName

back to summary

public ByteChunk getEncodingName()

Implements org.apache.coyote.http11.InputFilter.getEncodingName.

Return the name of the associated encoding; Here, the value is "identity".

Returns:ByteChunk

Doc from org.apache.coyote.http11.InputFilter.getEncodingName.

The encoding name as a byte chunk to facilitate comparison with the value read from the HTTP headers which will also be a ByteChunk

Annotations

@Override

isFinished back to summary

isFinished	back to summary
public boolean isFinished() Implements org.apache.coyote.http11.InputFilter.isFinished. Doc from org.apache.coyote.http11.InputFilter.isFinished. Has the request body been read fully? Returns:boolean `true` if the request body has been fully read, otherwise `false` Annotations @Override

public boolean isFinished()

Implements org.apache.coyote.http11.InputFilter.isFinished.

Doc from org.apache.coyote.http11.InputFilter.isFinished.

Has the request body been read fully?

Returns:boolean

true if the request body has been fully read, otherwise false

Annotations

@Override

recycle	back to summary
public void recycle() Implements org.apache.coyote.http11.InputFilter.recycle. Make the filter ready to process the next request. Annotations @Override

recycle

back to summary

public void recycle()

Implements org.apache.coyote.http11.InputFilter.recycle.

Make the filter ready to process the next request.

Annotations

@Override

setBuffer	back to summary
public void setBuffer(InputBuffer buffer) Implements org.apache.coyote.http11.InputFilter.setBuffer. Set the next buffer in the filter pipeline. Parameters buffer:InputBuffer Doc from org.apache.coyote.http11.InputFilter.setBuffer. The next buffer Annotations @Override

setBuffer

back to summary

public void setBuffer(InputBuffer buffer)

Implements org.apache.coyote.http11.InputFilter.setBuffer.

Set the next buffer in the filter pipeline.

Parameters

buffer:InputBuffer

Doc from org.apache.coyote.http11.InputFilter.setBuffer.

The next buffer

Annotations

@Override

setByteBuffer	back to summary
public void setByteBuffer(ByteBuffer buffer) Implements org.apache.tomcat.util.net.ApplicationBufferHandler.setByteBuffer. Annotations @Override

setByteBuffer

back to summary

public void setByteBuffer(ByteBuffer buffer)

Implements org.apache.tomcat.util.net.ApplicationBufferHandler.setByteBuffer.

Annotations

@Override

setRequest	back to summary
public void setRequest(Request request) Implements org.apache.coyote.http11.InputFilter.setRequest. Read the content length from the request. Parameters request:Request Doc from org.apache.coyote.http11.InputFilter.setRequest. The request to be associated with this filter Annotations @Override

setRequest

back to summary

public void setRequest(Request request)

Implements org.apache.coyote.http11.InputFilter.setRequest.

Read the content length from the request.

Parameters

request:Request

Doc from org.apache.coyote.http11.InputFilter.setRequest.

The request to be associated with this filter

Annotations