org.springframework.boot.web.embedded.undertow

Class UndertowServletWebServerFactory

java.lang.Object

org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory

org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory

All Implemented Interfaces:

Aware, ConfigurableUndertowWebServerFactory, ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory, ConfigurableServletWebServerFactory, ServletWebServerFactory, ResourceLoaderAware

public class UndertowServletWebServerFactory
extends AbstractServletWebServerFactory
implements ConfigurableUndertowWebServerFactory, ResourceLoaderAware

ServletWebServerFactory that can be used to create UndertowServletWebServers.

Unless explicitly configured otherwise, the factory will create servers that listen for HTTP requests on port 8080.

Since:

2.0.0

Author:

Ivan Sopov, Andy Wilkinson, Marcos Barbero, Eddú Meléndez

See Also:

UndertowServletWebServer

Field Summary

Fields inherited from class org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory

logger

Constructor Summary

Constructors

Constructor and Description
UndertowServletWebServerFactory() Create a new UndertowServletWebServerFactory instance.
UndertowServletWebServerFactory(int port) Create a new UndertowServletWebServerFactory that listens for requests using the specified port.
UndertowServletWebServerFactory(String contextPath, int port) Create a new UndertowServletWebServerFactory with the specified context path and port.

Method Summary

Modifier and Type	Method and Description
void	addBuilderCustomizers(UndertowBuilderCustomizer... customizers) Add UndertowBuilderCustomizers that should be used to customize the Undertow Undertow.Builder.
void	addDeploymentInfoCustomizers(UndertowDeploymentInfoCustomizer... customizers) Add UndertowDeploymentInfoCustomizers that should be used to customize the Undertow DeploymentInfo.
String	getAccessLogPrefix()
Collection<UndertowBuilderCustomizer>	getBuilderCustomizers() Returns a mutable collection of the UndertowBuilderCustomizers that will be applied to the Undertow Undertow.Builder.
Collection<UndertowDeploymentInfoCustomizer>	getDeploymentInfoCustomizers() Returns a mutable collection of the UndertowDeploymentInfoCustomizers that will be applied to the Undertow DeploymentInfo.
protected UndertowServletWebServer	getUndertowWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, int port) Factory method called to create the UndertowServletWebServer.
WebServer	getWebServer(ServletContextInitializer... initializers) Gets a new fully configured but paused WebServer instance.
boolean	isAccessLogEnabled()
boolean	isEagerInitFilters() Return if filters should be initialized eagerly.
protected boolean	isUseForwardHeaders()
void	setAccessLogDirectory(File accessLogDirectory) Set the access log directory.
void	setAccessLogEnabled(boolean accessLogEnabled) Set whether access logs are enabled.
void	setAccessLogPattern(String accessLogPattern) Set the access log pattern.
void	setAccessLogPrefix(String accessLogPrefix) Set the access log prefix.
void	setAccessLogRotate(boolean accessLogRotate) Set whether access logs rotation is enabled.
void	setAccessLogSuffix(String accessLogSuffix) Set the access log suffix.
void	setBufferSize(Integer bufferSize) Set the buffer size.
void	setBuilderCustomizers(Collection<? extends UndertowBuilderCustomizer> customizers) Set UndertowBuilderCustomizers that should be applied to the Undertow Undertow.Builder.
void	setDeploymentInfoCustomizers(Collection<? extends UndertowDeploymentInfoCustomizer> customizers) Set UndertowDeploymentInfoCustomizers that should be applied to the Undertow DeploymentInfo.
void	setEagerInitFilters(boolean eagerInitFilters) Set whether filters should be initialized eagerly.
void	setIoThreads(Integer ioThreads) Set the number of IO Threads.
void	setResourceLoader(ResourceLoader resourceLoader)
void	setUseDirectBuffers(Boolean directBuffers) Set whether direct buffers should be used.
void	setUseForwardHeaders(boolean useForwardHeaders) Set if x-forward-* headers should be processed.
void	setWorkerThreads(Integer workerThreads) Set the number of Worker Threads.

Methods inherited from class org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory

