Package org.apache.coyote.http11.filters
Class VoidOutputFilter
- java.lang.Object
-
- org.apache.coyote.http11.filters.VoidOutputFilter
-
- All Implemented Interfaces:
HttpOutputBuffer,OutputFilter,OutputBuffer
public class VoidOutputFilter extends Object implements OutputFilter
Void output filter, which silently swallows bytes written. Used with a 204 status (no content) or a HEAD request.- Author:
- Remy Maucherat
-
-
Constructor Summary
Constructors Constructor Description VoidOutputFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description intdoWrite(ByteBuffer chunk)Write the given data to the response.intdoWrite(ByteChunk chunk)Deprecated.Unused.voidend()Finish writing the current response.voidflush()Flushes any unwritten data to the client.longgetBytesWritten()Bytes written to the underlying socket.voidrecycle()Make the filter ready to process the next request.voidsetBuffer(HttpOutputBuffer buffer)Set the next buffer in the filter pipeline.voidsetResponse(Response response)Some filters need additional parameters from the response.
-
-
-
Method Detail
-
doWrite
@Deprecated public int doWrite(ByteChunk chunk) throws IOException
Deprecated.Unused. Will be removed in Tomcat 9. UsedoWrite(ByteBuffer)Description copied from interface:OutputBufferWrite the given data to the response. The caller owns the chunks.- Specified by:
doWritein interfaceOutputBuffer- Parameters:
chunk- data to write- Returns:
- The number of bytes written which may be less than available in the input chunk
- Throws:
IOException- an underlying I/O error occurred
-
doWrite
public int doWrite(ByteBuffer chunk) throws IOException
Description copied from interface:OutputBufferWrite the given data to the response. The caller owns the chunks.- Specified by:
doWritein interfaceOutputBuffer- Parameters:
chunk- data to write- Returns:
- The number of bytes written which may be less than available in the input chunk
- Throws:
IOException- an underlying I/O error occurred
-
getBytesWritten
public long getBytesWritten()
Description copied from interface:OutputBufferBytes written to the underlying socket. This includes the effects of chunking, compression, etc.- Specified by:
getBytesWrittenin interfaceOutputBuffer- Returns:
- Bytes written for the current request
-
setResponse
public void setResponse(Response response)
Description copied from interface:OutputFilterSome 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:
setResponsein interfaceOutputFilter- Parameters:
response- The response to associate with this OutputFilter
-
setBuffer
public void setBuffer(HttpOutputBuffer buffer)
Description copied from interface:OutputFilterSet the next buffer in the filter pipeline.- Specified by:
setBufferin interfaceOutputFilter- Parameters:
buffer- The next buffer instance
-
flush
public void flush() throws IOExceptionDescription copied from interface:HttpOutputBufferFlushes any unwritten data to the client.- Specified by:
flushin interfaceHttpOutputBuffer- Throws:
IOException- If an I/O error occurs while flushing
-
recycle
public void recycle()
Description copied from interface:OutputFilterMake the filter ready to process the next request.- Specified by:
recyclein interfaceOutputFilter
-
end
public void end() throws IOExceptionDescription copied from interface:HttpOutputBufferFinish writing the current response. It is acceptable to write extra bytes usingOutputBuffer.doWrite(java.nio.ByteBuffer)during the execution of this method.- Specified by:
endin interfaceHttpOutputBuffer- Throws:
IOException- If an I/O error occurs while writing to the client
-
-