org.springframework.boot.web.embedded.undertow

Class UndertowServletWebServer

java.lang.Object

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

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

All Implemented Interfaces:

WebServer

public class UndertowServletWebServer
extends UndertowWebServer

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) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of UndertowServletWebServer(io.undertow.Undertow.Builder, Iterable, String, boolean)
UndertowServletWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, String contextPath, boolean useForwardHeaders, boolean autoStart, Compression compression, String serverHeader) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of UndertowServletWebServer(io.undertow.Undertow.Builder, Iterable, String, boolean)
UndertowServletWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, String contextPath, boolean autoStart, Compression compression) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of UndertowServletWebServer(io.undertow.Undertow.Builder, Iterable, String, boolean)
UndertowServletWebServer(io.undertow.Undertow.Builder builder, Iterable<HttpHandlerFactory> httpHandlerFactories, String contextPath, boolean autoStart) Create a new UndertowServletWebServer instance.

Method Summary

Modifier and Type	Method and Description
protected io.undertow.server.HttpHandler	createHttpHandler()
io.undertow.servlet.api.DeploymentManager	getDeploymentManager()
protected String	getStartLogMessage()

Methods inherited from class org.springframework.boot.web.embedded.undertow.UndertowWebServer

getPort, shutDownGracefully, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

UndertowServletWebServer

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

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of UndertowServletWebServer(io.undertow.Undertow.Builder, Iterable, String, boolean)

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

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

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of UndertowServletWebServer(io.undertow.Undertow.Builder, Iterable, String, boolean)

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

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

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of UndertowServletWebServer(io.undertow.Undertow.Builder, Iterable, String, boolean)

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

UndertowServletWebServer

public UndertowServletWebServer(io.undertow.Undertow.Builder builder,
                                Iterable<HttpHandlerFactory> httpHandlerFactories,
                                String contextPath,
                                boolean autoStart)

Create a new UndertowServletWebServer instance.

Parameters:

builder - the builder

httpHandlerFactories - the handler factories

contextPath - the root context path

autoStart - if the server should be started

Since:

2.3.0

Method Detail

createHttpHandler

protected io.undertow.server.HttpHandler createHttpHandler()

Overrides:

createHttpHandler in class UndertowWebServer

getStartLogMessage

protected String getStartLogMessage()

Overrides:

getStartLogMessage in class UndertowWebServer

getDeploymentManager

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