org.springframework.boot.web.embedded.netty

Class NettyWebServer

  • java.lang.Object
    • org.springframework.boot.web.embedded.netty.NettyWebServer
  • All Implemented Interfaces:
    WebServer

    public class NettyWebServer
extends java.lang.Object
implements WebServer
    WebServer that can be used to control a Reactor Netty web server. Usually this class should be created using the NettyReactiveWebServerFactory and not directly.
    Since:
    2.0.0

    • Constructor Summary

      Constructors 
      Constructor and Description
      NettyWebServer(reactor.netty.http.server.HttpServer httpServer, org.springframework.http.server.reactive.ReactorHttpHandlerAdapter handlerAdapter, java.time.Duration lifecycleTimeout, Shutdown shutdown) 

    • Constructor Detail

      • NettyWebServer

        public NettyWebServer(reactor.netty.http.server.HttpServer httpServer,
                      org.springframework.http.server.reactive.ReactorHttpHandlerAdapter handlerAdapter,
                      java.time.Duration lifecycleTimeout,
                      Shutdown shutdown)

    • Method Detail

      • setRouteProviders

        public void setRouteProviders(java.util.List<NettyRouteProvider> routeProviders)

      • shutDownGracefully

        public void shutDownGracefully(GracefulShutdownCallback callback)
        Description copied from interface: WebServer
        Initiates a graceful shutdown of the web server. Handling of new requests is prevented and the given callback is invoked at the end of the attempt. The attempt can be explicitly ended by invoking WebServer.stop(). The default implementation invokes the callback immediately with GracefulShutdownResult.IMMEDIATE, i.e. no attempt is made at a graceful shutdown.
        Specified by:
        shutDownGracefully in interface WebServer
        Parameters:
        callback - the callback to invoke when the graceful shutdown completes

      • stop

        public void stop()
          throws WebServerException
        Description copied from interface: WebServer
        Stops the web server. Calling this method on an already stopped server has no effect.
        Specified by:
        stop in interface WebServer
        Throws:
        WebServerException - if the server cannot be stopped

      • getPort

        public int getPort()
        Description copied from interface: WebServer
        Return the port this server is listening on.
        Specified by:
        getPort in interface WebServer
        Returns:
        the port (or -1 if none)