Package io.micronaut.http.server.netty

Class DefaultNettyEmbeddedServerFactory

java.lang.Object

io.micronaut.http.server.netty.DefaultNettyEmbeddedServerFactory

All Implemented Interfaces:

NettyEmbeddedServerFactory, NettyEmbeddedServices

@Factory
@Internal
@Bean(typed={NettyEmbeddedServerFactory.class,DefaultNettyEmbeddedServerFactory.class})
public class DefaultNettyEmbeddedServerFactory
extends Object
implements NettyEmbeddedServerFactory, NettyEmbeddedServices

Default implementation of NettyEmbeddedServerFactory.

Since:

3.1.0

Author:

graemerocher

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultNettyEmbeddedServerFactory(ApplicationContext applicationContext, RouteExecutor routeExecutor, MediaTypeCodecRegistry mediaTypeCodecRegistry, MessageBodyHandlerRegistry messageBodyHandlerRegistry, StaticResourceResolver staticResourceResolver, ThreadFactory nettyThreadFactory, HttpCompressionStrategy httpCompressionStrategy, EventLoopGroupFactory eventLoopGroupFactory, EventLoopGroupRegistry eventLoopGroupRegistry, @Nullable WebSocketUpgradeHandlerFactory webSocketUpgradeHandlerFactory)	Default constructor.

Method Summary

Modifier and Type	Method	Description
@NonNull NettyEmbeddedServer	build(@NonNull NettyHttpServerConfiguration configuration)	Builds a NettyEmbeddedServer for the given configuration.
@NonNull NettyEmbeddedServer	build(@NonNull NettyHttpServerConfiguration configuration, @Nullable ServerSslConfiguration sslConfiguration)	Builds a NettyEmbeddedServer for the given configuration.
protected @NonNull NettyEmbeddedServer	buildDefaultServer(@NonNull NettyHttpServerConfiguration configuration)	Builds the default server configuration.
@NonNull io.netty.channel.EventLoopGroup	createEventLoopGroup(int numThreads, @NonNull ExecutorService executorService, Integer ioRatio)	Creates the event loop group configuration.
io.netty.channel.EventLoopGroup	createEventLoopGroup(EventLoopGroupConfiguration config)	Creates the event loop group configuration.
ApplicationContext	getApplicationContext()
io.netty.channel.Channel	getChannelInstance(NettyChannelType type, EventLoopGroupConfiguration workerConfig)	Gets the domain server socket channel instance.
io.netty.channel.Channel	getChannelInstance(NettyChannelType type, EventLoopGroupConfiguration workerConfig, io.netty.channel.Channel parent, int fd)	Gets the domain server socket channel instance.
ChannelOptionFactory	getChannelOptionFactory()
io.netty.channel.ServerChannel	getDomainServerChannelInstance(EventLoopGroupConfiguration workerConfig)	Gets the domain server socket channel instance.
EventLoopGroupRegistry	getEventLoopGroupRegistry()
<E> ApplicationEventPublisher<E>	getEventPublisher(Class<E> eventClass)	Get an event publisher for the server for the given type.
ExecutorSelector	getExecutorSelector()
HttpCompressionStrategy	getHttpCompressionStrategy()
MediaTypeCodecRegistry	getMediaTypeCodecRegistry()
MessageBodyHandlerRegistry	getMessageBodyHandlerRegistry()
List<io.netty.channel.ChannelOutboundHandler>	getOutboundHandlers()
RequestArgumentSatisfier	getRequestArgumentSatisfier()
RouteExecutor	getRouteExecutor()
io.netty.channel.socket.ServerSocketChannel	getServerSocketChannelInstance(EventLoopGroupConfiguration workerConfig)	Gets the server socket channel instance.
ServerSslBuilder	getServerSslBuilder()
StaticResourceResolver	getStaticResourceResolver()
Optional<NettyServerWebSocketUpgradeHandler>	getWebSocketUpgradeHandler(NettyEmbeddedServer server)
protected void	setChannelOptionFactory(@Nullable ChannelOptionFactory channelOptionFactory)	Configures the channel option factory.
protected void	setOutboundHandlers(List<io.netty.channel.ChannelOutboundHandler> outboundHandlers)	Sets the outbound handlers.
protected void	setServerSslBuilder(@Nullable ServerSslBuilder serverSslBuilder)	Configures the ServerSslBuilder the server ssl builder.

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.server.netty.NettyEmbeddedServices

getRouter

Constructor Details

DefaultNettyEmbeddedServerFactory

