org.microbean.jersey.netty

Class HttpContainerRequestHandlingResponseWriter

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

org.microbean.jersey.netty.AbstractContainerRequestHandlingResponseWriter<HttpContent>

org.microbean.jersey.netty.HttpContainerRequestHandlingResponseWriter

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ContainerResponseWriter

public final class HttpContainerRequestHandlingResponseWriter
extends AbstractContainerRequestHandlingResponseWriter<HttpContent>

An AbstractContainerRequestHandlingResponseWriter implemented in terms of HttpRequests, HttpResponses and ByteBufBackedChannelOutboundInvokingHttpContentOutputStreams.

Author:

Laird Nelson

See Also:

AbstractContainerRequestHandlingResponseWriter, ByteBufBackedChannelOutboundInvokingHttpContentOutputStream, writeStatusAndHeaders(long, ContainerResponse), createOutputStream(long, ContainerResponse)

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.jersey.server.spi.ContainerResponseWriter

ContainerResponseWriter.TimeoutHandler

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
HttpContainerRequestHandlingResponseWriter(ApplicationHandler applicationHandler) Creates a new HttpContainerRequestHandlingResponseWriter.
HttpContainerRequestHandlingResponseWriter(ApplicationHandler applicationHandler, int flushThreshold, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator) Creates a new HttpContainerRequestHandlingResponseWriter.
HttpContainerRequestHandlingResponseWriter(Supplier<? extends ApplicationHandler> applicationHandlerSupplier) Creates a new HttpContainerRequestHandlingResponseWriter.
HttpContainerRequestHandlingResponseWriter(Supplier<? extends ApplicationHandler> applicationHandlerSupplier, int flushThreshold, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator) Creates a new HttpContainerRequestHandlingResponseWriter.

Method Summary

Modifier and Type	Method and Description
void	commit() Overrides AbstractContainerRequestHandlingResponseWriter.commit() to still effectively do nothing, but clean up some internal state.
protected AbstractChannelOutboundInvokingOutputStream<? extends HttpContent>	createOutputStream(long contentLength, ContainerResponse containerResponse) Creates and returns a new ByteBufBackedChannelOutboundInvokingHttpContentOutputStream.
protected void	writeFailureMessage(Throwable failureCause) Writes an appropriate failure message using the return value of the AbstractContainerRequestHandlingResponseWriter.getChannelHandlerContext() method.
protected boolean	writeStatusAndHeaders(long contentLength, ContainerResponse containerResponse) Writes the status and headers portion of the response present in the supplied ContainerResponse and returns true if further output is forthcoming.

Methods inherited from class org.microbean.jersey.netty.AbstractContainerRequestHandlingResponseWriter

channelActive, channelRead, channelReadComplete, copyHeaders, enableResponseBuffering, failure, getByteBufCreator, getChannelHandlerContext, getFlushThreshold, setSuspendTimeout, suspend, writeResponseStatusAndHeaders

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelInactive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

HttpContainerRequestHandlingResponseWriter

public HttpContainerRequestHandlingResponseWriter(ApplicationHandler applicationHandler)

Creates a new HttpContainerRequestHandlingResponseWriter.

Parameters:

applicationHandler - an ApplicationHandler representing a Jakarta RESTful Web Services application whose ApplicationHandler.handle(ContainerRequest) method will serve as the bridge between Netty and Jersey; may be null somewhat pathologically but normally is not

See Also:

ApplicationHandler, ApplicationHandler.handle(ContainerRequest)

HttpContainerRequestHandlingResponseWriter

public HttpContainerRequestHandlingResponseWriter(ApplicationHandler applicationHandler,
                                                  int flushThreshold,
                                                  AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator)

Creates a new HttpContainerRequestHandlingResponseWriter.

Parameters:

applicationHandler - an ApplicationHandler representing a Jakarta RESTful Web Services application whose ApplicationHandler.handle(ContainerRequest) method will serve as the bridge between Netty and Jersey; may be null somewhat pathologically but normally is not

flushThreshold - the minimum number of bytes that an OutputStream returned by the createOutputStream(long, ContainerResponse) method must write before an automatic flush may take place; if less than 0 0 will be used instead; if Integer.MAX_VALUE then it is suggested that no automatic flushing will occur

byteBufCreator - a AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator that will be used by the createOutputStream(long, ContainerResponse) method; may be null

See Also:

ApplicationHandler, ApplicationHandler.handle(ContainerRequest)

HttpContainerRequestHandlingResponseWriter

public HttpContainerRequestHandlingResponseWriter(Supplier<? extends ApplicationHandler> applicationHandlerSupplier)

