Class TomcatWebServerFactory

java.lang.Object

org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

org.springframework.boot.tomcat.TomcatWebServerFactory

All Implemented Interfaces:

ConfigurableTomcatWebServerFactory, ErrorPageRegistry, ConfigurableWebServerFactory, WebServerFactory

Direct Known Subclasses:

TomcatReactiveWebServerFactory, TomcatServletWebServerFactory

public class TomcatWebServerFactory
extends AbstractConfigurableWebServerFactory
implements ConfigurableTomcatWebServerFactory

Base class for factories that produce a TomcatWebServer.

Since:

4.0.0

Author:

Andy Wilkinson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PROTOCOL	The class name of default protocol used.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TomcatWebServerFactory()
protected	TomcatWebServerFactory(int port)

Method Summary

Modifier and Type	Method	Description
void	addAdditionalConnectors(Connector... connectors)	Add Connectors in addition to the default connector, e.g.
void	addConnectorCustomizers(TomcatConnectorCustomizer... connectorCustomizers)	Add TomcatConnectorCustomizers that should be added to the Tomcat Connector.
void	addContextCustomizers(TomcatContextCustomizer... contextCustomizers)	Add TomcatContextCustomizers that should be added to the Tomcat Context.
void	addContextLifecycleListeners(LifecycleListener... contextLifecycleListeners)	Add LifecycleListeners that should be added to the Tomcat Context.
void	addContextValves(Valve... contextValves)	Add Valves that should be applied to the Tomcat Context.
void	addEngineValves(Valve... engineValves)	Add Valves that should be applied to the Tomcat Engine.
void	addProtocolHandlerCustomizers(TomcatProtocolHandlerCustomizer<?>... protocolHandlerCustomizers)	Add TomcatProtocolHandlerCustomizers that should be added to the Tomcat Connector.
protected Tomcat	createTomcat()
protected void	customizeConnector(Connector connector)
List<Connector>	getAdditionalConnectors()	Returns a mutable collection of the Connectors that will be added to the Tomcat server.
int	getBackgroundProcessorDelay()
@Nullable File	getBaseDirectory()
Set<TomcatConnectorCustomizer>	getConnectorCustomizers()	Returns a mutable collection of the TomcatConnectorCustomizers that will be applied to the Tomcat Connector.
Collection<TomcatContextCustomizer>	getContextCustomizers()	Returns a mutable collection of the TomcatContextCustomizers that will be applied to the Tomcat Context.
Collection<LifecycleListener>	getContextLifecycleListeners()	Returns a mutable collection of the LifecycleListeners that will be applied to the Tomcat Context.
Collection<Valve>	getContextValves()	Returns a mutable collection of the Valves that will be applied to the Tomcat Context.
Collection<Valve>	getEngineValves()	Returns a mutable collection of the Valves that will be applied to the Tomcat Engine.
String	getProtocol()
Set<TomcatProtocolHandlerCustomizer<?>>	getProtocolHandlerCustomizers()	Returns a mutable collection of the TomcatProtocolHandlerCustomizers that will be applied to the Tomcat Connector.
Charset	getUriEncoding()
boolean	isDisableMBeanRegistry()	Returns whether the factory should disable Tomcat's MBean registry prior to creating the server.
void	setAdditionalConnectors(Collection<? extends Connector> additionalConnectors)	Set additional Connectors that should be added to the Tomcat server .
void	setBackgroundProcessorDelay(int delay)	Sets the background processor delay in seconds.
void	setBaseDirectory(@Nullable File baseDirectory)	Set the Tomcat base directory.
void	setConnectorCustomizers(Collection<? extends TomcatConnectorCustomizer> connectorCustomizers)	Set TomcatConnectorCustomizers that should be applied to the Tomcat Connector.
void	setContextCustomizers(Collection<? extends TomcatContextCustomizer> contextCustomizers)	Set TomcatContextCustomizers that should be applied to the Tomcat Context.
void	setContextLifecycleListeners(Collection<? extends LifecycleListener> contextLifecycleListeners)	Set LifecycleListeners that should be applied to the Tomcat Context.
void	setContextValves(Collection<? extends Valve> contextValves)	Set Valves that should be applied to the Tomcat Context.
void	setDisableMBeanRegistry(boolean disableMBeanRegistry)	Set whether the factory should disable Tomcat's MBean registry prior to creating the server.
void	setEngineValves(Collection<? extends Valve> engineValves)	Set Valves that should be applied to the Tomcat Engine.
void	setProtocol(String protocol)	The Tomcat protocol to use when create the Connector.
void	setProtocolHandlerCustomizers(Collection<? extends TomcatProtocolHandlerCustomizer<?>> protocolHandlerCustomizers)	Set TomcatProtocolHandlerCustomizers that should be applied to the Tomcat Connector.
void	setUriEncoding(Charset uriEncoding)	Set the character encoding to use for URL decoding.
void	setUseApr(boolean useApr)	Whether to use APR.

