org.apache.coyote.http11.filters: public class: VoidOutputFilter

org.apache.coyote.http11.filters
public class: VoidOutputFilter [javadoc | source]

java.lang.Object
   org.apache.coyote.http11.filters.VoidOutputFilter

All Implemented Interfaces:
OutputFilter

Void output filter, which silently swallows bytes written. Used with a 204 status (no content) or a HEAD request.

author: Remy - Maucherat

Field Summary
protected static final String	ENCODING_NAME
protected static final ByteChunk	ENCODING
protected OutputBuffer	buffer	Next buffer in the pipeline.

Method from org.apache.coyote.http11.filters.VoidOutputFilter Summary:
doWrite, end, getEncodingName, recycle, setBuffer, setResponse

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.coyote.http11.filters.VoidOutputFilter Detail:
public int doWrite(ByteChunk chunk, Response res) throws IOException { return chunk.getLength(); } Write some bytes.
public long end() throws IOException { return 0; } End the current request. It is acceptable to write extra bytes using buffer.doWrite during the execution of this method.
public ByteChunk getEncodingName() { return ENCODING; } Return the name of the associated encoding; Here, the value is "identity".
public void recycle() { } Make the filter ready to process the next request.
public void setBuffer(OutputBuffer buffer) { this.buffer = buffer; } Set the next buffer in the filter pipeline.
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.

Method from org.apache.coyote.http11.filters.VoidOutputFilter Detail:

 public int doWrite(ByteChunk chunk,
    Response res) throws IOException {
        return chunk.getLength();
}

Write some bytes.

 public long end() throws IOException {
        return 0;
}

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

 public ByteChunk getEncodingName() {
        return ENCODING;
}

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

 public  void recycle() {

}

Make the filter ready to process the next request.

 public  void setBuffer(OutputBuffer buffer) {
        this.buffer = buffer;
}

Set the next buffer in the filter pipeline.

 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.