protected DefaultNettyEmbeddedServerFactory(ApplicationContext applicationContext,
 RouteExecutor routeExecutor,
 MediaTypeCodecRegistry mediaTypeCodecRegistry,
 MessageBodyHandlerRegistry messageBodyHandlerRegistry,
 StaticResourceResolver staticResourceResolver,
 @Named("netty")
 ThreadFactory nettyThreadFactory,
 HttpCompressionStrategy httpCompressionStrategy,
 EventLoopGroupFactory eventLoopGroupFactory,
 EventLoopGroupRegistry eventLoopGroupRegistry,
 @Nullable
 @Nullable WebSocketUpgradeHandlerFactory webSocketUpgradeHandlerFactory)

Default constructor.

Parameters:

applicationContext - The app ctx

routeExecutor - The route executor

mediaTypeCodecRegistry - The media type codec

messageBodyHandlerRegistry - The message body handler registery

staticResourceResolver - The static resource resolver

nettyThreadFactory - The netty thread factory

httpCompressionStrategy - The http compression strategy

eventLoopGroupFactory - The event loop group factory

eventLoopGroupRegistry - The event loop group registry

webSocketUpgradeHandlerFactory - An optional websocket integration

Method Details

build

@NonNull
public @NonNull NettyEmbeddedServer build(@NonNull
 @NonNull NettyHttpServerConfiguration configuration)

Description copied from interface: NettyEmbeddedServerFactory

Builds a NettyEmbeddedServer for the given configuration.

Note that the returned server instance should be closed gracefully by calling the NettyEmbeddedServer.stop() method.

Specified by:

build in interface NettyEmbeddedServerFactory

Parameters:

configuration - The configuration, never null

Returns:

A NettyEmbeddedServer instance

build

@NonNull
public @NonNull NettyEmbeddedServer build(@NonNull
 @NonNull NettyHttpServerConfiguration configuration,
 @Nullable
 @Nullable ServerSslConfiguration sslConfiguration)

Description copied from interface: NettyEmbeddedServerFactory

Builds a NettyEmbeddedServer for the given configuration.

Note that the returned server instance should be closed gracefully by calling the NettyEmbeddedServer.stop() method.

Specified by:

build in interface NettyEmbeddedServerFactory

Parameters:

configuration - The configuration, never null

sslConfiguration - The SSL configuration, can be null if SSL is not required

Returns:

A NettyEmbeddedServer instance

buildDefaultServer

@Singleton
@Primary
@NonNull
protected @NonNull NettyEmbeddedServer buildDefaultServer(@NonNull
 @NonNull NettyHttpServerConfiguration configuration)

Builds the default server configuration.

Parameters:

configuration - The server configuration

Returns:

The NettyEmbeddedServer instance

getMessageBodyHandlerRegistry

public MessageBodyHandlerRegistry getMessageBodyHandlerRegistry()

Specified by:

getMessageBodyHandlerRegistry in interface NettyEmbeddedServices

Returns:

The message body handler registry.

getOutboundHandlers

public List<io.netty.channel.ChannelOutboundHandler> getOutboundHandlers()

Specified by:

getOutboundHandlers in interface NettyEmbeddedServices

Returns:

The channel outbound handlers

getApplicationContext

public ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface NettyEmbeddedServices

Returns:

The application context

getRequestArgumentSatisfier

public RequestArgumentSatisfier getRequestArgumentSatisfier()

Specified by:

getRequestArgumentSatisfier in interface NettyEmbeddedServices

Returns:

The request argument satisfier

See Also:

• RequestArgumentSatisfier

getRouteExecutor

public RouteExecutor getRouteExecutor()

Specified by:

getRouteExecutor in interface NettyEmbeddedServices

Returns:

The route executor

See Also:

• RouteExecutor

getMediaTypeCodecRegistry

public MediaTypeCodecRegistry getMediaTypeCodecRegistry()

Specified by:

getMediaTypeCodecRegistry in interface NettyEmbeddedServices

Returns:

The media type code registry

See Also:

• MediaTypeCodecRegistry

getStaticResourceResolver

public StaticResourceResolver getStaticResourceResolver()

Specified by:

getStaticResourceResolver in interface NettyEmbeddedServices

Returns:

The static resource resolver

See Also:

• StaticResourceResolver

getExecutorSelector

public ExecutorSelector getExecutorSelector()

Specified by:

getExecutorSelector in interface NettyEmbeddedServices

Returns:

The executor resolver

getServerSslBuilder

public ServerSslBuilder getServerSslBuilder()

Specified by:

getServerSslBuilder in interface NettyEmbeddedServices

Returns:

The server SSL builder or null if none is configured

See Also:

• CertificateProvidedSslBuilder

getChannelOptionFactory

public ChannelOptionFactory getChannelOptionFactory()

