Package io.micronaut.http.server.netty

Class NettyHttpServer

java.lang.Object

io.micronaut.http.server.netty.NettyHttpServer

All Implemented Interfaces:

ApplicationContextLifeCycle<EmbeddedServer>, ApplicationContextProvider, ApplicationEventListener<RefreshEvent>, LifeCycle, Ordered, ChannelPipelineCustomizer, WebSocketSessionRepository, NettyEmbeddedServer, NettyServerCustomizer.Registry, RefreshEventListener, EmbeddedApplication<EmbeddedServer>, GracefulShutdownCapable, EmbeddedServer, Closeable, AutoCloseable, EventListener

@Internal
public class NettyHttpServer
extends Object
implements NettyEmbeddedServer

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	Description
static final String	OUTBOUND_KEY

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

HANDLER_ACCESS_LOGGER, HANDLER_ACTIVITY_LISTENER, 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_HTTP_TO_HTTPS_REDIRECT, HANDLER_HTTP2_CONNECTION, HANDLER_HTTP2_PING_SENDER, HANDLER_HTTP2_PROTOCOL_NEGOTIATOR, HANDLER_HTTP2_SETTINGS, HANDLER_HTTP2_UPGRADE_REQUEST, HANDLER_IDLE_STATE, HANDLER_INITIAL_ERROR, HANDLER_MICRONAUT_FULL_HTTP_RESPONSE, HANDLER_MICRONAUT_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

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface io.micronaut.runtime.context.scope.refresh.RefreshEventListener

DEFAULT_POSITION

Constructor Summary

Constructors

Constructor	Description
NettyHttpServer(NettyHttpServerConfiguration serverConfiguration, NettyEmbeddedServices nettyEmbeddedServices, boolean isDefault)

Method Summary

Modifier and Type	Method	Description
void	addChannel(io.netty.channel.Channel channel)	Adds a channel to the repository.
io.netty.channel.embedded.EmbeddedChannel	buildEmbeddedChannel(boolean ssl)	Builds Embedded Channel.
void	buildEmbeddedChannel(io.netty.channel.embedded.EmbeddedChannel prototype, boolean ssl)	Builds Embedded Channel.
protected io.netty.channel.EventLoopGroup	createParentEventLoopGroup()
protected io.netty.bootstrap.ServerBootstrap	createServerBootstrap()
protected io.netty.channel.EventLoopGroup	createWorkerEventLoopGroup(@Nullable EventLoopGroupConfiguration workerConfig)
void	doOnConnect(@NonNull ChannelPipelineListener listener)	A hook to customize the pipeline upon establishing a connection.
ApplicationConfiguration	getApplicationConfiguration()
ApplicationContext	getApplicationContext()	Resolves the ApplicationContext for this class.
final Set<Integer>	getBoundPorts()	Gets the set of all ports this Netty server is bound to.
io.netty.channel.group.ChannelGroup	getChannelGroup()	Returns the ChannelGroup used to store WebSocketSessions.
URI	getContextURI()
String	getHost()
Set<String>	getObservedConfigurationPrefixes()	Returns the set of observed configuration prefixes that the event listener should listen for.
int	getPort()
String	getScheme()
NettyHttpServerConfiguration	getServerConfiguration()
URI	getURI()
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	onApplicationEvent(RefreshEvent event)	Handle an application event.
void	register(@NonNull NettyServerCustomizer customizer)	Register a new customizer with this server.
void	removeChannel(io.netty.channel.Channel channel)	Remove a channel from the repository.
OptionalLong	reportActiveTasks()	After a call to GracefulShutdownCapable.shutdownGracefully() report the state of the shutdown.
CompletionStage<?>	shutdownGracefully()	Trigger a graceful shutdown.
@NonNull NettyEmbeddedServer	start()	Starts the lifecyle component.
@NonNull NettyEmbeddedServer	stop()	Stops the life cycle component.
@NonNull NettyEmbeddedServer	stopServerOnly()	Stops the Netty instance, but keeps the ApplicationContext running.
static <T> CompletionStage<T>	toCompletionStage(io.netty.util.concurrent.Future<T> future)

Methods inherited from class java.lang.Object

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

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

isServerChannel

Methods inherited from interface io.micronaut.runtime.EmbeddedApplication

getEnvironment, isForceExit, isShutdownHookNeeded

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

isServer

Methods inherited from interface io.micronaut.context.LifeCycle

close, refresh

Methods inherited from interface io.micronaut.runtime.context.scope.refresh.RefreshEventListener

getOrder, supports

Field Details

OUTBOUND_KEY

public static final String OUTBOUND_KEY

See Also:

• Constant Field Values

Constructor Details

NettyHttpServer

public NettyHttpServer(NettyHttpServerConfiguration serverConfiguration,
 NettyEmbeddedServices nettyEmbeddedServices,
 boolean isDefault)

Parameters:

serverConfiguration - The Netty HTTP server configuration

nettyEmbeddedServices - The embedded server context

isDefault - Is this the default server

Method Details

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

@NonNull
public @NonNull NettyEmbeddedServer start()

Description copied from interface: LifeCycle

Starts the lifecyle component.

Specified by:

