org.microbean.jersey.netty

Class JerseyChannelInitializer

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelInitializer<Channel>

org.microbean.jersey.netty.JerseyChannelInitializer

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class JerseyChannelInitializer
extends ChannelInitializer<Channel>

A ChannelInitializer that initializes Channels by configuring their ChannelPipelines to include ChannelHandlers that transform Netty HTTP and HTTP/2 messages into Jersey ContainerRequests that are then handled by an ApplicationHandler.

Author:

Laird Nelson

See Also:

initChannel(Channel), ContainerRequest, ApplicationHandler.handle(ContainerRequest), HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
JerseyChannelInitializer(URI baseUri, SslContext sslContext, Application jaxrsApplication) Creates a new JerseyChannelInitializer.
JerseyChannelInitializer(URI baseUri, SslContext sslContext, ApplicationHandler applicationHandler) Creates a new JerseyChannelInitializer.
JerseyChannelInitializer(URI baseUri, SslContext sslContext, boolean http2Support, Application jaxrsApplication) Creates a new JerseyChannelInitializer.
JerseyChannelInitializer(URI baseUri, SslContext sslContext, boolean http2Support, ApplicationHandler applicationHandler) Creates a new JerseyChannelInitializer.
JerseyChannelInitializer(URI baseUri, SslContext sslContext, boolean http2Support, long maxIncomingContentLength, EventExecutorGroup jerseyEventExecutorGroup, ApplicationHandler applicationHandler, int flushThreshold, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator) Creates a new JerseyChannelInitializer.
JerseyChannelInitializer(URI baseUri, SslContext sslContext, boolean http2Support, long maxIncomingContentLength, EventExecutorGroup jerseyEventExecutorGroup, Application jaxrsApplication, int flushThreshold, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator) Creates a new JerseyChannelInitializer.
JerseyChannelInitializer(URI baseUri, SslContext sslContext, boolean http2Support, long maxIncomingContentLength, EventExecutorGroup jerseyEventExecutorGroup, boolean useJerseyInjection, ApplicationHandler applicationHandler, int flushThreshold, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator) Creates a new JerseyChannelInitializer.
JerseyChannelInitializer(URI baseUri, SslContext sslContext, boolean http2Support, long maxIncomingContentLength, EventExecutorGroup jerseyEventExecutorGroup, boolean useJerseyInjection, Supplier<? extends ApplicationHandler> applicationHandlerSupplier, int flushThreshold, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator) Creates a new JerseyChannelInitializer.
JerseyChannelInitializer(URI baseUri, SslContext sslContext, boolean http2Support, long maxIncomingContentLength, EventExecutorGroup jerseyEventExecutorGroup, Supplier<? extends ApplicationHandler> applicationHandlerSupplier, int flushThreshold, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator) Creates a new JerseyChannelInitializer.
JerseyChannelInitializer(URI baseUri, SslContext sslContext, boolean http2Support, Supplier<? extends ApplicationHandler> applicationHandlerSupplier) Creates a new JerseyChannelInitializer.
JerseyChannelInitializer(URI baseUri, SslContext sslContext, Supplier<? extends ApplicationHandler> applicationHandlerSupplier) Creates a new JerseyChannelInitializer.

Method Summary

Modifier and Type	Method and Description
protected SslHandler	createSslHandler(SslContext sslContext, ByteBufAllocator byteBufAllocator) Creates and returns a new SslHandler when invoked.
URI	getBaseUri() Returns the URI that was supplied at construction time.
EventExecutorGroup	getJerseyEventExecutorGroup() Returns the EventExecutorGroup that this JerseyChannelInitializer will use to offload blocking work from the Netty event loop.
protected void	initChannel(Channel channel) Initializes the supplied Channel using an appropriate sequencing of several ChannelHandlers and other Netty utility classes.

Methods inherited from class io.netty.channel.ChannelInitializer

channelRegistered, exceptionCaught, handlerAdded, handlerRemoved

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRead, channelReadComplete, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class java.lang.Object

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

