public class Tomcat
extends java.lang.Object
Tomcat supports multiple styles of configuration and startup - the most common and stable is server.xml-based, implemented in org.apache.catalina.startup.Bootstrap.
This class is for use in apps that embed tomcat.
Requirements:
There are a variety of 'add' methods to configure servlets and webapps. These methods, by default, create a simple in-memory security realm and apply it. If you need more complex security processing, you can define a subclass of this class.
This class provides a set of convenience methods for configuring webapp
contexts, all overloads of the method addWebapp
. These methods
create a webapp context, configure it, and then add it to a Host
.
They do not use a global default web.xml; rather, they add a lifecycle
listener that adds the standard DefaultServlet, JSP processing, and welcome
files.
In complex cases, you may prefer to use the ordinary Tomcat API to create
webapp contexts; for example, you might need to install a custom Loader
before the call to Container.addChild(Container)
. To replicate the basic
behavior of the addWebapp
methods, you may want to call two
methods of this class: noDefaultWebXmlPath()
and
getDefaultWebXmlListener()
.
getDefaultWebXmlListener()
returns a LifecycleListener
that
adds the standard DefaultServlet, JSP processing, and welcome files. If you
add this listener, you must prevent Tomcat from applying any standard global
web.xml with ...
noDefaultWebXmlPath()
returns a dummy pathname to configure to
prevent ContextConfig
from trying to apply a global web.xml file.
This class provides a main() and few simple CLI arguments, see setters for doc. It can be used for simple tests and demo.
Modifier and Type | Class and Description |
---|---|
static class |
Tomcat.DefaultWebXmlListener
Fix reload - required if reloading and using programmatic configuration.
|
static class |
Tomcat.ExistingStandardWrapper
Helper class for wrapping existing servlets.
|
static class |
Tomcat.FixContextListener
Fix startup sequence - required if you don't use web.xml.
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
basedir |
protected Connector |
connector |
protected Engine |
engine |
protected Host |
host |
protected java.lang.String |
hostname |
protected int |
port |
protected Server |
server |
protected Service |
service |
Constructor and Description |
---|
Tomcat() |
Modifier and Type | Method and Description |
---|---|
Context |
addContext(Host host,
java.lang.String contextPath,
java.lang.String dir) |
Context |
addContext(Host host,
java.lang.String contextPath,
java.lang.String contextName,
java.lang.String dir) |
Context |
addContext(java.lang.String contextPath,
java.lang.String docBase)
Add a context - programmatic mode, no default web.xml used.
|
void |
addRole(java.lang.String user,
java.lang.String role) |
static Wrapper |
addServlet(Context ctx,
java.lang.String servletName,
Servlet servlet)
Static version of
addServlet(String, String, Servlet) . |
static Wrapper |
addServlet(Context ctx,
java.lang.String servletName,
java.lang.String servletClass)
Static version of
addServlet(String, String, String) |
Wrapper |
addServlet(java.lang.String contextPath,
java.lang.String servletName,
Servlet servlet)
Add an existing Servlet to the context with no class.forName or
initialisation.
|
Wrapper |
addServlet(java.lang.String contextPath,
java.lang.String servletName,
java.lang.String servletClass)
Equivalent to <servlet><servlet-name><servlet-class>.
|
void |
addUser(java.lang.String user,
java.lang.String pass)
Add a user for the in-memory realm.
|
Context |
addWebapp(Host host,
java.lang.String contextPath,
java.lang.String docBase) |
Context |
addWebapp(Host host,
java.lang.String contextPath,
java.lang.String docBase,
ContextConfig config)
Deprecated.
|
Context |
addWebapp(Host host,
java.lang.String contextPath,
java.lang.String docBase,
LifecycleListener config) |
Context |
addWebapp(Host host,
java.lang.String contextPath,
java.lang.String name,
java.lang.String docBase)
Deprecated.
|
Context |
addWebapp(java.lang.String contextPath,
java.lang.String docBase)
This is equivalent to adding a web application to Tomcat's webapps
directory.
|
protected Realm |
createDefaultRealm()
Create an in-memory realm.
|
void |
destroy()
Destroy the server.
|
void |
enableNaming()
Enables JNDI naming which is disabled by default.
|
Connector |
getConnector()
Get the default http connector.
|
LifecycleListener |
getDefaultWebXmlListener()
Return a listener that provides the required configuration items for JSP
processing.
|
Engine |
getEngine()
Access to the engine, for further customization.
|
Host |
getHost() |
Server |
getServer()
Get the server object.
|
Service |
getService()
Get the service object.
|
protected java.net.URL |
getWebappConfigFile(java.lang.String path,
java.lang.String contextName) |
void |
init()
Initialise the server.
|
protected void |
initBaseDir() |
static void |
initWebappDefaults(Context ctx)
Static version of
initWebappDefaults(String) |
void |
initWebappDefaults(java.lang.String contextPath)
Provide default configuration for a context.
|
java.lang.String |
noDefaultWebXmlPath() |
void |
setBaseDir(java.lang.String basedir)
Tomcat needs a directory for temp files.
|
void |
setConnector(Connector connector) |
void |
setHost(Host host)
Sets the current host - all future webapps will
be added to this host.
|
void |
setHostname(java.lang.String s)
The the hostname of the default host, default is
'localhost'.
|
void |
setPort(int port)
Set the port for the default connector.
|
void |
setSilent(boolean silent)
Controls if the loggers will be silenced or not.
|
void |
start()
Start the server.
|
void |
stop()
Stop the server.
|
protected Server server
protected Service service
protected Engine engine
protected Connector connector
protected Host host
protected int port
protected java.lang.String hostname
protected java.lang.String basedir
public void setBaseDir(java.lang.String basedir)
By default, if this method is not called, we use:
TODO: disable work dir if not needed ( no jsp, etc ).
public void setPort(int port)
public void setHostname(java.lang.String s)
public Context addWebapp(java.lang.String contextPath, java.lang.String docBase) throws ServletException
ServletContainerInitializer
processing will be
applied.ServletException
public Context addContext(java.lang.String contextPath, java.lang.String docBase)
ServletContainerInitializer
processing and no
annotation processing. If a
ServletContainerInitializer
is added
programmatically, there will still be no scanning for
HandlesTypes
matches.
API calls equivalent with web.xml:
// context-param
ctx.addParameter("name", "value");
// error-page
ErrorPage ep = new ErrorPage();
ep.setErrorCode(500);
ep.setLocation("/error.html");
ctx.addErrorPage(ep);
ctx.addMimeMapping("ext", "type");
Note: If you reload the Context, all your configuration will be lost. If you need reload support, consider using a LifecycleListener to provide your configuration.
TODO: add the rest
contextPath
- "" for root context.docBase
- base dir for the context, for static files. Must exist,
relative to the server homepublic Wrapper addServlet(java.lang.String contextPath, java.lang.String servletName, java.lang.String servletClass)
In general it is better/faster to use the method that takes a Servlet as param - this one can be used if the servlet is not commonly used, and want to avoid loading all deps. ( for example: jsp servlet ) You can customize the returned servlet, ex:
wrapper.addInitParameter("name", "value");
contextPath
- Context to add Servlet toservletName
- Servlet name (used in mappings)servletClass
- The class to be used for the Servletpublic static Wrapper addServlet(Context ctx, java.lang.String servletName, java.lang.String servletClass)
addServlet(String, String, String)
ctx
- Context to add Servlet toservletName
- Servlet name (used in mappings)servletClass
- The class to be used for the Servletpublic Wrapper addServlet(java.lang.String contextPath, java.lang.String servletName, Servlet servlet)
contextPath
- Context to add Servlet toservletName
- Servlet name (used in mappings)servlet
- The Servlet to addpublic static Wrapper addServlet(Context ctx, java.lang.String servletName, Servlet servlet)
addServlet(String, String, Servlet)
.ctx
- Context to add Servlet toservletName
- Servlet name (used in mappings)servlet
- The Servlet to addpublic void init() throws LifecycleException
LifecycleException
public void start() throws LifecycleException
LifecycleException
public void stop() throws LifecycleException
LifecycleException
public void destroy() throws LifecycleException
LifecycleException
public void addUser(java.lang.String user, java.lang.String pass)
public void addRole(java.lang.String user, java.lang.String role)
addUser(String, String)
public Connector getConnector()
Alternatively, you can construct a Connector and set any params, then call addConnector(Connector)
public void setConnector(Connector connector)
public Service getService()
public void setHost(Host host)
host
- public Host getHost()
public Engine getEngine()
public Server getServer()
public Context addContext(Host host, java.lang.String contextPath, java.lang.String dir)
addContext(String, String)
public Context addContext(Host host, java.lang.String contextPath, java.lang.String contextName, java.lang.String dir)
addContext(String, String)
public Context addWebapp(Host host, java.lang.String contextPath, java.lang.String docBase)
addWebapp(String, String)
@Deprecated public Context addWebapp(Host host, java.lang.String contextPath, java.lang.String name, java.lang.String docBase)
addWebapp(Host, String, String)
name
- Ignored. The path will be usedaddWebapp(String, String)
@Deprecated public Context addWebapp(Host host, java.lang.String contextPath, java.lang.String docBase, ContextConfig config)
addWebapp(Host, String, String, LifecycleListener)
insteadaddWebapp(String, String)
public Context addWebapp(Host host, java.lang.String contextPath, java.lang.String docBase, LifecycleListener config)
host
- The host in which the context will be deployedcontextPath
- The context mapping to use, "" for root context.docBase
- Base directory for the context, for static files.
Must exist, relative to the server homeconfig
- Custom context configurator helperaddWebapp(String, String)
public LifecycleListener getDefaultWebXmlListener()
Lifecycle.addLifecycleListener(LifecycleListener)
and then pass the
result of noDefaultWebXmlPath()
to
ContextConfig.setDefaultWebXml(String)
.public java.lang.String noDefaultWebXmlPath()
ContextConfig.setDefaultWebXml(String)
when using
getDefaultWebXmlListener()
.protected Realm createDefaultRealm()
protected void initBaseDir()
public void setSilent(boolean silent)
silent
- true
sets the log level to WARN for the
loggers that log information on Tomcat start up. This
prevents the usual startup information being logged.
false
sets the log level to the default
level of INFO.public void enableNaming()
Lifecycle
in order for the NamingContextListener
to be
used.public void initWebappDefaults(java.lang.String contextPath)
contextPath
- The context to set the defaults forpublic static void initWebappDefaults(Context ctx)
initWebappDefaults(String)
ctx
- The context to set the defaults forprotected java.net.URL getWebappConfigFile(java.lang.String path, java.lang.String contextName)
Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.