TomcatEmbeddedServletContainerFactory (spring-boot 1.5.10.RELEASE)

java.lang.Object
- org.springframework.boot.context.embedded.AbstractConfigurableEmbeddedServletContainer
- - org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory
  - - org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory

All Implemented Interfaces:

org.springframework.beans.factory.Aware, ConfigurableEmbeddedServletContainer, EmbeddedServletContainerFactory, ErrorPageRegistry, org.springframework.context.ResourceLoaderAware
```
public class TomcatEmbeddedServletContainerFactory
extends AbstractEmbeddedServletContainerFactory
implements org.springframework.context.ResourceLoaderAware
```
EmbeddedServletContainerFactory that can be used to create TomcatEmbeddedServletContainers. Can be initialized using Spring's ServletContextInitializers or Tomcat LifecycleListeners.
Unless explicitly configured otherwise this factory will created containers that listens for HTTP requests on port 8080.

Author:

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

See Also:

AbstractConfigurableEmbeddedServletContainer.setPort(int), setContextLifecycleListeners(Collection), TomcatEmbeddedServletContainer

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.context.embedded.AbstractEmbeddedServletContainerFactory
  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
`TomcatEmbeddedServletContainerFactory()` Create a new `TomcatEmbeddedServletContainerFactory` instance.
`TomcatEmbeddedServletContainerFactory(int port)` Create a new `TomcatEmbeddedServletContainerFactory` that listens for requests using the specified port.
`TomcatEmbeddedServletContainerFactory(String contextPath, int port)` Create a new `TomcatEmbeddedServletContainerFactory` with the specified context path and port.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAdditionalTomcatConnectors(org.apache.catalina.connector.Connector... connectors)` Add `Connector`s in addition to the default connector, e.g.
`void`	`addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers)` Add `TomcatContextCustomizer`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(org.apache.catalina.LifecycleListener... contextLifecycleListeners)` Add `LifecycleListener`s that should be added to the Tomcat `Context`.
`void`	`addContextValves(org.apache.catalina.Valve... contextValves)` Add `Valve`s that should be applied to the Tomcat `Context`.
`void`	`addEngineValves(org.apache.catalina.Valve... engineValves)` Add `Valve`s that should be applied to the Tomcat `Engine`.
`void`	`addTldSkipPatterns(String... patterns)` Add patterns that match jars to ignore for TLD scanning.
`protected void`	`configureContext(org.apache.catalina.Context context, ServletContextInitializer[] initializers)` Configure the Tomcat `Context`.
`protected void`	`configureSsl(org.apache.coyote.http11.AbstractHttp11JsseProtocol<?> protocol, Ssl ssl)` Configure Tomcat's `AbstractHttp11JsseProtocol` for SSL.
`protected void`	`configureSslStoreProvider(org.apache.coyote.http11.AbstractHttp11JsseProtocol<?> protocol, SslStoreProvider sslStoreProvider)`
`protected void`	`customizeConnector(org.apache.catalina.connector.Connector connector)`
`List<org.apache.catalina.connector.Connector>`	`getAdditionalTomcatConnectors()` Returns a mutable collection of the `Connector`s that will be added to the Tomcat.
`Collection<org.apache.catalina.LifecycleListener>`	`getContextLifecycleListeners()` Returns a mutable collection of the `LifecycleListener`s that will be applied to the Tomcat `Context` .
`Collection<org.apache.catalina.Valve>`	`getContextValves()` Returns a mutable collection of the `Valve`s that will be applied to the Tomcat `Context`.
`EmbeddedServletContainer`	`getEmbeddedServletContainer(ServletContextInitializer... initializers)` Gets a new fully configured but paused `EmbeddedServletContainer` instance.
`Collection<org.apache.catalina.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 `Context` .
`Collection<TomcatContextCustomizer>`	`getTomcatContextCustomizers()` Returns a mutable collection of the `TomcatContextCustomizer`s that will be applied to the Tomcat `Context` .
`protected TomcatEmbeddedServletContainer`	`getTomcatEmbeddedServletContainer(org.apache.catalina.startup.Tomcat tomcat)` Factory method called to create the `TomcatEmbeddedServletContainer`.
`Charset`	`getUriEncoding()` Returns the character encoding to use for URL decoding.
`protected void`	`postProcessContext(org.apache.catalina.Context context)` Post process the Tomcat `Context` before it used with the Tomcat Server.
`protected void`	`prepareContext(org.apache.catalina.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 org.apache.catalina.LifecycleListener> contextLifecycleListeners)` Set `LifecycleListener`s that should be applied to the Tomcat `Context` .
`void`	`setContextValves(Collection<? extends org.apache.catalina.Valve> contextValves)` Set `Valve`s that should be applied to the Tomcat `Context`.
`void`	`setEngineValves(Collection<? extends org.apache.catalina.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(org.springframework.core.io.ResourceLoader resourceLoader)`
`void`	`setTldSkip(String tldSkip)` Deprecated. as of 1.5 in favor of `setTldSkipPatterns(Collection)`
`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`	`setUriEncoding(Charset uriEncoding)` Set the character encoding to use for URL decoding.

Methods inherited from class org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory
createTempDir, getUrlsOfJarsWithMetaInfResources, getValidDocumentRoot, getValidSessionStoreDir, getValidSessionStoreDir

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_PROTOCOL
```
public static final String DEFAULT_PROTOCOL
```
    The class name of default protocol used.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TomcatEmbeddedServletContainerFactory
```
public TomcatEmbeddedServletContainerFactory()
```
    Create a new TomcatEmbeddedServletContainerFactory instance.
  - TomcatEmbeddedServletContainerFactory
```
public TomcatEmbeddedServletContainerFactory(int port)
```
    Create a new TomcatEmbeddedServletContainerFactory that listens for requests using the specified port.
    
    Parameters:
    
    port - the port to listen on
  - TomcatEmbeddedServletContainerFactory
```
public TomcatEmbeddedServletContainerFactory(String contextPath,
                                             int port)
```
    Create a new TomcatEmbeddedServletContainerFactory with the specified context path and port.
    
    Parameters:
    
    contextPath - the root context path
    
    port - the port to listen on
- Method Detail
  - getEmbeddedServletContainer
```
public EmbeddedServletContainer getEmbeddedServletContainer(ServletContextInitializer... initializers)
```
    Description copied from interface: EmbeddedServletContainerFactory
    
    Gets a new fully configured but paused EmbeddedServletContainer instance. Clients should not be able to connect to the returned server until EmbeddedServletContainer.start() is called (which happens when the ApplicationContext has been fully refreshed).
    
    Specified by:
    
    getEmbeddedServletContainer in interface EmbeddedServletContainerFactory
    
    Parameters:
    
    initializers - ServletContextInitializers that should be applied as the container starts
    
    Returns:
    
    a fully configured and started EmbeddedServletContainer
    
    See Also:
    
    EmbeddedServletContainer.stop()
  - prepareContext
```
protected void prepareContext(org.apache.catalina.Host host,
                              ServletContextInitializer[] initializers)
```
  - customizeConnector
```
protected void customizeConnector(org.apache.catalina.connector.Connector connector)
```
  - configureSsl
```
protected void configureSsl(org.apache.coyote.http11.AbstractHttp11JsseProtocol<?> protocol,
                            Ssl ssl)
```
    Configure Tomcat's AbstractHttp11JsseProtocol for SSL.
    
    Parameters:
    
    protocol - the protocol
    
    ssl - the ssl details
  - configureSslStoreProvider
```
protected void configureSslStoreProvider(org.apache.coyote.http11.AbstractHttp11JsseProtocol<?> protocol,
                                         SslStoreProvider sslStoreProvider)
```
  - configureContext
```
protected void configureContext(org.apache.catalina.Context context,
                                ServletContextInitializer[] initializers)
```
    Configure the Tomcat Context.
    
    Parameters:
    
    context - the Tomcat context
    
    initializers - initializers to apply
  - postProcessContext
```
protected void postProcessContext(org.apache.catalina.Context context)
```
    Post process the Tomcat Context before it used with the Tomcat Server. Subclasses can override this method to apply additional processing to the Context.
    
    Parameters:
    
    context - the Tomcat Context
  - getTomcatEmbeddedServletContainer
```
protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(org.apache.catalina.startup.Tomcat tomcat)
```
    Factory method called to create the TomcatEmbeddedServletContainer. Subclasses can override this method to return a different TomcatEmbeddedServletContainer or apply additional processing to the Tomcat server.
    
    Parameters:
    
    tomcat - the Tomcat server.
    
    Returns:
    
    a new TomcatEmbeddedServletContainer instance
  - setResourceLoader
```
public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
```
    Specified by:
    
    setResourceLoader in interface org.springframework.context.ResourceLoaderAware
  - setBaseDirectory
```
public void setBaseDirectory(File baseDirectory)
```
    Set the Tomcat base directory. If not specified a temporary directory will be used.
    
    Parameters:
    
    baseDirectory - the tomcat base directory
  - setTldSkip
```
@Deprecated
public void setTldSkip(String tldSkip)
```
    Deprecated. as of 1.5 in favor of setTldSkipPatterns(Collection)
    
    A comma-separated list of jars to ignore for TLD scanning. See Tomcat's catalina.properties for typical values. Defaults to a list drawn from that source.
    
    Parameters:
    
    tldSkip - the jars to skip when scanning for TLDs etc
  - 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.Connector(String)
  - setEngineValves
```
public void setEngineValves(Collection<? extends org.apache.catalina.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<org.apache.catalina.Valve> getEngineValves()
```
    Returns a mutable collection of the Valves that will be applied to the Tomcat Engine.
    
    Returns:
    
    the engineValves the valves that will be applied
  - addEngineValves
```
public void addEngineValves(org.apache.catalina.Valve... engineValves)
```
    Add Valves that should be applied to the Tomcat Engine.
    
    Parameters:
    
    engineValves - the valves to add
  - setContextValves
```
public void setContextValves(Collection<? extends org.apache.catalina.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<org.apache.catalina.Valve> getContextValves()
```
    Returns a mutable collection of the Valves that will be applied to the Tomcat Context.
    
    Returns:
    
    the contextValves the valves that will be applied
    
    See Also:
    
    getEngineValves()
  - addContextValves
```
public void addContextValves(org.apache.catalina.Valve... contextValves)
```
    Add Valves that should be applied to the Tomcat Context.
    
    Parameters:
    
    contextValves - the valves to add
  - setContextLifecycleListeners
```
public void setContextLifecycleListeners(Collection<? extends org.apache.catalina.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<org.apache.catalina.LifecycleListener> getContextLifecycleListeners()
```
    Returns a mutable collection of the LifecycleListeners that will be applied to the Tomcat Context .
    
    Returns:
    
    the contextLifecycleListeners the listeners that will be applied
  - addContextLifecycleListeners
```
public void addContextLifecycleListeners(org.apache.catalina.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)
```
    Add TomcatContextCustomizers that should be added to the Tomcat Context.
    
    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)
```
    Add TomcatContextCustomizers that should be added to the Tomcat Connector.
    
    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 Context .
    
    Returns:
    
    the listeners that will be applied
  - addAdditionalTomcatConnectors
```
public void addAdditionalTomcatConnectors(org.apache.catalina.connector.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<org.apache.catalina.connector.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)
```
    Set the character encoding to use for URL decoding. If not specified 'UTF-8' will be used.
    
    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)
```
    Sets the background processor delay in seconds.
    
    Parameters:
    
    delay - the delay in seconds
    
    Since:
    
    1.4.1

Class TomcatEmbeddedServletContainerFactory

Field Summary

Fields inherited from class org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory

Constructor Summary

Method Summary

Methods inherited from class org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory

Methods inherited from class org.springframework.boot.context.embedded.AbstractConfigurableEmbeddedServletContainer

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PROTOCOL

Constructor Detail

TomcatEmbeddedServletContainerFactory

TomcatEmbeddedServletContainerFactory

TomcatEmbeddedServletContainerFactory

Method Detail

getEmbeddedServletContainer

prepareContext

customizeConnector

configureSsl

configureSslStoreProvider

configureContext

postProcessContext

getTomcatEmbeddedServletContainer

setResourceLoader

setBaseDirectory

setTldSkip

getTldSkipPatterns

setTldSkipPatterns

addTldSkipPatterns

setProtocol

setEngineValves

getEngineValves

addEngineValves

setContextValves

getContextValves

addContextValves

setContextLifecycleListeners

getContextLifecycleListeners

addContextLifecycleListeners

setTomcatContextCustomizers

getTomcatContextCustomizers

addContextCustomizers

setTomcatConnectorCustomizers

addConnectorCustomizers

getTomcatConnectorCustomizers

addAdditionalTomcatConnectors

getAdditionalTomcatConnectors

setUriEncoding

getUriEncoding

setBackgroundProcessorDelay