|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.catalina.startup.Tomcat
public class Tomcat
Minimal tomcat starter for embedding/unit tests. 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: - all tomcat classes and possibly servlets are in the classpath. ( for example all is in one big jar, or in eclipse CP, or in any other combination ) - we need one temporary directory for work files - no config file is required. This class provides methods to use if you have a webapp with a web.xml file, but it is optional - you can use your own servlets. This class provides a main() and few simple CLI arguments, see setters for doc. It can be used for simple tests and demo.
for examples on how to use this
Nested Class Summary | |
---|---|
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. |
Field Summary | |
---|---|
protected java.lang.String |
basedir
|
protected Connector |
connector
|
static java.lang.String[] |
DEFAULT_MIME_MAPPINGS
TODO: would a properties resource be better ? |
protected Realm |
defaultRealm
|
protected StandardEngine |
engine
|
protected StandardHost |
host
|
protected java.lang.String |
hostname
|
protected int |
port
|
protected StandardServer |
server
|
protected StandardService |
service
|
Constructor Summary | |
---|---|
Tomcat()
|
Method Summary | |
---|---|
StandardContext |
addContext(StandardHost host,
java.lang.String contextPath,
java.lang.String dir)
|
StandardContext |
addContext(java.lang.String contextPath,
java.lang.String baseDir)
Add a context - programmatic mode, no web.xml used. |
void |
addRole(java.lang.String user,
java.lang.String role)
|
static StandardWrapper |
addServlet(StandardContext ctx,
java.lang.String servletName,
javax.servlet.Servlet servlet)
Use an existing servlet, no class.forName or initialization will be performed |
static StandardWrapper |
addServlet(StandardContext ctx,
java.lang.String servletName,
java.lang.String servletClass)
Equivalent with |
StandardWrapper |
addServlet(java.lang.String contextPath,
java.lang.String servletName,
java.lang.String servletClass)
|
void |
addUser(java.lang.String user,
java.lang.String pass)
Add a user for the in-memory realm. |
StandardContext |
addWebapp(StandardHost host,
java.lang.String url,
java.lang.String path)
|
StandardContext |
addWebapp(java.lang.String contextPath,
java.lang.String baseDir)
Add a webapp using normal WEB-INF/web.xml if found. |
Connector |
getConnector()
Get the default http connector. |
StandardEngine |
getEngine()
Access to the engine, for further customization. |
StandardHost |
getHost()
|
StandardServer |
getServer()
Get the server object. |
StandardService |
getService()
Get the service object. |
protected void |
initBaseDir()
|
protected void |
initSimpleAuth()
Initialize an in-memory realm. |
static void |
initWebappDefaults(StandardContext ctx)
Provide default configuration for a context. |
void |
setBaseDir(java.lang.String basedir)
Tomcat needs a directory for temp files. |
void |
setConnector(Connector connector)
|
void |
setDefaultRealm(Realm realm)
Set a custom realm for auth. |
void |
setHost(StandardHost 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()
Sets the log level to WARN for the loggers that log information on Tomcat start up. |
void |
start()
Initialize and start the server. |
void |
stop()
Stop the server. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected StandardServer server
protected StandardService service
protected StandardEngine engine
protected Connector connector
protected StandardHost host
protected int port
protected java.lang.String hostname
protected java.lang.String basedir
protected Realm defaultRealm
public static final java.lang.String[] DEFAULT_MIME_MAPPINGS
Constructor Detail |
---|
public Tomcat()
Method Detail |
---|
public void setBaseDir(java.lang.String basedir)
public void setPort(int port)
public void setHostname(java.lang.String s)
public StandardContext addWebapp(java.lang.String contextPath, java.lang.String baseDir) throws javax.servlet.ServletException
contextPath
- baseDir
-
javax.servlet.ServletException
public StandardContext addContext(java.lang.String contextPath, java.lang.String baseDir)
host
- NULL for the 'default' hostcontextPath
- "/" for root context.dir
- base dir for the context, for static files. Must exist,
relative to the server homepublic StandardWrapper addServlet(java.lang.String contextPath, java.lang.String servletName, java.lang.String servletClass)
public static StandardWrapper addServlet(StandardContext ctx, java.lang.String servletName, java.lang.String servletClass)
public static StandardWrapper addServlet(StandardContext ctx, java.lang.String servletName, javax.servlet.Servlet servlet)
public void start() throws java.lang.Exception
java.lang.Exception
public void stop() throws java.lang.Exception
java.lang.Exception
public void addUser(java.lang.String user, java.lang.String pass)
public void addRole(java.lang.String user, java.lang.String role)
addUser
public Connector getConnector() throws java.lang.Exception
java.lang.Exception
public void setConnector(Connector connector)
public StandardService getService()
public void setHost(StandardHost host)
host
- public StandardHost getHost()
public void setDefaultRealm(Realm realm)
public StandardEngine getEngine()
public StandardServer getServer()
public StandardContext addContext(StandardHost host, java.lang.String contextPath, java.lang.String dir)
public StandardContext addWebapp(StandardHost host, java.lang.String url, java.lang.String path) throws javax.servlet.ServletException
javax.servlet.ServletException
protected void initSimpleAuth()
protected void initBaseDir()
public void setSilent()
public static void initWebappDefaults(StandardContext ctx)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |