io.micronaut.http.server.netty

Class NettyHttpServer

java.lang.Object

io.micronaut.http.server.netty.NettyHttpServer

All Implemented Interfaces:

ApplicationContextLifeCycle<EmbeddedServer>, ApplicationContextProvider, LifeCycle, ChannelPipelineCustomizer, WebSocketSessionRepository, EmbeddedApplication<EmbeddedServer>, EmbeddedServer, java.io.Closeable, java.lang.AutoCloseable

@Singleton
 @Internal
public class NettyHttpServer
extends java.lang.Object
implements EmbeddedServer, WebSocketSessionRepository, ChannelPipelineCustomizer

Implements the bootstrap and configuration logic for the Netty implementation of EmbeddedServer.

Since:

1.0

Author:

Graeme Rocher

See Also:

RoutingInBoundHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OUTBOUND_KEY

Fields inherited from interface io.micronaut.http.netty.channel.ChannelPipelineCustomizer

HANDLER_ACCESS_LOGGER, HANDLER_CONNECT_TTL, HANDLER_FLOW_CONTROL, HANDLER_HTTP_AGGREGATOR, HANDLER_HTTP_CHUNK, HANDLER_HTTP_CLIENT_CODEC, HANDLER_HTTP_CLIENT_INIT, HANDLER_HTTP_COMPRESSOR, HANDLER_HTTP_DECODER, HANDLER_HTTP_DECOMPRESSOR, HANDLER_HTTP_KEEP_ALIVE, HANDLER_HTTP_PROXY, HANDLER_HTTP_SERVER_CODEC, HANDLER_HTTP_STREAM, HANDLER_HTTP2_CONNECTION, HANDLER_HTTP2_PROTOCOL_NEGOTIATOR, HANDLER_HTTP2_SETTINGS, HANDLER_HTTP2_UPGRADE_REQUEST, HANDLER_IDLE_STATE, HANDLER_MICRONAUT_FULL_HTTP_RESPONSE, HANDLER_MICRONAUT_HTTP_RESPONSE_FULL, HANDLER_MICRONAUT_HTTP_RESPONSE_STREAM, HANDLER_MICRONAUT_INBOUND, HANDLER_MICRONAUT_SSE_CONTENT, HANDLER_MICRONAUT_SSE_EVENT_STREAM, HANDLER_MICRONAUT_WEBSOCKET_CLIENT, HANDLER_READ_TIMEOUT, HANDLER_SOCKS_5_PROXY, HANDLER_SSL, HANDLER_WEBSOCKET_UPGRADE

Constructor Summary

Constructors

Constructor and Description

NettyHttpServer(NettyHttpServerConfiguration serverConfiguration, ApplicationContext applicationContext, Router router, RequestArgumentSatisfier requestArgumentSatisfier, MediaTypeCodecRegistry mediaTypeCodecRegistry, NettyCustomizableResponseTypeHandlerRegistry customizableResponseTypeHandlerRegistry, StaticResourceResolver resourceResolver, javax.inject.Provider<java.util.concurrent.ExecutorService> ioExecutor, java.util.concurrent.ThreadFactory threadFactory, ExecutorSelector executorSelector, ServerSslBuilder serverSslBuilder, java.util.List<io.netty.channel.ChannelOutboundHandler> outboundHandlers, EventLoopGroupFactory eventLoopGroupFactory, EventLoopGroupRegistry eventLoopGroupRegistry, HttpCompressionStrategy httpCompressionStrategy, HttpContentProcessorResolver httpContentProcessorResolver, ChannelOptionFactory channelOptionFactory)

Method Summary