Methods inherited from class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

addErrorPages, createTempDir, getAddress, getCompression, getErrorPages, getHttp2, getPort, getServerHeader, getServerNameSslBundles, getShutdown, getSsl, getSslBundle, getSslBundles, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslBundles

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

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

addErrorPages

Field Details

DEFAULT_PROTOCOL

public static final String DEFAULT_PROTOCOL

The class name of default protocol used.

See Also:

• Constant Field Values

Constructor Details

TomcatWebServerFactory

protected TomcatWebServerFactory()

TomcatWebServerFactory

protected TomcatWebServerFactory(int port)

Method Details

setBaseDirectory

public void setBaseDirectory(@Nullable File baseDirectory)

Description copied from interface: ConfigurableTomcatWebServerFactory

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

Specified by:

setBaseDirectory in interface ConfigurableTomcatWebServerFactory

Parameters:

baseDirectory - the tomcat base directory

getBaseDirectory

public @Nullable File getBaseDirectory()

getEngineValves

public Collection<Valve> getEngineValves()

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

Returns:

the engine valves that will be applied

setEngineValves

public void setEngineValves(Collection<? extends Valve> engineValves)

Set Valves that should be applied to the Tomcat Engine. Calling this method will replace any existing valves.

Parameters:

engineValves - the valves to set

addEngineValves

public void addEngineValves(Valve... engineValves)

Description copied from interface: ConfigurableTomcatWebServerFactory

Add Valves that should be applied to the Tomcat Engine.

Specified by:

addEngineValves in interface ConfigurableTomcatWebServerFactory

Parameters:

engineValves - the valves to add

getUriEncoding

public Charset getUriEncoding()

setUriEncoding

public void setUriEncoding(Charset uriEncoding)

Description copied from interface: ConfigurableTomcatWebServerFactory

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

Specified by:

setUriEncoding in interface ConfigurableTomcatWebServerFactory

Parameters:

uriEncoding - the uri encoding to set

getBackgroundProcessorDelay

public int getBackgroundProcessorDelay()

setBackgroundProcessorDelay

public void setBackgroundProcessorDelay(int delay)

Description copied from interface: ConfigurableTomcatWebServerFactory

Sets the background processor delay in seconds.

Specified by:

setBackgroundProcessorDelay in interface ConfigurableTomcatWebServerFactory

Parameters:

delay - the delay in seconds

getProtocol

public String getProtocol()

setProtocol

public void setProtocol(String protocol)

The Tomcat protocol to use when create the Connector.

Parameters:

protocol - the protocol

See Also:

• Connector(String)

getContextValves

public Collection<Valve> getContextValves()

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

Returns:

the context valves that will be applied

See Also:

• getEngineValves()

setContextValves

public void setContextValves(Collection<? extends Valve> contextValves)

Set Valves that should be applied to the Tomcat Context. Calling this method will replace any existing valves.

Parameters:

contextValves - the valves to set

addContextValves

public void addContextValves(Valve... contextValves)

Add Valves that should be applied to the Tomcat Context.

Parameters:

contextValves - the valves to add

getContextLifecycleListeners

public Collection<LifecycleListener> getContextLifecycleListeners()

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

Returns:

the context lifecycle listeners that will be applied

setContextLifecycleListeners

public void setContextLifecycleListeners(Collection<? extends LifecycleListener> contextLifecycleListeners)

Set LifecycleListeners that should be applied to the Tomcat Context. Calling this method will replace any existing listeners.

Parameters:

contextLifecycleListeners - the listeners to set

addContextLifecycleListeners

public void addContextLifecycleListeners(LifecycleListener... contextLifecycleListeners)