Constructor Detail

JerseyChannelInitializer

public JerseyChannelInitializer(URI baseUri,
                                SslContext sslContext,
                                Application jaxrsApplication)

Creates a new JerseyChannelInitializer.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

sslContext - an SslContext; may be null in which case network communications will occur in plain text

jaxrsApplication - the Application to run; may be null somewhat pathologically

See Also:

JerseyChannelInitializer(URI, SslContext, boolean, long, EventExecutorGroup, boolean, Supplier, int, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator), ContainerRequest, SslContext, HttpServerUpgradeHandler.HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int), ApplicationHandler.handle(ContainerRequest), AbstractContainerRequestHandlingResponseWriter, HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

JerseyChannelInitializer

public JerseyChannelInitializer(URI baseUri,
                                SslContext sslContext,
                                ApplicationHandler applicationHandler)

Creates a new JerseyChannelInitializer.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

sslContext - an SslContext; may be null in which case network communications will occur in plain text

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:

JerseyChannelInitializer(URI, SslContext, boolean, long, EventExecutorGroup, boolean, Supplier, int, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator), ContainerRequest, SslContext, HttpServerUpgradeHandler.HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int), ApplicationHandler.handle(ContainerRequest), AbstractContainerRequestHandlingResponseWriter, HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

JerseyChannelInitializer

public JerseyChannelInitializer(URI baseUri,
                                SslContext sslContext,
                                Supplier<? extends ApplicationHandler> applicationHandlerSupplier)

Creates a new JerseyChannelInitializer.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

sslContext - an SslContext; may be null in which case network communications will occur in plain text

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:

JerseyChannelInitializer(URI, SslContext, boolean, long, EventExecutorGroup, boolean, Supplier, int, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator), ContainerRequest, SslContext, HttpServerUpgradeHandler.HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int), ApplicationHandler.handle(ContainerRequest), AbstractContainerRequestHandlingResponseWriter, HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

JerseyChannelInitializer

public JerseyChannelInitializer(URI baseUri,
                                SslContext sslContext,
                                boolean http2Support,
                                Application jaxrsApplication)

Creates a new JerseyChannelInitializer.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

sslContext - an SslContext; may be null in which case network communications will occur in plain text

http2Support - if HTTP/2 support (including upgrades, prior knowledge, h2c, etc.) should be enabled

jaxrsApplication - the Application to run; may be null somewhat pathologically

See Also:

JerseyChannelInitializer(URI, SslContext, boolean, long, EventExecutorGroup, boolean, Supplier, int, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator), ContainerRequest, SslContext, HttpServerUpgradeHandler.HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int), ApplicationHandler.handle(ContainerRequest), AbstractContainerRequestHandlingResponseWriter, HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

JerseyChannelInitializer

public JerseyChannelInitializer(URI baseUri,
                                SslContext sslContext,
                                boolean http2Support,
                                ApplicationHandler applicationHandler)

Creates a new JerseyChannelInitializer.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

sslContext - an SslContext; may be null in which case network communications will occur in plain text

http2Support - if HTTP/2 support (including upgrades, prior knowledge, h2c, etc.) should be enabled

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:

JerseyChannelInitializer(URI, SslContext, boolean, long, EventExecutorGroup, boolean, Supplier, int, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator), ContainerRequest, SslContext, HttpServerUpgradeHandler.HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int), ApplicationHandler.handle(ContainerRequest), AbstractContainerRequestHandlingResponseWriter, HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

JerseyChannelInitializer

public JerseyChannelInitializer(URI baseUri,
                                SslContext sslContext,
                                boolean http2Support,
                                Supplier<? extends ApplicationHandler> applicationHandlerSupplier)

Creates a new JerseyChannelInitializer.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

sslContext - an SslContext; may be null in which case network communications will occur in plain text

http2Support - if HTTP/2 support (including upgrades, prior knowledge, h2c, etc.) should be enabled

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:

