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 usingUndertowServletWebServerFactory
and not directly.- Since:
- 2.0.0
- See Also:
UndertowServletWebServerFactory
Constructor Summary
Constructors Constructor Description UndertowServletWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, String contextPath, boolean useForwardHeaders, boolean autoStart, Compression compression)
Create a newUndertowServletWebServer
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 newUndertowServletWebServer
instance.UndertowServletWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, String contextPath, boolean autoStart, Compression compression)
Create a newUndertowServletWebServer
instance.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.
Constructor Detail
UndertowServletWebServer
public UndertowServletWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, String contextPath, boolean autoStart, Compression compression)
Create a newUndertowServletWebServer
instance.- Parameters:
builder
- the buildermanager
- the deployment managercontextPath
- the root context pathautoStart
- if the server should be startedcompression
- 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 newUndertowServletWebServer
instance.- Parameters:
builder
- the buildermanager
- the deployment managercontextPath
- the root context pathuseForwardHeaders
- if x-forward headers should be usedautoStart
- if the server should be startedcompression
- 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 newUndertowServletWebServer
instance.- Parameters:
builder
- the buildermanager
- the deployment managercontextPath
- the root context pathuseForwardHeaders
- if x-forward headers should be usedautoStart
- if the server should be startedcompression
- compression configurationserverHeader
- 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 interfaceWebServer
- 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 interfaceWebServer
- Throws:
WebServerException
- if the server cannot be stopped