Specified by:

getChannelOptionFactory in interface NettyEmbeddedServices

Returns:

The channel option factory

getHttpCompressionStrategy

public HttpCompressionStrategy getHttpCompressionStrategy()

Specified by:

getHttpCompressionStrategy in interface NettyEmbeddedServices

Returns:

The http compression strategy

getWebSocketUpgradeHandler

public Optional<NettyServerWebSocketUpgradeHandler> getWebSocketUpgradeHandler(NettyEmbeddedServer server)

Specified by:

getWebSocketUpgradeHandler in interface NettyEmbeddedServices

Parameters:

server - The server

Returns:

The websocket upgrade handler if present

getEventLoopGroupRegistry

public EventLoopGroupRegistry getEventLoopGroupRegistry()

Specified by:

getEventLoopGroupRegistry in interface NettyEmbeddedServices

Returns:

The event loop group registry.

createEventLoopGroup

public io.netty.channel.EventLoopGroup createEventLoopGroup(EventLoopGroupConfiguration config)

Description copied from interface: NettyEmbeddedServices

Creates the event loop group configuration.

Specified by:

createEventLoopGroup in interface NettyEmbeddedServices

Parameters:

config - The config

Returns:

The event loop group config

getServerSocketChannelInstance

public io.netty.channel.socket.ServerSocketChannel getServerSocketChannelInstance(EventLoopGroupConfiguration workerConfig)

Description copied from interface: NettyEmbeddedServices

Gets the server socket channel instance.

Specified by:

getServerSocketChannelInstance in interface NettyEmbeddedServices

Parameters:

workerConfig - The worker config

Returns:

The ServerSocketChannel

getDomainServerChannelInstance

public io.netty.channel.ServerChannel getDomainServerChannelInstance(EventLoopGroupConfiguration workerConfig)

Description copied from interface: NettyEmbeddedServices

Gets the domain server socket channel instance.

Specified by:

getDomainServerChannelInstance in interface NettyEmbeddedServices

Parameters:

workerConfig - The worker config

Returns:

The DomainSocketChannel

getChannelInstance

public io.netty.channel.Channel getChannelInstance(NettyChannelType type,
 EventLoopGroupConfiguration workerConfig)

Description copied from interface: NettyEmbeddedServices

Gets the domain server socket channel instance.

Specified by:

getChannelInstance in interface NettyEmbeddedServices

Parameters:

type - The channel type to return

workerConfig - The worker config

Returns:

The channel

getChannelInstance

public io.netty.channel.Channel getChannelInstance(NettyChannelType type,
 EventLoopGroupConfiguration workerConfig,
 io.netty.channel.Channel parent,
 int fd)

Description copied from interface: NettyEmbeddedServices

Gets the domain server socket channel instance.

Specified by:

getChannelInstance in interface NettyEmbeddedServices

Parameters:

type - The channel type to return

workerConfig - The worker config

parent - The parent channel, or null for no parent channel

fd - The pre-defined file descriptor

Returns:

The channel

getEventPublisher

public <E> ApplicationEventPublisher<E> getEventPublisher(Class<E> eventClass)

Description copied from interface: NettyEmbeddedServices

Get an event publisher for the server for the given type.

Specified by:

getEventPublisher in interface NettyEmbeddedServices

Type Parameters:

E - The event generic type

Parameters:

eventClass - The event publisher

Returns:

The event publisher

createEventLoopGroup

@NonNull
public @NonNull io.netty.channel.EventLoopGroup createEventLoopGroup(int numThreads,
 @NonNull
 @NonNull ExecutorService executorService,
 Integer ioRatio)

Description copied from interface: NettyEmbeddedServices

Creates the event loop group configuration.

Specified by:

createEventLoopGroup in interface NettyEmbeddedServices

Parameters:

numThreads - The number of threads

executorService - The executor service

ioRatio - The I/O ratio

Returns:

The event loop group

setChannelOptionFactory

@Inject
protected void setChannelOptionFactory(@Nullable
 @Nullable ChannelOptionFactory channelOptionFactory)

Configures the channel option factory.

Parameters:

channelOptionFactory - The channel option factory.

setServerSslBuilder

@Inject
protected void setServerSslBuilder(@Nullable
 @Nullable ServerSslBuilder serverSslBuilder)

Configures the ServerSslBuilder the server ssl builder.

Parameters:

serverSslBuilder - The builder

setOutboundHandlers

@Inject
protected void setOutboundHandlers(List<io.netty.channel.ChannelOutboundHandler> outboundHandlers)

Sets the outbound handlers.

Parameters:

outboundHandlers - The ChannelOutboundHandler instances