JerseyChannelInitializer(URI, SslContext, boolean, long, EventExecutorGroup, boolean, Supplier, int, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator), ContainerRequest, SslContext, HttpServerUpgradeHandler.HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int), ApplicationHandler.handle(ContainerRequest), AbstractContainerRequestHandlingResponseWriter, HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

JerseyChannelInitializer

public JerseyChannelInitializer(URI baseUri,
                                SslContext sslContext,
                                boolean http2Support,
                                long maxIncomingContentLength,
                                EventExecutorGroup jerseyEventExecutorGroup,
                                Application jaxrsApplication,
                                int flushThreshold,
                                AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator)

Creates a new JerseyChannelInitializer.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

sslContext - an SslContext; may be null in which case network communications will occur in plain text

http2Support - if HTTP/2 support (including upgrades, prior knowledge, h2c, etc.) should be enabled

maxIncomingContentLength - in the case of HTTP to HTTP/2 upgrades, a long that governs the maximum permitted incoming entity length in bytes; if less than 0 then Long.MAX_VALUE will be used instead; if exactly 0 then if the HTTP message containing the upgrade header is something like a POST it will be rejected with a 413 error code; ignored entirely if http2Support is false

jerseyEventExecutorGroup - an EventExecutorGroup that will manage the thread on which an ApplicationHandler.handle(ContainerRequest) call will occur; may be null in which case a new DefaultEventExecutorGroup will be used instead

jaxrsApplication - the Application to run; may be null somewhat pathologically

flushThreshold - the minimum number of bytes that an AbstractByteBufBackedChannelOutboundInvokingOutputStream returned by an implementation of the AbstractContainerRequestHandlingResponseWriter.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 passed to an AbstractContainerRequestHandlingResponseWriter implementation; may be null

See Also:

JerseyChannelInitializer(URI, SslContext, boolean, long, EventExecutorGroup, boolean, Supplier, int, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator), ContainerRequest, SslContext, HttpServerUpgradeHandler.HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int), ApplicationHandler.handle(ContainerRequest), AbstractContainerRequestHandlingResponseWriter, HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

JerseyChannelInitializer

public JerseyChannelInitializer(URI baseUri,
                                SslContext sslContext,
                                boolean http2Support,
                                long maxIncomingContentLength,
                                EventExecutorGroup jerseyEventExecutorGroup,
                                ApplicationHandler applicationHandler,
                                int flushThreshold,
                                AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator)

Creates a new JerseyChannelInitializer.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

sslContext - an SslContext; may be null in which case network communications will occur in plain text

http2Support - if HTTP/2 support (including upgrades, prior knowledge, h2c, etc.) should be enabled

maxIncomingContentLength - in the case of HTTP to HTTP/2 upgrades, a long that governs the maximum permitted incoming entity length in bytes; if less than 0 then Long.MAX_VALUE will be used instead; if exactly 0 then if the HTTP message containing the upgrade header is something like a POST it will be rejected with a 413 error code; ignored entirely if http2Support is false

jerseyEventExecutorGroup - an EventExecutorGroup that will manage the thread on which an ApplicationHandler.handle(ContainerRequest) call will occur; may be null in which case a new DefaultEventExecutorGroup will be used instead

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 AbstractByteBufBackedChannelOutboundInvokingOutputStream returned by an implementation of the AbstractContainerRequestHandlingResponseWriter.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 passed to an AbstractContainerRequestHandlingResponseWriter implementation; may be null

See Also:

JerseyChannelInitializer(URI, SslContext, boolean, long, EventExecutorGroup, boolean, ApplicationHandler, int, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator), ContainerRequest, SslContext, HttpServerUpgradeHandler.HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int), ApplicationHandler.handle(ContainerRequest), AbstractContainerRequestHandlingResponseWriter, HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

JerseyChannelInitializer

