org.springframework.boot.context.embedded.tomcat

Class TomcatEmbeddedServletContainerFactory

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:

Aware, ConfigurableEmbeddedServletContainer, EmbeddedServletContainerFactory, ErrorPageRegistry, ResourceLoaderAware

public class TomcatEmbeddedServletContainerFactory
extends AbstractEmbeddedServletContainerFactory
implements 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

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

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

Modifier and Type	Method and Description
void	addAdditionalTomcatConnectors(Connector... connectors) Add Connectors in addition to the default connector, e.g.
void	addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers) Add TomcatContextCustomizers that should be added to the Tomcat Connector.
void	addContextCustomizers(TomcatContextCustomizer... tomcatContextCustomizers) 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.
protected void	configureContext(Context context, ServletContextInitializer[] initializers) Configure the Tomcat Context.
protected void	configureSsl(AbstractHttp11JsseProtocol<?> protocol, Ssl ssl) Configure Tomcat's AbstractHttp11JsseProtocol for SSL.
protected void	configureSslStoreProvider(AbstractHttp11JsseProtocol<?> protocol, SslStoreProvider sslStoreProvider)
protected void	customizeConnector(Connector connector)
List<Connector>	getAdditionalTomcatConnectors() Returns a mutable collection of the Connectors that will be added to the Tomcat.
Collection<LifecycleListener>	getContextLifecycleListeners() Returns a mutable collection of the LifecycleListeners that will be applied to the Tomcat Context .
EmbeddedServletContainer	getEmbeddedServletContainer(ServletContextInitializer... initializers) Gets a new fully configured but paused EmbeddedServletContainer instance.
Collection<TomcatConnectorCustomizer>	getTomcatConnectorCustomizers() Returns a mutable collection of the TomcatConnectorCustomizers that will be applied to the Tomcat Context .
Collection<TomcatContextCustomizer>	getTomcatContextCustomizers() Returns a mutable collection of the TomcatContextCustomizers that will be applied to the Tomcat Context .
protected TomcatEmbeddedServletContainer	getTomcatEmbeddedServletContainer(Tomcat tomcat) Factory method called to create the TomcatEmbeddedServletContainer.
Charset	getUriEncoding() Returns the character encoding to use for URL decoding.
Collection<Valve>	getValves() Returns a mutable collection of the Valves that will be applied to the Tomcat Context.
protected void	postProcessContext(Context context) Post process the Tomcat Context before it used with the Tomcat Server.
protected void	prepareContext(Host host, ServletContextInitializer[] initializers)
void	setBaseDirectory(File baseDirectory) Set the Tomcat base directory.
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	setProtocol(String protocol) The Tomcat protocol to use when create the Connector.
void	setResourceLoader(ResourceLoader resourceLoader)
void	setTldSkip(String tldSkip) A comma-separated list of jars to ignore for TLD scanning.
void	setTomcatConnectorCustomizers(Collection<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers) Set TomcatConnectorCustomizers that should be applied to the Tomcat Connector .
void	setTomcatContextCustomizers(Collection<? extends TomcatContextCustomizer> tomcatContextCustomizers) Set TomcatContextCustomizers 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, getValidDocumentRoot, getValidSessionStoreDir, getValidSessionStoreDir

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

addErrorPages, addInitializers, getAddress, getCompression, getContextPath, getDisplayName, getDocumentRoot, getErrorPages, getJspServlet, getMimeMappings, getPort, getServerHeader, getSessionStoreDir, getSessionTimeout, getSsl, getSslStoreProvider, isPersistSession, isRegisterDefaultServlet, mergeInitializers, setAddress, setCompression, setContextPath, setDisplayName, setDocumentRoot, setErrorPages, setInitializers, setJspServlet, setMimeMappings, setPersistSession, setPort, setRegisterDefaultServlet, setServerHeader, setSessionStoreDir, setSessionTimeout, setSessionTimeout, setSsl, setSslStoreProvider, shouldRegisterJspServlet

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(Host host,
                              ServletContextInitializer[] initializers)

customizeConnector

protected void customizeConnector(Connector connector)

configureSsl

protected void configureSsl(AbstractHttp11JsseProtocol<?> protocol,
                            Ssl ssl)

Configure Tomcat's AbstractHttp11JsseProtocol for SSL.

Parameters:

protocol - the protocol

ssl - the ssl details

configureSslStoreProvider

protected void configureSslStoreProvider(AbstractHttp11JsseProtocol<?> protocol,
                                         SslStoreProvider sslStoreProvider)

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 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(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(ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface 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

public void setTldSkip(String tldSkip)

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

setProtocol

public void setProtocol(String protocol)

The Tomcat protocol to use when create the Connector.

Parameters:

protocol - the protocol

See Also:

Connector.Connector(String)

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 listeners.

Parameters:

contextValves - the valves to set

getValves

public Collection<Valve> getValves()

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

Returns:

the contextValves the valves that will be applied

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 contextLifecycleListeners the 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)

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(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)

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