spring-boot/org.springframework.boot.web.embedded.tomcat/TomcatReactiveWebServerFactory

TomcatReactiveWebServerFactory

open class TomcatReactiveWebServerFactory : AbstractReactiveWebServerFactory, ConfigurableTomcatWebServerFactory

ReactiveWebServerFactory that can be used to create a TomcatWebServer.

Author

Brian Clozel

HaiTao Zhang

Moritz Halbritter

Scott Frederick

Since

2.0.0

Constructors

TomcatReactiveWebServerFactory

constructor()

Create a new TomcatReactiveWebServerFactory instance.

constructor(port: Int)

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

Properties

additionalTomcatConnectors

val additionalTomcatConnectors: List<Connector>

address

open var address: InetAddress

compression

open var compression: Compression

DEFAULT_PROTOCOL

val DEFAULT_PROTOCOL: String = "org.apache.coyote.http11.Http11NioProtocol"

The class name of default protocol used.

engineValves

val engineValves: List<Valve>

errorPages

open val errorPages: Set<ErrorPage>

http2

open var http2: Http2

port

open var port: Int

serverHeader

open var serverHeader: String

shutdown

open var shutdown: Shutdown

ssl

open var ssl: Ssl

sslBundles

open var sslBundles: SslBundles

uriEncoding

open var uriEncoding: Charset

Functions

addAdditionalTomcatConnectors

open fun addAdditionalTomcatConnectors(connectors: Array<Connector>)

Add Connectors in addition to the default connector, e.g.

addConnectorCustomizers

open fun addConnectorCustomizers(tomcatConnectorCustomizers: Array<TomcatConnectorCustomizer>)

Add TomcatConnectorCustomizers that should be added to the Tomcat Connector.

addContextCustomizers

open fun addContextCustomizers(tomcatContextCustomizers: Array<TomcatContextCustomizer>)

Add TomcatContextCustomizers that should be added to the Tomcat Context.

addContextLifecycleListeners

open fun addContextLifecycleListeners(contextLifecycleListeners: Array<LifecycleListener>)

Add LifecycleListeners that should be added to the Tomcat Context.

addEngineValves

open fun addEngineValves(engineValves: Array<Valve>)

Add Valves that should be applied to the Tomcat Engine.

addErrorPages

open fun addErrorPages(errorPages: Array<ErrorPage>)

Adds error pages that will be used when handling exceptions.

addProtocolHandlerCustomizers

open fun addProtocolHandlerCustomizers(tomcatProtocolHandlerCustomizers: Array<TomcatProtocolHandlerCustomizer<out Any>>)

Add TomcatProtocolHandlerCustomizers that should be added to the Tomcat Connector.

getContextLifecycleListeners

open fun getContextLifecycleListeners(): Collection<LifecycleListener>

Returns a mutable collection of the LifecycleListeners that will be applied to the Tomcat Context.

getTomcatConnectorCustomizers

open fun getTomcatConnectorCustomizers(): Collection<TomcatConnectorCustomizer>

Returns a mutable collection of the TomcatConnectorCustomizers that will be applied to the Tomcat Connector.

getTomcatContextCustomizers

open fun getTomcatContextCustomizers(): Collection<TomcatContextCustomizer>

Returns a mutable collection of the TomcatContextCustomizers that will be applied to the Tomcat Context.

getTomcatProtocolHandlerCustomizers

open fun getTomcatProtocolHandlerCustomizers(): Collection<TomcatProtocolHandlerCustomizer<out Any>>

Returns a mutable collection of the TomcatProtocolHandlerCustomizers that will be applied to the Tomcat Connector.

getWebServer

open fun getWebServer(httpHandler: HttpHandler): WebServer

Gets a new fully configured but paused WebServer instance.

setBackgroundProcessorDelay

open fun setBackgroundProcessorDelay(delay: Int)

Sets the background processor delay in seconds.

setBaseDirectory

open fun setBaseDirectory(baseDirectory: File)

Set the Tomcat base directory.

setContextLifecycleListeners

open fun setContextLifecycleListeners(contextLifecycleListeners: Collection<out LifecycleListener>)

Set LifecycleListeners that should be applied to the Tomcat Context.

setDisableMBeanRegistry

open fun setDisableMBeanRegistry(disableMBeanRegistry: Boolean)

Set whether the factory should disable Tomcat's MBean registry prior to creating the server.

setErrorPages

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

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

setProtocol

open fun setProtocol(protocol: String)

The Tomcat protocol to use when create the Connector.

setTomcatConnectorCustomizers

open fun setTomcatConnectorCustomizers(tomcatConnectorCustomizers: Collection<out TomcatConnectorCustomizer>)

Set TomcatConnectorCustomizers that should be applied to the Tomcat Connector.

setTomcatContextCustomizers

open fun setTomcatContextCustomizers(tomcatContextCustomizers: Collection<out TomcatContextCustomizer>)

Set TomcatContextCustomizers that should be applied to the Tomcat Context.

setTomcatProtocolHandlerCustomizers

open fun setTomcatProtocolHandlerCustomizers(tomcatProtocolHandlerCustomizers: Collection<out TomcatProtocolHandlerCustomizer<out Any>>)

Set TomcatProtocolHandlerCustomizers that should be applied to the Tomcat Connector.

setUseApr

open fun setUseApr(useApr: Boolean)

Whether to use APR.