org.springframework.boot.web.embedded.undertow

Class UndertowWebServer

java.lang.Object

org.springframework.boot.web.embedded.undertow.UndertowWebServer

All Implemented Interfaces:

WebServer

Direct Known Subclasses:

UndertowServletWebServer

public class UndertowWebServer
extends Object
implements WebServer

WebServer that can be used to control an Undertow web server. Usually this class should be created using the UndertowReactiveWebServerFactory and not directly.

Since:

2.0.0

Author:

Ivan Sopov, Andy Wilkinson, Eddú Meléndez, Christoph Dreis, Brian Clozel

Constructor Summary

Constructors

Constructor and Description
UndertowWebServer(io.undertow.Undertow.Builder builder, boolean autoStart) Create a new UndertowWebServer instance.
UndertowWebServer(io.undertow.Undertow.Builder builder, boolean autoStart, Closeable closeable) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of UndertowWebServer(io.undertow.Undertow.Builder, Iterable, boolean)
UndertowWebServer(io.undertow.Undertow.Builder builder, Iterable<HttpHandlerFactory> httpHandlerFactories, boolean autoStart) Create a new UndertowWebServer instance.

Method Summary

Modifier and Type	Method and Description
protected io.undertow.server.HttpHandler	createHttpHandler()
int	getPort() Return the port this server is listening on.
protected String	getStartLogMessage()
void	shutDownGracefully(GracefulShutdownCallback callback) Initiates a graceful shutdown of the web server.
void	start() Starts the web server.
void	stop() Stops the web server.

Methods inherited from class java.lang.Object

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

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,
                                     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,
                         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

start

public void start()
           throws WebServerException

Description copied from interface: WebServer

Starts the web server. Calling this method on an already started server has no effect.

Specified by:

start in interface WebServer

Throws:

WebServerException - if the server cannot be started

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 String getStartLogMessage()