TomcatServletWebServerFactory (Spring Boot 2.6.3 API)

java.lang.Object
- org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- - org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory
  - - org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory

All Implemented Interfaces:

Aware, ConfigurableTomcatWebServerFactory, ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory, ConfigurableServletWebServerFactory, ServletWebServerFactory, WebListenerRegistry, ResourceLoaderAware
```
public class TomcatServletWebServerFactory
extends AbstractServletWebServerFactory
implements 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.

Since:

2.0.0

Author:

Phillip Webb, Dave Syer, Brock Mills, Stephane Nicoll, Andy Wilkinson, Eddú Meléndez, Christoffer Sawicki, Dawid Antecki

See Also:

AbstractConfigurableWebServerFactory.setPort(int), setContextLifecycleListeners(Collection), TomcatWebServer

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_PROTOCOL
The class name of default protocol used.
- Fields inherited from class org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory
  logger

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

Constructor Summary

Constructors
Constructor and Description
`TomcatServletWebServerFactory()` Create a new `TomcatServletWebServerFactory` instance.
`TomcatServletWebServerFactory(int port)` Create a new `TomcatServletWebServerFactory` that listens for requests using the specified port.
`TomcatServletWebServerFactory(String contextPath, int port)` Create a new `TomcatServletWebServerFactory` with the specified context path and port.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAdditionalTomcatConnectors(Connector... connectors)` Add `Connector`s in addition to the default connector, e.g.
`void`	`addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers)` Add `TomcatConnectorCustomizer`s that should be added to the Tomcat `Connector`.
`void`	`addContextCustomizers(TomcatContextCustomizer... tomcatContextCustomizers)` Add `TomcatContextCustomizer`s that should be added to the Tomcat `Context`.
`void`	`addContextLifecycleListeners(LifecycleListener... contextLifecycleListeners)` Add `LifecycleListener`s that should be added to the Tomcat `Context`.
`void`	`addContextValves(Valve... contextValves)` Add `Valve`s that should be applied to the Tomcat `Context`.
`void`	`addEngineValves(Valve... engineValves)` Add `Valve`s that should be applied to the Tomcat `Engine`.
`void`	`addProtocolHandlerCustomizers(TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers)` Add `TomcatProtocolHandlerCustomizer`s that should be added to the Tomcat `Connector`.
`void`	`addTldSkipPatterns(String... patterns)` Add patterns that match jars to ignore for TLD scanning.
`protected void`	`configureContext(Context context, ServletContextInitializer[] initializers)` Configure the Tomcat `Context`.
`protected void`	`customizeConnector(Connector connector)`
`List<Connector>`	`getAdditionalTomcatConnectors()` Returns a mutable collection of the `Connector`s that will be added to the Tomcat.
`Collection<LifecycleListener>`	`getContextLifecycleListeners()` Returns a mutable collection of the `LifecycleListener`s that will be applied to the Tomcat `Context`.
`Collection<Valve>`	`getContextValves()` Returns a mutable collection of the `Valve`s that will be applied to the Tomcat `Context`.
`Collection<Valve>`	`getEngineValves()` Returns a mutable collection of the `Valve`s that will be applied to the Tomcat `Engine`.
`Set<String>`	`getTldSkipPatterns()` Returns a mutable set of the patterns that match jars to ignore for TLD scanning.
`Collection<TomcatConnectorCustomizer>`	`getTomcatConnectorCustomizers()` Returns a mutable collection of the `TomcatConnectorCustomizer`s that will be applied to the Tomcat `Connector`.
`Collection<TomcatContextCustomizer>`	`getTomcatContextCustomizers()` Returns a mutable collection of the `TomcatContextCustomizer`s that will be applied to the Tomcat `Context`.
`Collection<TomcatProtocolHandlerCustomizer<?>>`	`getTomcatProtocolHandlerCustomizers()` Returns a mutable collection of the `TomcatProtocolHandlerCustomizer`s that will be applied to the Tomcat `Connector`.
`protected TomcatWebServer`	`getTomcatWebServer(Tomcat tomcat)` Factory method called to create the `TomcatWebServer`.
`Charset`	`getUriEncoding()` Returns the character encoding to use for URL decoding.
`WebServer`	`getWebServer(ServletContextInitializer... initializers)` Gets a new fully configured but paused `WebServer` instance.
`protected void`	`postProcessContext(Context context)` Post process the Tomcat `Context` before it's used with the Tomcat Server.
`protected void`	`prepareContext(Host host, ServletContextInitializer[] initializers)`
`void`	`setBackgroundProcessorDelay(int delay)` Sets the background processor delay in seconds.
`void`	`setBaseDirectory(File baseDirectory)` Set the Tomcat base directory.
`void`	`setContextLifecycleListeners(Collection<? extends LifecycleListener> contextLifecycleListeners)` Set `LifecycleListener`s that should be applied to the Tomcat `Context`.
`void`	`setContextValves(Collection<? extends Valve> contextValves)` Set `Valve`s 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 `Valve`s that should be applied to the Tomcat `Engine`.
`void`	`setProtocol(String protocol)` The Tomcat protocol to use when create the `Connector`.
`void`	`setResourceLoader(ResourceLoader resourceLoader)`
`void`	`setTldSkipPatterns(Collection<String> patterns)` Set the patterns that match jars to ignore for TLD scanning.
`void`	`setTomcatConnectorCustomizers(Collection<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers)` Set `TomcatConnectorCustomizer`s that should be applied to the Tomcat `Connector`.
`void`	`setTomcatContextCustomizers(Collection<? extends TomcatContextCustomizer> tomcatContextCustomizers)` Set `TomcatContextCustomizer`s that should be applied to the Tomcat `Context`.
`void`	`setTomcatProtocolHandlerCustomizers(Collection<? extends TomcatProtocolHandlerCustomizer<?>> tomcatProtocolHandlerCustomizer)` Set `TomcatProtocolHandlerCustomizer`s that should be applied to the Tomcat `Connector`.
`void`	`setUriEncoding(Charset uriEncoding)` Set the character encoding to use for URL decoding.

