Package org.springframework.boot.web.embedded.tomcat

Interface ConfigurableTomcatWebServerFactory

All Superinterfaces:

ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory

All Known Implementing Classes:

TomcatReactiveWebServerFactory, TomcatServletWebServerFactory

public interface ConfigurableTomcatWebServerFactory
extends ConfigurableWebServerFactory

ConfigurableWebServerFactory for Tomcat-specific features.

Since:

2.0.0

Author:

Brian Clozel

See Also:

• TomcatServletWebServerFactory
• TomcatReactiveWebServerFactory

Method Summary

Modifier and Type	Method	Description
void	addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers)	Add TomcatConnectorCustomizers that should be added to the Tomcat Connector.
void	addContextCustomizers(TomcatContextCustomizer... tomcatContextCustomizers)	Add TomcatContextCustomizers that should be added to the Tomcat Context.
void	addEngineValves(Valve... engineValves)	Add Valves that should be applied to the Tomcat Engine.
void	addProtocolHandlerCustomizers(TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers)	Add TomcatProtocolHandlerCustomizers that should be added to the Tomcat Connector.
void	setBackgroundProcessorDelay(int delay)	Sets the background processor delay in seconds.
void	setBaseDirectory(File baseDirectory)	Set the Tomcat base directory.
void	setUriEncoding(Charset uriEncoding)	Set the character encoding to use for URL decoding.

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

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

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

addErrorPages

Method Details

setBaseDirectory

void setBaseDirectory(File baseDirectory)

Set the Tomcat base directory. If not specified a temporary directory will be used.

Parameters:

baseDirectory - the tomcat base directory

setBackgroundProcessorDelay

void setBackgroundProcessorDelay(int delay)

Sets the background processor delay in seconds.

Parameters:

delay - the delay in seconds

addEngineValves

void addEngineValves(Valve... engineValves)

Add Valves that should be applied to the Tomcat Engine.

Parameters:

engineValves - the valves to add

addConnectorCustomizers

void addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers)

Add TomcatConnectorCustomizers that should be added to the Tomcat Connector.

Parameters:

tomcatConnectorCustomizers - the customizers to add

addContextCustomizers

void addContextCustomizers(TomcatContextCustomizer... tomcatContextCustomizers)

Add TomcatContextCustomizers that should be added to the Tomcat Context.

Parameters:

tomcatContextCustomizers - the customizers to add

addProtocolHandlerCustomizers

void addProtocolHandlerCustomizers(TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers)

Add TomcatProtocolHandlerCustomizers that should be added to the Tomcat Connector.

Parameters:

tomcatProtocolHandlerCustomizers - the customizers to add

Since:

2.2.0

setUriEncoding

void setUriEncoding(Charset uriEncoding)

Set the character encoding to use for URL decoding. If not specified 'UTF-8' will be used.

Parameters:

uriEncoding - the uri encoding to set