Package org.eclipse.jetty.server

Interface HttpOutput.Interceptor

All Known Subinterfaces:

BufferedResponseHandler.BufferedInterceptor

All Known Implementing Classes:

GzipHttpOutputInterceptor, HTTP2ServerConnection.ServerHttpChannelOverHTTP2, HttpChannel, HttpChannelOverFCGI, HttpChannelOverHttp, HttpChannelOverHTTP2, HttpChannelOverHTTP3

Enclosing class:

HttpOutput

public static interface HttpOutput.Interceptor

The HttpOutput.Interceptor is a single intercept point for all output written to the HttpOutput: via writer; via output stream; asynchronously; or blocking.

The Interceptor can be used to implement translations (eg Gzip) or additional buffering that acts on all output. Interceptors are created in a chain, so that multiple concerns may intercept.

The HttpChannel is an HttpOutput.Interceptor and is always the last link in any Interceptor chain.

Responses are committed by the first call to write(ByteBuffer, boolean, Callback) and closed by a call to write(ByteBuffer, boolean, Callback) with the last boolean set true. If no content is available to commit or close, then a null buffer is passed.

Method Summary

Modifier and Type	Method	Description
HttpOutput.Interceptor	getNextInterceptor()
default void	resetBuffer()	Reset the buffers.
void	write(ByteBuffer content, boolean last, Callback callback)	Write content.

Method Details

write

void write(ByteBuffer content,
 boolean last,
 Callback callback)

Write content. The response is committed by the first call to write and is closed by a call with last == true. Empty content buffers may be passed to force a commit or close.

Parameters:

content - The content to be written or an empty buffer.

last - True if this is the last call to write

callback - The callback to use to indicate Callback.succeeded() or Callback.failed(Throwable).

getNextInterceptor

HttpOutput.Interceptor getNextInterceptor()

Returns:

The next Interceptor in the chain or null if this is the last Interceptor in the chain.

resetBuffer

default void resetBuffer()
                  throws IllegalStateException

Reset the buffers.

If the Interceptor contains buffers then reset them.

Throws:

IllegalStateException - Thrown if the response has been committed and buffers and/or headers cannot be reset.