public JerseyChannelInitializer(URI baseUri,
                                SslContext sslContext,
                                boolean http2Support,
                                long maxIncomingContentLength,
                                EventExecutorGroup jerseyEventExecutorGroup,
                                Supplier<? extends ApplicationHandler> applicationHandlerSupplier,
                                int flushThreshold,
                                AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator)

Creates a new JerseyChannelInitializer.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

sslContext - an SslContext; may be null in which case network communications will occur in plain text

http2Support - if HTTP/2 support (including upgrades, prior knowledge, h2c, etc.) should be enabled

maxIncomingContentLength - in the case of HTTP to HTTP/2 upgrades, a long that governs the maximum permitted incoming entity length in bytes; if less than 0 then Long.MAX_VALUE will be used instead; if exactly 0 then if the HTTP message containing the upgrade header is something like a POST it will be rejected with a 413 error code; ignored entirely if http2Support is false

jerseyEventExecutorGroup - an EventExecutorGroup that will manage the thread on which an ApplicationHandler.handle(ContainerRequest) call will occur; may be null in which case a new DefaultEventExecutorGroup will be used instead

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 AbstractByteBufBackedChannelOutboundInvokingOutputStream returned by an implementation of the AbstractContainerRequestHandlingResponseWriter.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 passed to an AbstractContainerRequestHandlingResponseWriter implementation; may be null

See Also:

JerseyChannelInitializer(URI, SslContext, boolean, long, EventExecutorGroup, boolean, Supplier, int, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator), ContainerRequest, SslContext, HttpServerUpgradeHandler.HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int), ApplicationHandler.handle(ContainerRequest), AbstractContainerRequestHandlingResponseWriter, HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

JerseyChannelInitializer

public JerseyChannelInitializer(URI baseUri,
                                SslContext sslContext,
                                boolean http2Support,
                                long maxIncomingContentLength,
                                EventExecutorGroup jerseyEventExecutorGroup,
                                boolean useJerseyInjection,
                                ApplicationHandler applicationHandler,
                                int flushThreshold,
                                AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator)

Creates a new JerseyChannelInitializer.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

sslContext - an SslContext; may be null in which case network communications will occur in plain text

http2Support - if HTTP/2 support (including upgrades, prior knowledge, h2c, etc.) should be enabled

maxIncomingContentLength - in the case of HTTP to HTTP/2 upgrades, a long that governs the maximum permitted incoming entity length in bytes; if less than 0 then Long.MAX_VALUE will be used instead; if exactly 0 then if the HTTP message containing the upgrade header is something like a POST it will be rejected with a 413 error code; ignored entirely if http2Support is false

jerseyEventExecutorGroup - an EventExecutorGroup that will manage the thread on which an ApplicationHandler.handle(ContainerRequest) call will occur; may be null in which case a new DefaultEventExecutorGroup will be used instead

useJerseyInjection - if true then certain Netty constructs like ChannelHandlerContext will be made available for dependency injection in user applications using Jersey's native dependency injection facilities; if false then these facilities will not be used or referenced

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 AbstractByteBufBackedChannelOutboundInvokingOutputStream returned by an implementation of the AbstractContainerRequestHandlingResponseWriter.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 passed to an AbstractContainerRequestHandlingResponseWriter implementation; may be null

See Also:

ContainerRequest, SslContext, HttpServerUpgradeHandler.HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int), ApplicationHandler.handle(ContainerRequest), AbstractContainerRequestHandlingResponseWriter, HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

JerseyChannelInitializer

public JerseyChannelInitializer(URI baseUri,
                                SslContext sslContext,
                                boolean http2Support,
                                long maxIncomingContentLength,
                                EventExecutorGroup jerseyEventExecutorGroup,
                                boolean useJerseyInjection,
                                Supplier<? extends ApplicationHandler> applicationHandlerSupplier,
                                int flushThreshold,
                                AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator)

Creates a new JerseyChannelInitializer.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

sslContext - an SslContext; may be null in which case network communications will occur in plain text

http2Support - if HTTP/2 support (including upgrades, prior knowledge, h2c, etc.) should be enabled

