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

TomcatServletWebServerFactory

open class TomcatServletWebServerFactory : AbstractServletWebServerFactory, ConfigurableTomcatWebServerFactory, ResourceLoaderAware

AbstractServletWebServerFactory that can be used to create TomcatWebServers. Can be initialized using Spring's ServletContextInitializers or Tomcat LifecycleListeners.

Unless explicitly configured otherwise this factory will create containers that listen for HTTP requests on port 8080.

Author

Phillip Webb

Dave Syer

Brock Mills

Stephane Nicoll

Andy Wilkinson

Eddú Meléndez

Christoffer Sawicki

Dawid Antecki

Moritz Halbritter

Scott Frederick

Since

2.0.0

Constructors

TomcatServletWebServerFactory

constructor()

Create a new TomcatServletWebServerFactory instance.

constructor(port: Int)

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

constructor(contextPath: String, port: Int)

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

Properties

additionalTomcatConnectors

val additionalTomcatConnectors: List<Connector>

address

open var address: InetAddress

compression

open var compression: Compression

contextPath

open var contextPath: String

cookieSameSiteSuppliers

open val cookieSameSiteSuppliers: List<CookieSameSiteSupplier>

DEFAULT_PROTOCOL

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

The class name of default protocol used.

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

tldSkipPatterns

open val tldSkipPatterns: Set<String>

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.

addContextValves

open fun addContextValves(contextValves: Array<Valve>)

Add Valves that should be applied to the Tomcat Context.

addCookieSameSiteSuppliers

open fun addCookieSameSiteSuppliers(cookieSameSiteSuppliers: Array<CookieSameSiteSupplier>)

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

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.

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.

addProtocolHandlerCustomizers

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

Add TomcatProtocolHandlerCustomizers that should be added to the Tomcat Connector.

addTldSkipPatterns

open fun addTldSkipPatterns(patterns: Array<String>)

Add patterns that match jars to ignore for TLD scanning.

addWebListeners

open fun addWebListeners(webListenerClassNames: Array<String>)

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

getContextLifecycleListeners

open fun getContextLifecycleListeners(): Collection<LifecycleListener>

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

getContextValves

open fun getContextValves(): Collection<Valve>

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

getDocumentRoot

open fun getDocumentRoot(): File

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

getEngineValves

open fun getEngineValves(): Collection<Valve>

Returns a mutable collection of the Valves that will be applied to the Tomcat Engine.

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(initializers: Array<ServletContextInitializer>): WebServer

Gets a new fully configured but paused WebServer instance.

isRegisterDefaultServlet

open fun isRegisterDefaultServlet(): Boolean

Flag to indicate that the default servlet should be registered.

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.

setContextValves

open fun setContextValves(contextValves: Collection<out Valve>)

Set Valves that should be applied to the Tomcat Context.

setCookieSameSiteSuppliers

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

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

setDisableMBeanRegistry

open fun setDisableMBeanRegistry(disableMBeanRegistry: Boolean)

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

setDocumentRoot

open fun setDocumentRoot(documentRoot: File)

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

setEngineValves

open fun setEngineValves(engineValves: Collection<out Valve>)

Set Valves that should be applied to the Tomcat Engine.

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.

setProtocol

open fun setProtocol(protocol: String)

The Tomcat protocol to use when create the Connector.

setRegisterDefaultServlet

open fun setRegisterDefaultServlet(registerDefaultServlet: Boolean)

Set if the DefaultServlet should be registered.

setResourceLoader

open fun setResourceLoader(resourceLoader: ResourceLoader)

setTldSkipPatterns

open fun setTldSkipPatterns(patterns: Collection<String>)

Set the patterns that match jars to ignore for TLD scanning.

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(tomcatProtocolHandlerCustomizer: 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.

TomcatServletWebServerFactory

Author

Since

See also

Constructors

Properties

Functions