Class UndertowWebServerFactory

java.lang.Object

org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

org.springframework.boot.undertow.UndertowWebServerFactory

All Implemented Interfaces:

ConfigurableUndertowWebServerFactory, ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory

Direct Known Subclasses:

UndertowReactiveWebServerFactory, UndertowServletWebServerFactory

public abstract class UndertowWebServerFactory
extends AbstractConfigurableWebServerFactory
implements ConfigurableUndertowWebServerFactory

Base class for factories that produce an UndertowWebServer.

Since:

4.0.0

Author:

Andy Wilkinson

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UndertowWebServerFactory()
protected	UndertowWebServerFactory(int port)

Method Summary

Modifier and Type	Method	Description
void	addBuilderCustomizers(UndertowBuilderCustomizer... customizers)	Add UndertowBuilderCustomizers that should be used to customize the Undertow Undertow.Builder.
io.undertow.Undertow.Builder	createBuilder(AbstractConfigurableWebServerFactory factory, Supplier<SslBundle> sslBundleSupplier, Supplier<Map<String,SslBundle>> serverNameSslBundlesSupplier)
List<HttpHandlerFactory>	createHttpHandlerFactories(AbstractConfigurableWebServerFactory webServerFactory, HttpHandlerFactory... initialHttpHandlerFactories)
String	getAccessLogPrefix()
Collection<UndertowBuilderCustomizer>	getBuilderCustomizers()
boolean	isAccessLogEnabled()
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	setIoThreads(Integer ioThreads)	Set the number of IO Threads.
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.server.AbstractConfigurableWebServerFactory

addErrorPages, createTempDir, getAddress, getCompression, getErrorPages, getHttp2, getPort, getServerHeader, getServerNameSslBundles, getShutdown, getSsl, getSslBundle, getSslBundles, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslBundles

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

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

addErrorPages

Constructor Details

UndertowWebServerFactory

protected UndertowWebServerFactory()

UndertowWebServerFactory

protected UndertowWebServerFactory(int port)

Method Details

getBuilderCustomizers

public Collection<UndertowBuilderCustomizer> getBuilderCustomizers()

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

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

public boolean isUseForwardHeaders()

createBuilder

public io.undertow.Undertow.Builder createBuilder(AbstractConfigurableWebServerFactory factory,
 Supplier<SslBundle> sslBundleSupplier,
 Supplier<Map<String,SslBundle>> serverNameSslBundlesSupplier)

createHttpHandlerFactories

public List<HttpHandlerFactory> createHttpHandlerFactories(AbstractConfigurableWebServerFactory webServerFactory,
 HttpHandlerFactory... initialHttpHandlerFactories)