org.springframework.boot.web.embedded.undertow

Class UndertowServletWebServer

java.lang.Object

org.springframework.boot.web.embedded.undertow.UndertowServletWebServer

All Implemented Interfaces:

WebServer

public class UndertowServletWebServer
extends Object
implements WebServer

WebServer that can be used to control an embedded Undertow server. Typically this class should be created using UndertowServletWebServerFactory and not directly.

Since:

2.0.0

Author:

Ivan Sopov, Andy Wilkinson, Eddú Meléndez, Christoph Dreis, Kristine Jetzke

See Also:

UndertowServletWebServerFactory

Constructor Summary

Constructors

Constructor and Description
UndertowServletWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, String contextPath, boolean useForwardHeaders, boolean autoStart, Compression compression) Create a new UndertowServletWebServer instance.
UndertowServletWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, String contextPath, boolean useForwardHeaders, boolean autoStart, Compression compression, String serverHeader) Create a new UndertowServletWebServer instance.
UndertowServletWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, String contextPath, boolean autoStart, Compression compression) Create a new UndertowServletWebServer instance.

Method Summary

Modifier and Type	Method and Description
io.undertow.servlet.api.DeploymentManager	getDeploymentManager()
int	getPort() Return the port this server is listening on.
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

UndertowServletWebServer

public UndertowServletWebServer(io.undertow.Undertow.Builder builder,
                                io.undertow.servlet.api.DeploymentManager manager,
                                String contextPath,
                                boolean autoStart,
                                Compression compression)

Create a new UndertowServletWebServer instance.

Parameters:

builder - the builder

manager - the deployment manager

contextPath - the root context path

autoStart - if the server should be started

compression - compression configuration

UndertowServletWebServer

public UndertowServletWebServer(io.undertow.Undertow.Builder builder,
                                io.undertow.servlet.api.DeploymentManager manager,
                                String contextPath,
                                boolean useForwardHeaders,
                                boolean autoStart,
                                Compression compression)

Create a new UndertowServletWebServer instance.

Parameters:

builder - the builder

manager - the deployment manager

contextPath - the root context path

useForwardHeaders - if x-forward headers should be used

autoStart - if the server should be started

compression - compression configuration

UndertowServletWebServer

public UndertowServletWebServer(io.undertow.Undertow.Builder builder,
                                io.undertow.servlet.api.DeploymentManager manager,
                                String contextPath,
                                boolean useForwardHeaders,
                                boolean autoStart,
                                Compression compression,
                                String serverHeader)

Create a new UndertowServletWebServer instance.

Parameters:

builder - the builder

manager - the deployment manager

contextPath - the root context path

useForwardHeaders - if x-forward headers should be used

autoStart - if the server should be started

compression - compression configuration

serverHeader - string to be used in HTTP header

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

getDeploymentManager

public io.undertow.servlet.api.DeploymentManager getDeploymentManager()

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)