org.apache.coyote.http11.filters

Class IdentityOutputFilter

java.lang.Object

org.apache.coyote.http11.filters.IdentityOutputFilter

All Implemented Interfaces:

OutputFilter, OutputBuffer

public class IdentityOutputFilter
extends Object
implements OutputFilter

Identity output filter.

Author:

Remy Maucherat

Field Summary

Fields

Modifier and Type	Field and Description
protected OutputBuffer	buffer Next buffer in the pipeline.
protected long	contentLength Content length.
protected static ByteChunk	ENCODING
protected static String	ENCODING_NAME
protected long	remaining Remaining bytes.

Constructor Summary

Constructors

Constructor and Description
IdentityOutputFilter()

Method Summary

Modifier and Type	Method and Description
int	doWrite(ByteChunk chunk, Response res) Write some bytes.
long	end() End the current request.
long	getContentLength() Get content length.
ByteChunk	getEncodingName() Return the name of the associated encoding; Here, the value is "identity".
long	getRemaining() Get remaining bytes.
void	recycle() Make the filter ready to process the next request.
void	setBuffer(OutputBuffer buffer) Set the next buffer in the filter pipeline.
void	setResponse(Response response) Some filters need additional parameters from the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENCODING_NAME

protected static final 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 OutputBuffer buffer

Next buffer in the pipeline.

Constructor Detail

IdentityOutputFilter

public IdentityOutputFilter()

Method Detail

getContentLength

public long getContentLength()

Get content length.

getRemaining

public long getRemaining()

Get remaining bytes.

doWrite

public int doWrite(ByteChunk chunk,
                   Response res)
            throws IOException

Write some bytes.

Specified by:

doWrite in interface OutputFilter

Specified by:

doWrite in interface OutputBuffer

Parameters:

chunk - Data to write

res - Used to allow buffers that can be shared by multiple responses.

Returns:

number of bytes written by the filter

Throws:

IOException

setResponse

public void setResponse(Response response)

Some filters need additional parameters from the response. All the necessary reading can occur in that method, as this method is called after the response header processing is complete.

Specified by:

setResponse in interface OutputFilter

setBuffer

public void setBuffer(OutputBuffer buffer)

Set the next buffer in the filter pipeline.

Specified by:

setBuffer in interface OutputFilter

end

public long end()
         throws IOException

End the current request. It is acceptable to write extra bytes using buffer.doWrite during the execution of this method.

Specified by:

end in interface OutputFilter

Returns:

Should return 0 unless the filter does some content length delimitation, in which case the number is the amount of extra bytes or missing bytes, which would indicate an error. Note: It is recommended that extra bytes be swallowed by the filter.

Throws:

IOException

recycle

public void recycle()

Make the filter ready to process the next request.

Specified by:

recycle in interface OutputFilter

getEncodingName

public ByteChunk getEncodingName()

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

Specified by:

getEncodingName in interface OutputFilter