org.springframework.boot.web.embedded.undertow

Class UndertowWebServer

  • java.lang.Object
    • org.springframework.boot.web.embedded.undertow.UndertowWebServer

    • Constructor Detail

      • UndertowWebServer

        public UndertowWebServer(io.undertow.Undertow.Builder builder,
                         boolean autoStart)
        Create a new UndertowWebServer instance.
        Parameters:
        builder - the builder
        autoStart - if the server should be started

      • UndertowWebServer

        @Deprecated
public UndertowWebServer(io.undertow.Undertow.Builder builder,
                                     boolean autoStart,
                                     java.io.Closeable closeable)
        Deprecated. since 2.3.0 for removal in 2.5.0 in favor of UndertowWebServer(io.undertow.Undertow.Builder, Iterable, boolean)
        Create a new UndertowWebServer instance.
        Parameters:
        builder - the builder
        autoStart - if the server should be started
        closeable - called when the server is stopped
        Since:
        2.0.4

      • UndertowWebServer

        public UndertowWebServer(io.undertow.Undertow.Builder builder,
                         java.lang.Iterable<HttpHandlerFactory> httpHandlerFactories,
                         boolean autoStart)
        Create a new UndertowWebServer instance.
        Parameters:
        builder - the builder
        httpHandlerFactories - the handler factories
        autoStart - if the server should be started
        Since:
        2.3.0

    • Method Detail

      • createHttpHandler

        protected io.undertow.server.HttpHandler createHttpHandler()

      • 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)

      • 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

      • getStartLogMessage

        protected java.lang.String getStartLogMessage()