Methods inherited from class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
addErrorPages, createTempDir, getAddress, getCompression, getErrorPages, getHttp2, getPort, getServerHeader, getShutdown, getSsl, getSslStoreProvider, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslStoreProvider

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, setSslStoreProvider

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

- Field Detail
  - DEFAULT_PROTOCOL
```
public static final String DEFAULT_PROTOCOL
```
    The class name of default protocol used.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TomcatServletWebServerFactory
```
public TomcatServletWebServerFactory()
```
    Create a new TomcatServletWebServerFactory instance.
  - TomcatServletWebServerFactory
```
public TomcatServletWebServerFactory(int port)
```
    Create a new TomcatServletWebServerFactory that listens for requests using the specified port.
    
    Parameters:
    
    port - the port to listen on
  - TomcatServletWebServerFactory
```
public TomcatServletWebServerFactory(String contextPath,
                                     int port)
```
    Create a new TomcatServletWebServerFactory with the specified context path and port.
    
    Parameters:
    
    contextPath - the root context path
    
    port - the port to listen on
- Method Detail
  - getWebServer
```
public WebServer getWebServer(ServletContextInitializer... initializers)
```
    Description copied from interface: ServletWebServerFactory
    
    Gets a new fully configured but paused WebServer instance. Clients should not be able to connect to the returned server until WebServer.start() is called (which happens when the ApplicationContext has been fully refreshed).
    
    Specified by:
    
    getWebServer in interface ServletWebServerFactory
    
    Parameters:
    
    initializers - ServletContextInitializers that should be applied as the server starts
    
    Returns:
    
    a fully configured and started WebServer
    
    See Also:
    
    WebServer.stop()
  - prepareContext
```
protected void prepareContext(Host host,
                              ServletContextInitializer[] initializers)
```
  - customizeConnector
```
protected void customizeConnector(Connector connector)
```
  - configureContext
```
protected void configureContext(Context context,
                                ServletContextInitializer[] initializers)
```
    Configure the Tomcat Context.
    
    Parameters:
    
    context - the Tomcat context
    
    initializers - initializers to apply
  - postProcessContext