Creates a new HttpContainerRequestHandlingResponseWriter.

Parameters:

applicationHandlerSupplier - a Supplier of an ApplicationHandler representing a Jakarta RESTful Web Services application whose ApplicationHandler.handle(ContainerRequest) method will serve as the bridge between Netty and Jersey; may be null somewhat pathologically but normally is not

See Also:

ApplicationHandler, ApplicationHandler.handle(ContainerRequest)

HttpContainerRequestHandlingResponseWriter

public HttpContainerRequestHandlingResponseWriter(Supplier<? extends ApplicationHandler> applicationHandlerSupplier,
                                                  int flushThreshold,
                                                  AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator)

Creates a new HttpContainerRequestHandlingResponseWriter.

Parameters:

applicationHandlerSupplier - a Supplier of an ApplicationHandler representing a Jakarta RESTful Web Services application whose ApplicationHandler.handle(ContainerRequest) method will serve as the bridge between Netty and Jersey; may be null somewhat pathologically but normally is not

flushThreshold - the minimum number of bytes that an OutputStream returned by the createOutputStream(long, ContainerResponse) method must write before an automatic flush may take place; if less than 0 0 will be used instead; if Integer.MAX_VALUE then it is suggested that no automatic flushing will occur

byteBufCreator - a AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator that will be used by the createOutputStream(long, ContainerResponse) method; may be null

See Also:

ApplicationHandler, ApplicationHandler.handle(ContainerRequest)

Method Detail

writeStatusAndHeaders

protected final boolean writeStatusAndHeaders(long contentLength,
                                              ContainerResponse containerResponse)

Writes the status and headers portion of the response present in the supplied ContainerResponse and returns true if further output is forthcoming.

This implementation writes an instance of either DefaultHttpResponse or DefaultFullHttpResponse.

Specified by:

writeStatusAndHeaders in class AbstractContainerRequestHandlingResponseWriter<HttpContent>

Parameters:

contentLength - the content length as determined by the logic encapsulated by the ApplicationHandler.handle(ContainerRequest) method; a value less than zero indicates an unknown content length

containerResponse - the ContainerResponse containing status and headers information; must not be null

Returns:

true if the createOutputStream(long, ContainerResponse) method should be invoked, i.e. if further output is forthcoming

Throws:

NullPointerException - if containerResponse is null

IllegalArgumentException - if the supplied ContainerResponse returns null from its ContainerResponse.getRequestContext() method or if that ContainerRequest returns something that is not an HttpRequest from invoking getProperty("io.netty.handler.codec.http.HttpRequest") on it

See Also:

ApplicationHandler.handle(ContainerRequest), createOutputStream(long, ContainerResponse)

createOutputStream

protected final AbstractChannelOutboundInvokingOutputStream<? extends HttpContent> createOutputStream(long contentLength,
                                                                                                      ContainerResponse containerResponse)

Creates and returns a new ByteBufBackedChannelOutboundInvokingHttpContentOutputStream.

This method never returns null.

Specified by:

createOutputStream in class AbstractContainerRequestHandlingResponseWriter<HttpContent>

Parameters:

contentLength - the content length as determined by the logic encapsulated by the ApplicationHandler.handle(ContainerRequest) method; must not be 0L

containerResponse - a ContainerResponse for which an OutputStream is being created and returned; must not be null; ignored by this implementation

Returns:

a new ByteBufBackedChannelOutboundInvokingHttpContentOutputStream

Throws:

NullPointerException - if containerResponse is null or if AbstractContainerRequestHandlingResponseWriter.getChannelHandlerContext() returns null

IllegalArgumentException - if contentLength is 0L

See Also:

ByteBufBackedChannelOutboundInvokingHttpContentOutputStream

commit

public final void commit()

Overrides AbstractContainerRequestHandlingResponseWriter.commit() to still effectively do nothing, but clean up some internal state.

Specified by:

commit in interface ContainerResponseWriter

Overrides:

commit in class AbstractContainerRequestHandlingResponseWriter<HttpContent>

See Also:

AbstractContainerRequestHandlingResponseWriter.commit()

writeFailureMessage

protected final void writeFailureMessage(Throwable failureCause)

Writes an appropriate failure message using the return value of the AbstractContainerRequestHandlingResponseWriter.getChannelHandlerContext() method.

Specified by:

writeFailureMessage in class AbstractContainerRequestHandlingResponseWriter<HttpContent>

Parameters:

failureCause - the Throwable responsible for this method's invocation; may be null in pathological cases; ignored by this implementation

Throws:

NullPointerException - if AbstractContainerRequestHandlingResponseWriter.getChannelHandlerContext() returns null