org.springframework.boot.web.embedded.undertow

Class UndertowReactiveWebServerFactory

java.lang.Object

org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

org.springframework.boot.web.reactive.server.AbstractReactiveWebServerFactory

org.springframework.boot.web.embedded.undertow.UndertowReactiveWebServerFactory

All Implemented Interfaces:

ConfigurableUndertowWebServerFactory, ConfigurableReactiveWebServerFactory, ReactiveWebServerFactory, ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory

public class UndertowReactiveWebServerFactory
extends AbstractReactiveWebServerFactory
implements ConfigurableUndertowWebServerFactory

ReactiveWebServerFactory that can be used to create UndertowWebServers.

Since:

2.0.0

Author:

Brian Clozel

Constructor Summary

Constructors

Constructor and Description
UndertowReactiveWebServerFactory() Create a new UndertowReactiveWebServerFactory instance.
UndertowReactiveWebServerFactory(int port) Create a new UndertowReactiveWebServerFactory that listens for requests using the specified port.

Method Summary

Modifier and Type	Method and Description
void	addBuilderCustomizers(UndertowBuilderCustomizer... customizers) Add UndertowBuilderCustomizers that should be used to customize the Undertow Builder.
void	addDeploymentInfoCustomizers(UndertowDeploymentInfoCustomizer... customizers) Add UndertowDeploymentInfoCustomizers that should be used to customize the Undertow DeploymentInfo.
Collection<UndertowBuilderCustomizer>	getBuilderCustomizers() Returns a mutable collection of the UndertowBuilderCustomizers that will be applied to the Undertow Builder.
Collection<UndertowDeploymentInfoCustomizer>	getDeploymentInfoCustomizers() Deprecated. since 2.1.7 as the factory does not create a DeploymentInfo making customization redundant
WebServer	getWebServer(org.springframework.http.server.reactive.HttpHandler httpHandler) Gets a new fully configured but paused WebServer instance.
boolean	isAccessLogEnabled()
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 Builder.
void	setDeploymentInfoCustomizers(Collection<? extends UndertowDeploymentInfoCustomizer> customizers) Deprecated. since 2.1.7 as the factory does not create a DeploymentInfo making customization redundant
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, getSsl, getSslStoreProvider, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, 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, setSsl, setSslStoreProvider

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

addErrorPages

Constructor Detail

UndertowReactiveWebServerFactory

public UndertowReactiveWebServerFactory()

Create a new UndertowReactiveWebServerFactory instance.

UndertowReactiveWebServerFactory

public UndertowReactiveWebServerFactory(int port)

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

Parameters:

port - the port to listen on

Method Detail

getWebServer

public WebServer getWebServer(org.springframework.http.server.reactive.HttpHandler httpHandler)

Description copied from interface: ReactiveWebServerFactory

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 ReactiveWebServerFactory

Parameters:

httpHandler - the HTTP handler in charge of processing requests

Returns:

a fully configured and started WebServer

See Also:

WebServer.stop()

setDeploymentInfoCustomizers

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

Deprecated. since 2.1.7 as the factory does not create a DeploymentInfo making customization redundant

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

Parameters:

customizers - the customizers to set

getDeploymentInfoCustomizers

@Deprecated
public Collection<UndertowDeploymentInfoCustomizer> getDeploymentInfoCustomizers()

Deprecated. since 2.1.7 as the factory does not create a DeploymentInfo making customization redundant

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

Returns:

the customizers that will be applied

addDeploymentInfoCustomizers

public void addDeploymentInfoCustomizers(UndertowDeploymentInfoCustomizer... customizers)

Description copied from interface: ConfigurableUndertowWebServerFactory

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

Specified by:

addDeploymentInfoCustomizers in interface ConfigurableUndertowWebServerFactory

Parameters:

customizers - the customizers to add

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

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

isAccessLogEnabled

public boolean isAccessLogEnabled()

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

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

isUseForwardHeaders

protected final boolean isUseForwardHeaders()

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

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

setBuilderCustomizers

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

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

Parameters:

customizers - the customizers to set

getBuilderCustomizers

public Collection<UndertowBuilderCustomizer> getBuilderCustomizers()

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

Returns:

the customizers that will be applied

addBuilderCustomizers

public void addBuilderCustomizers(UndertowBuilderCustomizer... customizers)

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

Specified by:

addBuilderCustomizers in interface ConfigurableUndertowWebServerFactory

Parameters:

customizers - the customizers to add