Package io.micronaut.http.server.netty

Interface NettyEmbeddedServices

All Known Implementing Classes:
DefaultNettyEmbeddedServerFactory
@Internal public interface NettyEmbeddedServices
Internal interface with services required by the NettyHttpServer. e
Since:
3.1.0
Author:
graemerocher

  • Method Details

    • getMessageBodyHandlerRegistry

      MessageBodyHandlerRegistry getMessageBodyHandlerRegistry()
      Returns:
      The message body handler registry.

    • getOutboundHandlers

      @NonNull List<io.netty.channel.ChannelOutboundHandler> getOutboundHandlers()
      Returns:
      The channel outbound handlers

    • getApplicationContext

      @NonNull ApplicationContext getApplicationContext()
      Returns:
      The application context

    • getRequestArgumentSatisfier

      default @NonNull RequestArgumentSatisfier getRequestArgumentSatisfier()
      Returns:
      The request argument satisfier
      See Also:

    • getRouteExecutor

      @NonNull RouteExecutor getRouteExecutor()
      Returns:
      The route executor
      See Also:

    • getMediaTypeCodecRegistry

      @NonNull MediaTypeCodecRegistry getMediaTypeCodecRegistry()
      Returns:
      The media type code registry
      See Also:

    • getStaticResourceResolver

      @NonNull StaticResourceResolver getStaticResourceResolver()
      Returns:
      The static resource resolver
      See Also:

    • getExecutorSelector

      default @NonNull ExecutorSelector getExecutorSelector()
      Returns:
      The executor resolver

    • getServerSslBuilder

      @Nullable ServerSslBuilder getServerSslBuilder()
      Returns:
      The server SSL builder or null if none is configured
      See Also:

    • getChannelOptionFactory

      @NonNull ChannelOptionFactory getChannelOptionFactory()
      Returns:
      The channel option factory

    • getHttpCompressionStrategy

      @NonNull HttpCompressionStrategy getHttpCompressionStrategy()
      Returns:
      The http compression strategy

    • getWebSocketUpgradeHandler

      Optional<NettyServerWebSocketUpgradeHandler> getWebSocketUpgradeHandler(NettyEmbeddedServer embeddedServer)
      Parameters:
      embeddedServer - The server
      Returns:
      The websocket upgrade handler if present

    • getEventLoopGroupRegistry

      @NonNull EventLoopGroupRegistry getEventLoopGroupRegistry()
      Returns:
      The event loop group registry.

    • getRouter

      default @NonNull Router getRouter()
      Returns:
      Obtains the router

    • createEventLoopGroup

      @NonNull io.netty.channel.EventLoopGroup createEventLoopGroup(@NonNull EventLoopGroupConfiguration config)
      Creates the event loop group configuration.
      Parameters:
      config - The config
      Returns:
      The event loop group config

    • createEventLoopGroup

      @NonNull io.netty.channel.EventLoopGroup createEventLoopGroup(int numThreads, @NonNull ExecutorService executorService, @Nullable Integer ioRatio)
      Creates the event loop group configuration.
      Parameters:
      numThreads - The number of threads
      executorService - The executor service
      ioRatio - The I/O ratio
      Returns:
      The event loop group

    • getServerSocketChannelInstance

      @Deprecated(since="4.5.0", forRemoval=true) default @NonNull io.netty.channel.socket.ServerSocketChannel getServerSocketChannelInstance(@NonNull EventLoopGroupConfiguration workerConfig)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getChannelInstance(NettyChannelType, EventLoopGroupConfiguration) instead
      Gets the server socket channel instance.
      Parameters:
      workerConfig - The worker config
      Returns:
      The ServerSocketChannel

    • getDomainServerChannelInstance

      @Deprecated(since="4.5.0", forRemoval=true) default @NonNull io.netty.channel.ServerChannel getDomainServerChannelInstance(@NonNull EventLoopGroupConfiguration workerConfig)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getChannelInstance(NettyChannelType, EventLoopGroupConfiguration) instead
      Gets the domain server socket channel instance.
      Parameters:
      workerConfig - The worker config
      Returns:
      The DomainSocketChannel
      Throws:
      UnsupportedOperationException - if domain sockets are not supported.

    • getChannelInstance

      default @NonNull io.netty.channel.Channel getChannelInstance(NettyChannelType type, @NonNull EventLoopGroupConfiguration workerConfig)
      Gets the domain server socket channel instance.
      Parameters:
      type - The channel type to return
      workerConfig - The worker config
      Returns:
      The channel
      Throws:
      UnsupportedOperationException - if domain sockets are not supported.

    • getChannelInstance

      default @NonNull io.netty.channel.Channel getChannelInstance(NettyChannelType type, @NonNull EventLoopGroupConfiguration workerConfig, io.netty.channel.Channel parent, int fd)
      Gets the domain server socket channel instance.
      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
      Throws:
      UnsupportedOperationException - if domain sockets are not supported.

    • getEventPublisher

      <E> @NonNull ApplicationEventPublisher<E> getEventPublisher(@NonNull Class<E> eventClass)
      Get an event publisher for the server for the given type.
      Type Parameters:
      E - The event generic type
      Parameters:
      eventClass - The event publisher
      Returns:
      The event publisher

    • getSslFactory

      NettyServerSslFactory getSslFactory()

    • getCertificateProviders

      @NonNull BeanProvider<CertificateProvider> getCertificateProviders()