public class TomcatEmbeddedServletContainerFactory extends AbstractEmbeddedServletContainerFactory implements ResourceLoaderAware
EmbeddedServletContainerFactory
that can be used to create
TomcatEmbeddedServletContainer
s. Can be initialized using Spring's
ServletContextInitializer
s or Tomcat LifecycleListener
s.
Unless explicitly configured otherwise this factory will created containers that listens for HTTP requests on port 8080.
AbstractEmbeddedServletContainerFactory.setPort(int)
,
setContextLifecycleListeners(Collection)
,
TomcatEmbeddedServletContainer
logger
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. |
Modifier and Type | Method and Description |
---|---|
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(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 . |
protected void |
configureContext(Context context,
ServletContextInitializer[] initializers)
Configure the Tomcat
Context . |
protected void |
customizeConnector(Connector connector) |
Collection<LifecycleListener> |
getContextLifecycleListeners()
Returns a mutable collection of the
LifecycleListener s 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
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(Tomcat tomcat)
Factory method called to create the
TomcatEmbeddedServletContainer . |
Collection<Valve> |
getValves()
Returns a mutable collection of the
Valve s 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
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 |
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
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 . |
addErrorPages, addInitializers, getAddress, getContextPath, getDocumentRoot, getErrorPages, getInitializers, getJspServletClassName, getMimeMappings, getPort, getSessionTimeout, getValidDocumentRoot, isRegisterDefaultServlet, isRegisterJspServlet, mergeInitializers, setAddress, setContextPath, setDocumentRoot, setErrorPages, setInitializers, setJspServletClassName, setMimeMappings, setPort, setRegisterDefaultServlet, setRegisterJspServlet, setSessionTimeout, setSessionTimeout
public TomcatEmbeddedServletContainerFactory()
TomcatEmbeddedServletContainerFactory
instance.public TomcatEmbeddedServletContainerFactory(int port)
TomcatEmbeddedServletContainerFactory
that listens for
requests using the specified port.port
- the port to listen onpublic TomcatEmbeddedServletContainerFactory(String contextPath, int port)
TomcatEmbeddedServletContainerFactory
with the specified
context path and port.contextPath
- root the context pathport
- the port to listen onpublic EmbeddedServletContainer getEmbeddedServletContainer(ServletContextInitializer... initializers)
EmbeddedServletContainerFactory
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).getEmbeddedServletContainer
in interface EmbeddedServletContainerFactory
initializers
- ServletContextInitializer
s that should be applied as
the container startsEmbeddedServletContainer
EmbeddedServletContainer.stop()
protected void prepareContext(Host host, ServletContextInitializer[] initializers)
protected void customizeConnector(Connector connector)
protected void configureContext(Context context, ServletContextInitializer[] initializers)
Context
.context
- the Tomcat contextinitializers
- initializers to applyprotected void postProcessContext(Context context)
Context
before it used with the Tomcat Server.
Subclasses can override this method to apply additional processing to the
Context
.context
- the Tomcat Context
protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(Tomcat tomcat)
TomcatEmbeddedServletContainer
.
Subclasses can override this method to return a different
TomcatEmbeddedServletContainer
or apply additional processing to the Tomcat
server.tomcat
- the Tomcat server.TomcatEmbeddedServletContainer
instancepublic void setResourceLoader(ResourceLoader resourceLoader)
setResourceLoader
in interface ResourceLoaderAware
public void setBaseDirectory(File baseDirectory)
baseDirectory
- the tomcat base directorypublic void setTldSkip(String tldSkip)
tldSkip
- the jars to skip when scanning for TLDs etcpublic void setProtocol(String protocol)
Connector
.Connector#Connector(String)
public void setContextValves(Collection<? extends Valve> contextValves)
Valve
s that should be applied to the Tomcat Context
. Calling
this method will replace any existing listeners.contextValves
- the valves to setpublic Collection<Valve> getValves()
Valve
s that will be applied to the
Tomcat Context
.public void addContextValves(Valve... contextValves)
Valve
s that should be applied to the Tomcat Context
.contextValves
- the valves to addpublic void setContextLifecycleListeners(Collection<? extends LifecycleListener> contextLifecycleListeners)
LifecycleListener
s that should be applied to the Tomcat Context
. Calling this method will replace any existing listeners.contextLifecycleListeners
- the listeners to setpublic Collection<LifecycleListener> getContextLifecycleListeners()
LifecycleListener
s that will be applied
to the Tomcat Context
.public void addContextLifecycleListeners(LifecycleListener... contextLifecycleListeners)
LifecycleListener
s that should be added to the Tomcat Context
.contextLifecycleListeners
- the listeners to addpublic void setTomcatContextCustomizers(Collection<? extends TomcatContextCustomizer> tomcatContextCustomizers)
TomcatContextCustomizer
s that should be applied to the Tomcat
Context
. Calling this method will replace any existing customizers.tomcatContextCustomizers
- the customizers to setpublic Collection<TomcatContextCustomizer> getTomcatContextCustomizers()
TomcatContextCustomizer
s that will be
applied to the Tomcat Context
.public void addContextCustomizers(TomcatContextCustomizer... tomcatContextCustomizers)
TomcatContextCustomizer
s that should be added to the Tomcat
Context
.tomcatContextCustomizers
- the customizers to addpublic void setTomcatConnectorCustomizers(Collection<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers)
TomcatConnectorCustomizer
s that should be applied to the Tomcat
Connector
. Calling this method will replace any existing customizers.tomcatConnectorCustomizers
- the customizers to setpublic void addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers)
TomcatContextCustomizer
s that should be added to the Tomcat
Connector
.tomcatConnectorCustomizers
- the customizers to addpublic Collection<TomcatConnectorCustomizer> getTomcatConnectorCustomizers()
TomcatConnectorCustomizer
s that will be
applied to the Tomcat Context
.Copyright © 2014. All rights reserved.