Modifier and Type	Method and Description
void	addChannel(io.netty.channel.Channel channel) Adds a channel to the repository.
protected io.netty.channel.EventLoopGroup	createParentEventLoopGroup()
protected io.netty.bootstrap.ServerBootstrap	createServerBootstrap()
protected io.netty.channel.EventLoopGroup	createWorkerEventLoopGroup(EventLoopGroupConfiguration workerConfig)
void	doOnConnect(ChannelPipelineListener listener) A hook to customize the pipeline upon establishing a connection.
ApplicationConfiguration	getApplicationConfiguration()
ApplicationContext	getApplicationContext() Resolves the ApplicationContext for this class.
io.netty.channel.group.ChannelGroup	getChannelGroup() Returns the ChannelGroup used to store WebSocketSessions.
java.lang.String	getHost()
int	getPort()
java.lang.String	getScheme()
NettyHttpServerConfiguration	getServerConfiguration()
java.net.URI	getURI()
java.net.URL	getURL()
WebSocketSessionRepository	getWebSocketSessionRepository()
boolean	isClientChannel()
boolean	isKeepAlive() Most servers provide a way to block such that the server doesn't exit, however some require the creation of a keep alive thread.
boolean	isRunning()
void	removeChannel(io.netty.channel.Channel channel) Remove a channel from the repository.
EmbeddedServer	start() Starts the lifecyle component.
EmbeddedServer	stop() Stops the life cycle component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.runtime.server.EmbeddedServer

isServer

Methods inherited from interface io.micronaut.runtime.EmbeddedApplication

getEnvironment, isForceExit

Methods inherited from interface io.micronaut.context.LifeCycle

close, refresh

Methods inherited from interface io.micronaut.http.netty.channel.ChannelPipelineCustomizer

isServerChannel

Field Detail

OUTBOUND_KEY

public static final java.lang.String OUTBOUND_KEY

See Also:

Constant Field Values

Constructor Detail

NettyHttpServer

@Inject
public NettyHttpServer(NettyHttpServerConfiguration serverConfiguration,
                               ApplicationContext applicationContext,
                               Router router,
                               RequestArgumentSatisfier requestArgumentSatisfier,
                               MediaTypeCodecRegistry mediaTypeCodecRegistry,
                               NettyCustomizableResponseTypeHandlerRegistry customizableResponseTypeHandlerRegistry,
                               StaticResourceResolver resourceResolver,
                               @Named(value="io")
                               javax.inject.Provider<java.util.concurrent.ExecutorService> ioExecutor,
                               @Named(value="netty")
                               java.util.concurrent.ThreadFactory threadFactory,
                               ExecutorSelector executorSelector,
                               @Nullable
                               ServerSslBuilder serverSslBuilder,
                               java.util.List<io.netty.channel.ChannelOutboundHandler> outboundHandlers,
                               EventLoopGroupFactory eventLoopGroupFactory,
                               EventLoopGroupRegistry eventLoopGroupRegistry,
                               HttpCompressionStrategy httpCompressionStrategy,
                               HttpContentProcessorResolver httpContentProcessorResolver,
                               ChannelOptionFactory channelOptionFactory)

Parameters:

serverConfiguration - The Netty HTTP server configuration

applicationContext - The application context

router - The router

requestArgumentSatisfier - The request argument satisfier

mediaTypeCodecRegistry - The Media type codec registry

customizableResponseTypeHandlerRegistry - The Netty customizable response type handler registry

resourceResolver - The static resource resolver

ioExecutor - The IO executor

threadFactory - The thread factory

executorSelector - The executor selector

serverSslBuilder - The Netty Server SSL builder

outboundHandlers - The outbound handlers

eventLoopGroupRegistry - The event loop registry

eventLoopGroupFactory - The EventLoopGroupFactory

httpCompressionStrategy - The http compression strategy

httpContentProcessorResolver - The http content processor resolver

channelOptionFactory - The channel option factory

Method Detail

isKeepAlive

public boolean isKeepAlive()

Description copied from interface: EmbeddedServer

Most servers provide a way to block such that the server doesn't exit, however some require the creation of a keep alive thread.

Specified by:

isKeepAlive in interface EmbeddedServer

Returns:

True if the server should be kept alive.

getServerConfiguration

public NettyHttpServerConfiguration getServerConfiguration()