addInitializers, getContextPath, getDisplayName, getDocumentRoot, getInitParameters, getJsp, getLocaleCharsetMappings, getMimeMappings, getSession, getUrlsOfJarsWithMetaInfResources, getValidDocumentRoot, getValidSessionStoreDir, getValidSessionStoreDir, isRegisterDefaultServlet, mergeInitializers, setContextPath, setDisplayName, setDocumentRoot, setInitializers, setInitParameters, setJsp, setLocaleCharsetMappings, setMimeMappings, setRegisterDefaultServlet, setSession, shouldRegisterJspServlet

Methods inherited from class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

addErrorPages, createTempDir, getAddress, getCompression, getErrorPages, getHttp2, getPort, getServerHeader, getShutdown, getSsl, getSslStoreProvider, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslStoreProvider

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.web.server.ConfigurableWebServerFactory

setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslStoreProvider

Methods inherited from interface org.springframework.boot.web.server.ErrorPageRegistry

addErrorPages

Constructor Detail

UndertowServletWebServerFactory

public UndertowServletWebServerFactory()

Create a new UndertowServletWebServerFactory instance.

UndertowServletWebServerFactory

public UndertowServletWebServerFactory(int port)

Create a new UndertowServletWebServerFactory that listens for requests using the specified port.

Parameters:

port - the port to listen on

UndertowServletWebServerFactory

public UndertowServletWebServerFactory(String contextPath,
                                       int port)

Create a new UndertowServletWebServerFactory with the specified context path and port.

Parameters:

contextPath - the root context path

port - the port to listen on

Method Detail

setBuilderCustomizers

public void setBuilderCustomizers(Collection<? extends UndertowBuilderCustomizer> customizers)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set UndertowBuilderCustomizers that should be applied to the Undertow Undertow.Builder. Calling this method will replace any existing customizers.

Specified by:

setBuilderCustomizers in interface ConfigurableUndertowWebServerFactory

Parameters:

customizers - the customizers to set

addBuilderCustomizers

public void addBuilderCustomizers(UndertowBuilderCustomizer... customizers)

Description copied from interface: ConfigurableUndertowWebServerFactory

Add UndertowBuilderCustomizers that should be used to customize the Undertow Undertow.Builder.

Specified by:

addBuilderCustomizers in interface ConfigurableUndertowWebServerFactory

Parameters:

customizers - the customizers to add

getBuilderCustomizers

public Collection<UndertowBuilderCustomizer> getBuilderCustomizers()

Returns a mutable collection of the UndertowBuilderCustomizers that will be applied to the Undertow Undertow.Builder.

Returns:

the customizers that will be applied

setBufferSize

public void setBufferSize(Integer bufferSize)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set the buffer size.

Specified by:

setBufferSize in interface ConfigurableUndertowWebServerFactory

Parameters:

bufferSize - buffer size

setIoThreads

public void setIoThreads(Integer ioThreads)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set the number of IO Threads.

Specified by:

setIoThreads in interface ConfigurableUndertowWebServerFactory

Parameters:

ioThreads - number of IO Threads

setWorkerThreads

public void setWorkerThreads(Integer workerThreads)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set the number of Worker Threads.

Specified by:

setWorkerThreads in interface ConfigurableUndertowWebServerFactory

Parameters:

workerThreads - number of Worker Threads

setUseDirectBuffers

public void setUseDirectBuffers(Boolean directBuffers)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set whether direct buffers should be used.

Specified by:

setUseDirectBuffers in interface ConfigurableUndertowWebServerFactory

Parameters:

directBuffers - whether direct buffers should be used

setAccessLogDirectory

public void setAccessLogDirectory(File accessLogDirectory)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set the access log directory.

Specified by:

setAccessLogDirectory in interface ConfigurableUndertowWebServerFactory

Parameters:

accessLogDirectory - access log directory

setAccessLogPattern

public void setAccessLogPattern(String accessLogPattern)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set the access log pattern.

Specified by:

setAccessLogPattern in interface ConfigurableUndertowWebServerFactory

Parameters:

accessLogPattern - access log pattern

setAccessLogPrefix