maxIncomingContentLength - in the case of HTTP to HTTP/2 upgrades, a long that governs the maximum permitted incoming entity length in bytes; if less than 0 then Long.MAX_VALUE will be used instead; if exactly 0 then if the HTTP message containing the upgrade header is something like a POST it will be rejected with a 413 error code; ignored entirely if http2Support is false

jerseyEventExecutorGroup - an EventExecutorGroup that will manage the thread on which an ApplicationHandler.handle(ContainerRequest) call will occur; may be null in which case a new DefaultEventExecutorGroup will be used instead

useJerseyInjection - if true then certain Netty constructs like ChannelHandlerContext will be made available for dependency injection in user applications using Jersey's native dependency injection facilities; if false then these facilities will not be used or referenced

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 AbstractByteBufBackedChannelOutboundInvokingOutputStream returned by an implementation of the AbstractContainerRequestHandlingResponseWriter.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 passed to an AbstractContainerRequestHandlingResponseWriter implementation; may be null

See Also:

ContainerRequest, SslContext, HttpServerUpgradeHandler.HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int), ApplicationHandler.handle(ContainerRequest), AbstractContainerRequestHandlingResponseWriter, HttpObjectToContainerRequestDecoder, HttpContainerRequestHandlingResponseWriter, Http2StreamFrameToContainerRequestDecoder, Http2ContainerRequestHandlingResponseWriter

Method Detail

getJerseyEventExecutorGroup

public final EventExecutorGroup getJerseyEventExecutorGroup()

Returns the EventExecutorGroup that this JerseyChannelInitializer will use to offload blocking work from the Netty event loop.

This method never returns null.

Returns:

a non-null EventExecutorGroup

See Also:

JerseyChannelInitializer(URI, SslContext, boolean, long, EventExecutorGroup, boolean, Supplier, int, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator)

getBaseUri

public final URI getBaseUri()

Returns the URI that was supplied at construction time.

This method may return null.

Returns:

the URI that was supplied at construction time, or null

See Also:

JerseyChannelInitializer(URI, SslContext, boolean, long, EventExecutorGroup, boolean, Supplier, int, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator)

initChannel

protected final void initChannel(Channel channel)

Initializes the supplied Channel using an appropriate sequencing of several ChannelHandlers and other Netty utility classes.

The ChannelHandlers and other classes involved include:

• HttpObjectToContainerRequestDecoder
• HttpContainerRequestHandlingResponseWriter
• Http2StreamFrameToContainerRequestDecoder
• Http2ContainerRequestHandlingResponseWriter
• HttpServerCodec
• HttpServerUpgradeHandler.UpgradeCodecFactory
• HttpServerUpgradeHandler.UpgradeCodec
• Http2FrameCodecBuilder
• Http2FrameCodec
• Http2ServerUpgradeCodec
• Http2MultiplexHandler
• HttpServerUpgradeHandler
• CleartextHttp2ServerUpgradeHandler
• HttpServerExpectContinueHandler
• HttpNegotiationHandler

All of these classes collaborate to form a ChannelPipeline that can handle HTTP 1.0, HTTP 1.1 and HTTP/2 scenarios, including upgrades.

Specified by:

initChannel in class ChannelInitializer<Channel>

Parameters:

channel - the Channel to initialize; must not be null

Throws:

NullPointerException - if channel is null, or if the return value of channel.pipeline() is null

createSslHandler

protected SslHandler createSslHandler(SslContext sslContext,
                                      ByteBufAllocator byteBufAllocator)

Creates and returns a new SslHandler when invoked.

This method never returns null.

Overrides of this method must not return null.

This implementation calls sslContext.newHandler(byteBufAllocator) and returns the result.

Parameters:

sslContext - the SslContext that may assist in the creation; must not be null

byteBufAllocator - a ByteBufAllocator that may assist in the creation; must not be null

Returns:

a new SslHandler; never null

Throws:

NullPointerException - if sslContext is null

See Also:

SslContext.newHandler(ByteBufAllocator)