spring-boot/org.springframework.boot.web.embedded.undertow/UndertowServletWebServerFactory

UndertowServletWebServerFactory

open class UndertowServletWebServerFactory : AbstractServletWebServerFactory, 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.

Author

Ivan Sopov

Andy Wilkinson

Marcos Barbero

Eddú Meléndez

Scott Frederick

Since

2.0.0

Constructors

UndertowServletWebServerFactory

constructor()

Create a new UndertowServletWebServerFactory instance.

constructor(port: Int)

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

constructor(contextPath: String, port: Int)

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

Properties

address

open var address: InetAddress

compression

open var compression: Compression

contextPath

open var contextPath: String

cookieSameSiteSuppliers

open val cookieSameSiteSuppliers: List<CookieSameSiteSupplier>

displayName

open var displayName: String

errorPages

open val errorPages: Set<ErrorPage>

http2

open var http2: Http2

initParameters

open var initParameters: Map<String, String>

jsp

open var jsp: Jsp

localeCharsetMappings

open var localeCharsetMappings: Map<Locale, Charset>

mimeMappings

open var mimeMappings: MimeMappings

port

open var port: Int

serverHeader

open var serverHeader: String

session

open var session: Session

shutdown

open var shutdown: Shutdown

ssl

open var ssl: Ssl

sslBundles

open var sslBundles: SslBundles

Functions

addBuilderCustomizers

open fun addBuilderCustomizers(customizers: Array<UndertowBuilderCustomizer>)

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

addCookieSameSiteSuppliers

open fun addCookieSameSiteSuppliers(cookieSameSiteSuppliers: Array<CookieSameSiteSupplier>)

Add CookieSameSiteSuppliers to those that should be used to obtain the SameSite attribute of any added cookie.

addDeploymentInfoCustomizers

open fun addDeploymentInfoCustomizers(customizers: Array<UndertowDeploymentInfoCustomizer>)

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

addErrorPages

open fun addErrorPages(errorPages: Array<ErrorPage>)

Adds error pages that will be used when handling exceptions.

addInitializers

open fun addInitializers(initializers: Array<ServletContextInitializer>)

Add ServletContextInitializers to those that should be applied in addition to getWebServer parameters.

addMimeMappings

open fun addMimeMappings(mimeMappings: MimeMappings)

Adds mime-type mappings.

addWebListeners

open fun addWebListeners(webListenerClassNames: Array<String>)

Adds web listeners that will be registered with the servlet container.

getAccessLogPrefix

open fun getAccessLogPrefix(): String

getBuilderCustomizers

open fun getBuilderCustomizers(): Collection<UndertowBuilderCustomizer>

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

getDeploymentInfoCustomizers

open fun getDeploymentInfoCustomizers(): Collection<UndertowDeploymentInfoCustomizer>

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

getDocumentRoot

open fun getDocumentRoot(): File

Returns the document root which will be used by the web context to serve static files.

getWebServer

open fun getWebServer(initializers: Array<ServletContextInitializer>): WebServer

Gets a new fully configured but paused WebServer instance.

isAccessLogEnabled

open fun isAccessLogEnabled(): Boolean

isEagerFilterInit

open fun isEagerFilterInit(): Boolean

Return if filters should be eagerly initialized.

isPreservePathOnForward

open fun isPreservePathOnForward(): Boolean

Return whether the request path should be preserved on forward.

isRegisterDefaultServlet

open fun isRegisterDefaultServlet(): Boolean

Flag to indicate that the default servlet should be registered.

setAccessLogDirectory

open fun setAccessLogDirectory(accessLogDirectory: File)

Set the access log directory.

setAccessLogEnabled

open fun setAccessLogEnabled(accessLogEnabled: Boolean)

Set whether access logs are enabled.

setAccessLogPattern

open fun setAccessLogPattern(accessLogPattern: String)

Set the access log pattern.

setAccessLogPrefix

open fun setAccessLogPrefix(accessLogPrefix: String)

Set the access log prefix.

setAccessLogRotate

open fun setAccessLogRotate(accessLogRotate: Boolean)

Set whether access logs rotation is enabled.

setAccessLogSuffix

open fun setAccessLogSuffix(accessLogSuffix: String)

Set the access log suffix.

setBufferSize

open fun setBufferSize(bufferSize: Integer)

Set the buffer size.

setBuilderCustomizers

open fun setBuilderCustomizers(customizers: Collection<out UndertowBuilderCustomizer>)

Set UndertowBuilderCustomizers that should be applied to the Undertow Builder.

setCookieSameSiteSuppliers

open fun setCookieSameSiteSuppliers(cookieSameSiteSuppliers: List<out CookieSameSiteSupplier>)

Sets CookieSameSiteSuppliers that should be used to obtain the SameSite attribute of any added cookie.

setDeploymentInfoCustomizers

open fun setDeploymentInfoCustomizers(customizers: Collection<out UndertowDeploymentInfoCustomizer>)

Set UndertowDeploymentInfoCustomizers that should be applied to the Undertow DeploymentInfo.

setDocumentRoot

open fun setDocumentRoot(documentRoot: File)

Sets the document root directory which will be used by the web context to serve static files.

setEagerFilterInit

open fun setEagerFilterInit(eagerFilterInit: Boolean)

Set whether filters should be eagerly initialized.

setErrorPages

open fun setErrorPages(errorPages: Set<out ErrorPage>)

Sets the error pages that will be used when handling exceptions.

setInitializers

open fun setInitializers(initializers: List<out ServletContextInitializer>)

Sets ServletContextInitializer that should be applied in addition to getWebServer parameters.

setIoThreads

open fun setIoThreads(ioThreads: Integer)

Set the number of IO Threads.

setPreservePathOnForward

open fun setPreservePathOnForward(preservePathOnForward: Boolean)

Set whether the request path should be preserved on forward.

setRegisterDefaultServlet

open fun setRegisterDefaultServlet(registerDefaultServlet: Boolean)

Set if the DefaultServlet should be registered.

setResourceLoader

open fun setResourceLoader(resourceLoader: ResourceLoader)

setUseDirectBuffers

open fun setUseDirectBuffers(directBuffers: Boolean)

Set whether direct buffers should be used.

setUseForwardHeaders

open fun setUseForwardHeaders(useForwardHeaders: Boolean)

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

setWorkerThreads

open fun setWorkerThreads(workerThreads: Integer)

Set the number of Worker Threads.

UndertowServletWebServerFactory

Author

Since

See also

Constructors

Properties

Functions