start in interface ApplicationContextLifeCycle<EmbeddedServer>

Specified by:

start in interface LifeCycle

Specified by:

start in interface NettyEmbeddedServer

Returns:

This lifecycle component

stop

@NonNull
public @NonNull NettyEmbeddedServer stop()

Description copied from interface: LifeCycle

Stops the life cycle component.

Specified by:

stop in interface ApplicationContextLifeCycle<EmbeddedServer>

Specified by:

stop in interface LifeCycle

Specified by:

stop in interface NettyEmbeddedServer

Returns:

This lifecycle component

stopServerOnly

@NonNull
public @NonNull NettyEmbeddedServer stopServerOnly()

Description copied from interface: NettyEmbeddedServer

Stops the Netty instance, but keeps the ApplicationContext running. This for CRaC checkpointing purposes. This method will only return after waiting for netty to stop.

Specified by:

stopServerOnly in interface NettyEmbeddedServer

Returns:

The stopped NettyEmbeddedServer

register

public void register(@NonNull
 @NonNull NettyServerCustomizer customizer)

Description copied from interface: NettyServerCustomizer.Registry

Register a new customizer with this server. Note that this method must be called before the server is started: When a listener launches, it may only respect the customizers that were registered at the time, and ignore future additions.

Specified by:

register in interface NettyEmbeddedServer

Specified by:

register in interface NettyServerCustomizer.Registry

Parameters:

customizer - The customizer to register.

getPort

public int getPort()

Specified by:

getPort in interface EmbeddedServer

Returns:

The port exposed by the server

getHost

public String getHost()

Specified by:

getHost in interface EmbeddedServer

Returns:

The host of the server

getScheme

public String getScheme()

Specified by:

getScheme in interface EmbeddedServer

Returns:

The scheme of the server (http/https)

getURL

public URL getURL()

Specified by:

getURL in interface EmbeddedServer

Returns:

The full URL to the server

getURI

public URI getURI()

Specified by:

getURI in interface EmbeddedServer

Returns:

The full URI to the server

getContextURI

public URI getContextURI()

Specified by:

getContextURI in interface EmbeddedServer

Returns:

The full URI to the server with the context path

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

getBoundPorts

public final Set<Integer> getBoundPorts()

Description copied from interface: NettyEmbeddedServer

Gets the set of all ports this Netty server is bound to.

Specified by:

getBoundPorts in interface NettyEmbeddedServer

Returns:

An immutable set of bound ports if the server has been started with NettyEmbeddedServer.start() an empty set otherwise.

createParentEventLoopGroup

protected io.netty.channel.EventLoopGroup createParentEventLoopGroup()

Returns:

The parent event loop group

createWorkerEventLoopGroup

protected io.netty.channel.EventLoopGroup createWorkerEventLoopGroup(@Nullable
 @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

toCompletionStage

public static <T> CompletionStage<T> toCompletionStage(io.netty.util.concurrent.Future<T> future)

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
 @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.

getObservedConfigurationPrefixes

public Set<String> getObservedConfigurationPrefixes()

Description copied from interface: RefreshEventListener

Returns the set of observed configuration prefixes that the event listener should listen for.

Specified by:

getObservedConfigurationPrefixes in interface RefreshEventListener

Returns:

A set of prefixes

shutdownGracefully

public CompletionStage<?> shutdownGracefully()

Description copied from interface: GracefulShutdownCapable

Trigger a graceful shutdown. The returned CompletionStage will complete when the shutdown is complete.

Note that the completion of the returned future may be user-dependent. If a user does not close their connection, the future may never terminate. Always add a timeout for a hard shutdown.

This method should not throw an exception, nor should the returned stage complete exceptionally. Just log an error instead.

Specified by:

shutdownGracefully in interface GracefulShutdownCapable

Specified by:

shutdownGracefully in interface NettyEmbeddedServer

Returns:

A future that completes when this bean is fully shut down

reportActiveTasks

public OptionalLong reportActiveTasks()

Description copied from interface: GracefulShutdownCapable

After a call to GracefulShutdownCapable.shutdownGracefully() report the state of the shutdown. If GracefulShutdownCapable.shutdownGracefully() has not been called the behavior of this method is undefined.

Specified by:

reportActiveTasks in interface GracefulShutdownCapable

Returns:

The current number of still-active tasks before the shutdown completes, or Optional.empty() if no state can be reported

onApplicationEvent

public void onApplicationEvent(RefreshEvent event)

Description copied from interface: ApplicationEventListener

Handle an application event.

Specified by:

onApplicationEvent in interface ApplicationEventListener<RefreshEvent>

Parameters:

event - the event to respond to

buildEmbeddedChannel

@Internal
public io.netty.channel.embedded.EmbeddedChannel buildEmbeddedChannel(boolean ssl)

Builds Embedded Channel.

Parameters:

ssl - whether to enable SSL

Returns:

The embedded channel with our server handlers

buildEmbeddedChannel

@Internal
public void buildEmbeddedChannel(io.netty.channel.embedded.EmbeddedChannel prototype,
 boolean ssl)

Builds Embedded Channel.

Parameters:

prototype - The embedded channel to add our handlers to

ssl - whether to enable SSL