Package org.springframework.boot.web.embedded.undertow

Interface ConfigurableUndertowWebServerFactory

All Superinterfaces:

ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory

All Known Implementing Classes:

UndertowReactiveWebServerFactory, UndertowServletWebServerFactory

public interface ConfigurableUndertowWebServerFactory
extends ConfigurableWebServerFactory

ConfigurableWebServerFactory for Undertow-specific features.

Since:

2.0.0

Author:

Brian Clozel

See Also:

• UndertowServletWebServerFactory
• UndertowReactiveWebServerFactory

Method Summary

Modifier and Type	Method	Description
void	addBuilderCustomizers(UndertowBuilderCustomizer... customizers)	Add UndertowBuilderCustomizers that should be used to customize the Undertow Undertow.Builder.
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 useDirectBuffers)	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 interface org.springframework.boot.web.server.ConfigurableWebServerFactory

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

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

addErrorPages

Method Details

setBuilderCustomizers

void setBuilderCustomizers(Collection<? extends UndertowBuilderCustomizer> customizers)

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

Parameters:

customizers - the customizers to set

Since:

2.3.0

addBuilderCustomizers

void addBuilderCustomizers(UndertowBuilderCustomizer... customizers)

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

Parameters:

customizers - the customizers to add

setBufferSize

void setBufferSize(Integer bufferSize)

Set the buffer size.

Parameters:

bufferSize - buffer size

setIoThreads

void setIoThreads(Integer ioThreads)

Set the number of IO Threads.

Parameters:

ioThreads - number of IO Threads

setWorkerThreads

void setWorkerThreads(Integer workerThreads)

Set the number of Worker Threads.

Parameters:

workerThreads - number of Worker Threads

setUseDirectBuffers

void setUseDirectBuffers(Boolean useDirectBuffers)

Set whether direct buffers should be used.

Parameters:

useDirectBuffers - whether direct buffers should be used

setAccessLogDirectory

void setAccessLogDirectory(File accessLogDirectory)

Set the access log directory.

Parameters:

accessLogDirectory - access log directory

setAccessLogPattern

void setAccessLogPattern(String accessLogPattern)

Set the access log pattern.

Parameters:

accessLogPattern - access log pattern

setAccessLogPrefix

void setAccessLogPrefix(String accessLogPrefix)

Set the access log prefix.

Parameters:

accessLogPrefix - log prefix

setAccessLogSuffix

void setAccessLogSuffix(String accessLogSuffix)

Set the access log suffix.

Parameters:

accessLogSuffix - access log suffix

setAccessLogEnabled

void setAccessLogEnabled(boolean accessLogEnabled)

Set whether access logs are enabled.

Parameters:

accessLogEnabled - whether access logs are enabled

setAccessLogRotate

void setAccessLogRotate(boolean accessLogRotate)

Set whether access logs rotation is enabled.

Parameters:

accessLogRotate - whether access logs rotation is enabled

setUseForwardHeaders

void setUseForwardHeaders(boolean useForwardHeaders)

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

Parameters:

useForwardHeaders - if x-forward headers should be used