Add LifecycleListeners that should be added to the Tomcat Context.

Parameters:

contextLifecycleListeners - the listeners to add

getContextCustomizers

public Collection<TomcatContextCustomizer> getContextCustomizers()

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

Returns:

the listeners that will be applied

setContextCustomizers

public void setContextCustomizers(Collection<? extends TomcatContextCustomizer> contextCustomizers)

Set TomcatContextCustomizers that should be applied to the Tomcat Context. Calling this method will replace any existing customizers.

Parameters:

contextCustomizers - the customizers to set

addContextCustomizers

public void addContextCustomizers(TomcatContextCustomizer... contextCustomizers)

Description copied from interface: ConfigurableTomcatWebServerFactory

Add TomcatContextCustomizers that should be added to the Tomcat Context.

Specified by:

addContextCustomizers in interface ConfigurableTomcatWebServerFactory

Parameters:

contextCustomizers - the customizers to add

getConnectorCustomizers

public Set<TomcatConnectorCustomizer> getConnectorCustomizers()

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

Returns:

the customizers that will be applied

setConnectorCustomizers

public void setConnectorCustomizers(Collection<? extends TomcatConnectorCustomizer> connectorCustomizers)

Set TomcatConnectorCustomizers that should be applied to the Tomcat Connector. Calling this method will replace any existing customizers.

Parameters:

connectorCustomizers - the customizers to set

addConnectorCustomizers

public void addConnectorCustomizers(TomcatConnectorCustomizer... connectorCustomizers)

Description copied from interface: ConfigurableTomcatWebServerFactory

Add TomcatConnectorCustomizers that should be added to the Tomcat Connector.

Specified by:

addConnectorCustomizers in interface ConfigurableTomcatWebServerFactory

Parameters:

connectorCustomizers - the customizers to add

getProtocolHandlerCustomizers

public Set<TomcatProtocolHandlerCustomizer<?>> getProtocolHandlerCustomizers()

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

Returns:

the customizers that will be applied

setProtocolHandlerCustomizers

public void setProtocolHandlerCustomizers(Collection<? extends TomcatProtocolHandlerCustomizer<?>> protocolHandlerCustomizers)

Set TomcatProtocolHandlerCustomizers that should be applied to the Tomcat Connector. Calling this method will replace any existing customizers.

Parameters:

protocolHandlerCustomizers - the customizers to set

addProtocolHandlerCustomizers

public void addProtocolHandlerCustomizers(TomcatProtocolHandlerCustomizer<?>... protocolHandlerCustomizers)

Description copied from interface: ConfigurableTomcatWebServerFactory

Add TomcatProtocolHandlerCustomizers that should be added to the Tomcat Connector.

Specified by:

addProtocolHandlerCustomizers in interface ConfigurableTomcatWebServerFactory

Parameters:

protocolHandlerCustomizers - the customizers to add

getAdditionalConnectors

public List<Connector> getAdditionalConnectors()

Returns a mutable collection of the Connectors that will be added to the Tomcat server.

Returns:

the additional connectors

setAdditionalConnectors

public void setAdditionalConnectors(Collection<? extends Connector> additionalConnectors)

Set additional Connectors that should be added to the Tomcat server . Calling this method will replace any existing additional connectors.

Parameters:

additionalConnectors - the additionalConnectors to set

addAdditionalConnectors

public void addAdditionalConnectors(Connector... connectors)

Add Connectors in addition to the default connector, e.g. for SSL or AJP.

Connector customizers are not applied to connectors added this way.

Parameters:

connectors - the connectors to add

isDisableMBeanRegistry

public boolean isDisableMBeanRegistry()

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

Returns:

whether to disable Tomcat's MBean registry

setDisableMBeanRegistry

public void setDisableMBeanRegistry(boolean disableMBeanRegistry)

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

Specified by:

setDisableMBeanRegistry in interface ConfigurableTomcatWebServerFactory

Parameters:

disableMBeanRegistry - whether to disable the MBean registry

setUseApr

public void setUseApr(boolean useApr)

Whether to use APR.

Specified by:

setUseApr in interface ConfigurableTomcatWebServerFactory

Parameters:

useApr - whether to use APR

createTomcat

protected Tomcat createTomcat()

customizeConnector

protected void customizeConnector(Connector connector)