```
protected void postProcessContext(Context context)
```
    Post process the Tomcat Context before it's used with the Tomcat Server. Subclasses can override this method to apply additional processing to the Context.
    
    Parameters:
    
    context - the Tomcat Context
  - getTomcatWebServer
```
protected TomcatWebServer getTomcatWebServer(Tomcat tomcat)
```
    Factory method called to create the TomcatWebServer. Subclasses can override this method to return a different TomcatWebServer or apply additional processing to the Tomcat server.
    
    Parameters:
    
    tomcat - the Tomcat server.
    
    Returns:
    
    a new TomcatWebServer instance
  - setResourceLoader
```
public void setResourceLoader(ResourceLoader resourceLoader)
```
    Specified by:
    
    setResourceLoader in interface ResourceLoaderAware
  - setBaseDirectory
```
public void setBaseDirectory(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
  - getTldSkipPatterns
```
public Set<String> getTldSkipPatterns()
```
    Returns a mutable set of the patterns that match jars to ignore for TLD scanning.
    
    Returns:
    
    the list of jars to ignore for TLD scanning
  - setTldSkipPatterns
```
public void setTldSkipPatterns(Collection<String> patterns)
```
    Set the patterns that match jars to ignore for TLD scanning. See Tomcat's catalina.properties for typical values. Defaults to a list drawn from that source.
    
    Parameters:
    
    patterns - the jar patterns to skip when scanning for TLDs etc
  - addTldSkipPatterns
```
public void addTldSkipPatterns(String... patterns)
```
    Add patterns that match jars to ignore for TLD scanning. See Tomcat's catalina.properties for typical values.
    
    Parameters:
    
    patterns - the additional jar patterns to skip when scanning for TLDs etc
  - setProtocol
```
public void setProtocol(String protocol)
```
    The Tomcat protocol to use when create the Connector.
    
    Parameters:
    
    protocol - the protocol
    
    See Also:
    
    Connector(String)
  - 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
  - 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
  - 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
  - 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
  - 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()
  - addContextValves
```
public void addContextValves(Valve... contextValves)
```
    Add Valves that should be applied to the Tomcat Context.
    
    Parameters:
    
    contextValves - the valves to add
  - 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
  - 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
  - addContextLifecycleListeners
```
public void addContextLifecycleListeners(LifecycleListener... contextLifecycleListeners)
```
    Add LifecycleListeners that should be added to the Tomcat Context.
    
    Parameters:
    
    contextLifecycleListeners - the listeners to add
  - setTomcatContextCustomizers
```
public void setTomcatContextCustomizers(Collection<? extends TomcatContextCustomizer> tomcatContextCustomizers)
```
    Set TomcatContextCustomizers that should be applied to the Tomcat Context. Calling this method will replace any existing customizers.
    
    Parameters:
    
    tomcatContextCustomizers - the customizers to set
  - getTomcatContextCustomizers
```
public Collection<TomcatContextCustomizer> getTomcatContextCustomizers()
```
    Returns a mutable collection of the TomcatContextCustomizers that will be applied to the Tomcat Context.
    
    Returns:
    
    the listeners that will be applied
  - addContextCustomizers
```
public void addContextCustomizers(TomcatContextCustomizer... tomcatContextCustomizers)
```
    Description copied from interface: ConfigurableTomcatWebServerFactory
    
    Add TomcatContextCustomizers that should be added to the Tomcat Context.
    
    Specified by:
    
    addContextCustomizers in interface ConfigurableTomcatWebServerFactory
    
    Parameters:
    
    tomcatContextCustomizers - the customizers to add
  - setTomcatConnectorCustomizers
```
public void setTomcatConnectorCustomizers(Collection<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers)
```
    Set TomcatConnectorCustomizers that should be applied to the Tomcat Connector. Calling this method will replace any existing customizers.
    
    Parameters:
    
    tomcatConnectorCustomizers - the customizers to set
  - addConnectorCustomizers
```
public void addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers)
```
    Description copied from interface: ConfigurableTomcatWebServerFactory
    
    Add TomcatConnectorCustomizers that should be added to the Tomcat Connector.
    
    Specified by:
    
    addConnectorCustomizers in interface ConfigurableTomcatWebServerFactory
    
    Parameters:
    
    tomcatConnectorCustomizers - the customizers to add
  - getTomcatConnectorCustomizers
```
public Collection<TomcatConnectorCustomizer> getTomcatConnectorCustomizers()
```
    Returns a mutable collection of the TomcatConnectorCustomizers that will be applied to the Tomcat Connector.
    
    Returns:
    
    the customizers that will be applied
  - setTomcatProtocolHandlerCustomizers
```
public void setTomcatProtocolHandlerCustomizers(Collection<? extends TomcatProtocolHandlerCustomizer<?>> tomcatProtocolHandlerCustomizer)
```
    Set TomcatProtocolHandlerCustomizers that should be applied to the Tomcat Connector. Calling this method will replace any existing customizers.
    
    Parameters:
    
    tomcatProtocolHandlerCustomizer - the customizers to set
    
    Since:
    
    2.2.0
  - addProtocolHandlerCustomizers
```
public void addProtocolHandlerCustomizers(TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers)
```
    Add TomcatProtocolHandlerCustomizers that should be added to the Tomcat Connector.
    
    Specified by:
    
    addProtocolHandlerCustomizers in interface ConfigurableTomcatWebServerFactory
    
    Parameters:
    
    tomcatProtocolHandlerCustomizers - the customizers to add
    
    Since:
    
    2.2.0
  - getTomcatProtocolHandlerCustomizers
```
public Collection<TomcatProtocolHandlerCustomizer<?>> getTomcatProtocolHandlerCustomizers()
```
    Returns a mutable collection of the TomcatProtocolHandlerCustomizers that will be applied to the Tomcat Connector.
    
    Returns:
    
    the customizers that will be applied
    
    Since:
    
    2.2.0
  - addAdditionalTomcatConnectors
```
public void addAdditionalTomcatConnectors(Connector... connectors)
```
    Add Connectors in addition to the default connector, e.g. for SSL or AJP
    
    Parameters:
    
    connectors - the connectors to add
  - getAdditionalTomcatConnectors
```
public List<Connector> getAdditionalTomcatConnectors()
```
    Returns a mutable collection of the Connectors that will be added to the Tomcat.
    
    Returns:
    
    the additionalTomcatConnectors
  - 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
  - getUriEncoding
```
public Charset getUriEncoding()
```
    Returns the character encoding to use for URL decoding.
    
    Returns:
    
    the URI encoding
  - 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
  - setDisableMBeanRegistry
```
public void setDisableMBeanRegistry(boolean disableMBeanRegistry)
```
    Set whether the factory should disable Tomcat's MBean registry prior to creating the server.
    
    Parameters:
    
    disableMBeanRegistry - whether to disable the MBean registry
    
    Since:
    
    2.2.0

Class TomcatServletWebServerFactory

Field Summary

Fields inherited from class org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory

Constructor Summary

Method Summary

Methods inherited from class org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory

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

Methods inherited from class java.lang.Object

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

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

Field Detail

DEFAULT_PROTOCOL

Constructor Detail

TomcatServletWebServerFactory

TomcatServletWebServerFactory

TomcatServletWebServerFactory

Method Detail

getWebServer

prepareContext

customizeConnector

configureContext

postProcessContext

getTomcatWebServer

setResourceLoader

setBaseDirectory

getTldSkipPatterns

setTldSkipPatterns

addTldSkipPatterns

setProtocol

setEngineValves

getEngineValves

addEngineValves

setContextValves

getContextValves

addContextValves

setContextLifecycleListeners

getContextLifecycleListeners

addContextLifecycleListeners

setTomcatContextCustomizers

getTomcatContextCustomizers

addContextCustomizers

setTomcatConnectorCustomizers

addConnectorCustomizers

getTomcatConnectorCustomizers

setTomcatProtocolHandlerCustomizers

addProtocolHandlerCustomizers

getTomcatProtocolHandlerCustomizers

addAdditionalTomcatConnectors

getAdditionalTomcatConnectors

setUriEncoding

getUriEncoding

setBackgroundProcessorDelay

setDisableMBeanRegistry