public void setAccessLogPrefix(String accessLogPrefix)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set the access log prefix.

Specified by:

setAccessLogPrefix in interface ConfigurableUndertowWebServerFactory

Parameters:

accessLogPrefix - log prefix

getAccessLogPrefix

public String getAccessLogPrefix()

setAccessLogSuffix

public void setAccessLogSuffix(String accessLogSuffix)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set the access log suffix.

Specified by:

setAccessLogSuffix in interface ConfigurableUndertowWebServerFactory

Parameters:

accessLogSuffix - access log suffix

setAccessLogEnabled

public void setAccessLogEnabled(boolean accessLogEnabled)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set whether access logs are enabled.

Specified by:

setAccessLogEnabled in interface ConfigurableUndertowWebServerFactory

Parameters:

accessLogEnabled - whether access logs are enabled

isAccessLogEnabled

public boolean isAccessLogEnabled()

setAccessLogRotate

public void setAccessLogRotate(boolean accessLogRotate)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set whether access logs rotation is enabled.

Specified by:

setAccessLogRotate in interface ConfigurableUndertowWebServerFactory

Parameters:

accessLogRotate - whether access logs rotation is enabled

setUseForwardHeaders

public void setUseForwardHeaders(boolean useForwardHeaders)

Description copied from interface: ConfigurableUndertowWebServerFactory

Set if x-forward-* headers should be processed.

Specified by:

setUseForwardHeaders in interface ConfigurableUndertowWebServerFactory

Parameters:

useForwardHeaders - if x-forward headers should be used

isUseForwardHeaders

protected final boolean isUseForwardHeaders()

setDeploymentInfoCustomizers

public void setDeploymentInfoCustomizers(Collection<? extends UndertowDeploymentInfoCustomizer> customizers)

Set UndertowDeploymentInfoCustomizers that should be applied to the Undertow DeploymentInfo. Calling this method will replace any existing customizers.

Parameters:

customizers - the customizers to set

addDeploymentInfoCustomizers

public void addDeploymentInfoCustomizers(UndertowDeploymentInfoCustomizer... customizers)

Add UndertowDeploymentInfoCustomizers that should be used to customize the Undertow DeploymentInfo.

Parameters:

customizers - the customizers to add

getDeploymentInfoCustomizers

public Collection<UndertowDeploymentInfoCustomizer> getDeploymentInfoCustomizers()

Returns a mutable collection of the UndertowDeploymentInfoCustomizers that will be applied to the Undertow DeploymentInfo.

Returns:

the customizers that will be applied

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface ResourceLoaderAware

isEagerInitFilters

public boolean isEagerInitFilters()

Return if filters should be initialized eagerly.

Returns:

true if filters are initialized eagerly, otherwise false.

Since:

2.0.0

setEagerInitFilters

public void setEagerInitFilters(boolean eagerInitFilters)

Set whether filters should be initialized eagerly.

Parameters:

eagerInitFilters - true if filters are initialized eagerly, otherwise false.

Since:

2.0.0

getWebServer

public WebServer getWebServer(ServletContextInitializer... initializers)

Description copied from interface: ServletWebServerFactory

Gets a new fully configured but paused WebServer instance. Clients should not be able to connect to the returned server until WebServer.start() is called (which happens when the ApplicationContext has been fully refreshed).

Specified by:

getWebServer in interface ServletWebServerFactory

Parameters:

initializers - ServletContextInitializers that should be applied as the server starts

Returns:

a fully configured and started WebServer

See Also:

WebServer.stop()

getUndertowWebServer

protected UndertowServletWebServer getUndertowWebServer(io.undertow.Undertow.Builder builder,
                                                        io.undertow.servlet.api.DeploymentManager manager,
                                                        int port)

Factory method called to create the UndertowServletWebServer. Subclasses can override this method to return a different UndertowServletWebServer or apply additional processing to the Undertow.Builder and DeploymentManager used to bootstrap Undertow

Parameters:

builder - the builder

manager - the deployment manager

port - the port that Undertow should listen on

Returns:

a new UndertowServletWebServer instance