Returns:

The configuration for the server

isRunning

public boolean isRunning()

Specified by:

isRunning in interface LifeCycle

Returns:

Whether the component is running

start

public EmbeddedServer start()

Description copied from interface: LifeCycle

Starts the lifecyle component.

Specified by:

start in interface ApplicationContextLifeCycle<EmbeddedServer>

Specified by:

start in interface LifeCycle

Returns:

This lifecycle component

stop

public EmbeddedServer stop()

Description copied from interface: LifeCycle

Stops the life cycle component.

Specified by:

stop in interface ApplicationContextLifeCycle<EmbeddedServer>

Specified by:

stop in interface LifeCycle

Returns:

This lifecycle component

getPort

public int getPort()

Specified by:

getPort in interface EmbeddedServer

Returns:

The port exposed by the server

getHost

public java.lang.String getHost()

Specified by:

getHost in interface EmbeddedServer

Returns:

The host of the server

getScheme

public java.lang.String getScheme()

Specified by:

getScheme in interface EmbeddedServer

Returns:

The scheme of the server (http/https)

getURL

public java.net.URL getURL()

Specified by:

getURL in interface EmbeddedServer

Returns:

The full URL to the server

getURI

public java.net.URI getURI()

Specified by:

getURI in interface EmbeddedServer

Returns:

The full URI to the server

getApplicationContext

public ApplicationContext getApplicationContext()

Description copied from interface: ApplicationContextProvider

Resolves the ApplicationContext for this class.

Specified by:

getApplicationContext in interface ApplicationContextProvider

Specified by:

getApplicationContext in interface EmbeddedApplication<EmbeddedServer>

Returns:

The ApplicationContext for the server

getApplicationConfiguration

public ApplicationConfiguration getApplicationConfiguration()

Specified by:

getApplicationConfiguration in interface EmbeddedApplication<EmbeddedServer>

Returns:

The ApplicationConfiguration instance

createParentEventLoopGroup

protected io.netty.channel.EventLoopGroup createParentEventLoopGroup()

Returns:

The parent event loop group

createWorkerEventLoopGroup

protected io.netty.channel.EventLoopGroup createWorkerEventLoopGroup(@Nullable
                                                                     EventLoopGroupConfiguration workerConfig)

Parameters:

workerConfig - The worker configuration

Returns:

The worker event loop group

createServerBootstrap

protected io.netty.bootstrap.ServerBootstrap createServerBootstrap()

Returns:

The Netty server bootstrap

addChannel

public void addChannel(io.netty.channel.Channel channel)

Description copied from interface: WebSocketSessionRepository

Adds a channel to the repository.

Specified by:

addChannel in interface WebSocketSessionRepository

Parameters:

channel - The channel

removeChannel

public void removeChannel(io.netty.channel.Channel channel)

Description copied from interface: WebSocketSessionRepository

Remove a channel from the repository.

Specified by:

removeChannel in interface WebSocketSessionRepository

Parameters:

channel - The channel

getChannelGroup

public io.netty.channel.group.ChannelGroup getChannelGroup()

Description copied from interface: WebSocketSessionRepository

Returns the ChannelGroup used to store WebSocketSessions.

Specified by:

getChannelGroup in interface WebSocketSessionRepository

Returns:

A ChannelGroup

getWebSocketSessionRepository

public WebSocketSessionRepository getWebSocketSessionRepository()

Returns:

NettyHttpServer which implements WebSocketSessionRepository

isClientChannel

public boolean isClientChannel()

Specified by:

isClientChannel in interface ChannelPipelineCustomizer

Returns:

Is this customizer the client.

doOnConnect

public void doOnConnect(@NonNull
                        ChannelPipelineListener listener)

Description copied from interface: ChannelPipelineCustomizer

A hook to customize the pipeline upon establishing a connection.

Specified by:

doOnConnect in interface ChannelPipelineCustomizer

Parameters:

listener - The listener The listener.