1238 lines
97 KiB
HTML
1238 lines
97 KiB
HTML
|
<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 6.0 - Manager App HOW-TO</title><meta name="author" value="Craig R. McClanahan"><meta name="email" value="craigmcc@apache.org"></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img src="./images/tomcat.gif" align="right" alt="
|
||
|
|
The Apache Tomcat Servlet/JSP Container
|
||
|
|
" border="0"></a></td><td><font face="arial,helvetica,sanserif"><h1>Apache Tomcat 6.0</h1></font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="./images/asf-logo.gif" align="right" alt="Apache Logo" border="0"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap="true"><p><strong>Links</strong></p><ul><li><a href="index.html">Docs Home</a></li><li><a href="http://tomcat.apache.org/faq">FAQ</a></li></ul><p><strong>User Guide</strong></p><ul><li><a href="introduction.html">1) Introduction</a></li><li><a href="setup.html">2) Setup</a></li><li><a href="appdev/index.html">3) First webapp</a></li><li><a href="deployer-howto.html">4) Deployer</a></li><li><a href="manager-howto.html">5) Manager</a></li><li><a href="realm-howto.html">6) Realms and AAA</a></li><li><a href="security-manager-howto.html">7) Security Manager</a></li><li><a href="jndi-resources-howto.html">8) JNDI Resources</a></li><li><a href="jndi-datasource-examples-howto.html">9) JDBC DataSources</a></li><li><a href="class-loader-howto.html">10) Classloading</a></li><li><a href="jasper-howto.html">11) JSPs</a></li><li><a href="ssl-howto.html">12) SSL</a></li><li><a href="ssi-howto.html">13) SSI</a></li><li><a href="cgi-howto.html">14) CGI</a></li><li><a href="proxy-howto.html">15) Proxy Support</a></li><li><a href="mbeans-descriptor-howto.html">16) MBean Descriptor</a></li><li><a href="default-servlet.html">17) Default Servlet</a></li><li><a href="cluster-howto.html">18) Clustering</a></li><li><a href="balancer-howto.html">19) Load Balancer</a></li><li><a href="connectors.html">20) Connectors</a></li><li><a href="monitoring.html">21) Monitoring and Management</a></li><li><a href="logging.html">22) Logging</a></li><li><a href="apr.html">23) APR</a></li><li><a href="virtual-hosting-howto.html">24) Virtual Hosting</a></li><li><a href="aio.html">25) Advanced IO</a></li><li><a href="extras.html">26) Additional Components</a></li><li><a href="maven-jars.html">27) Mavenized</a></li></ul><p><strong>Reference</strong></p><ul><li><a href="RELEASE-NOTES.txt">Release Notes</a></li><li><a href="config/index.html">Configuration</a></li><li><a href="api/index.html">Javadocs</a></li><li><a href="http://tomcat.apache.org/connectors-doc/">JK 1.2 Documentation</a></li></ul><p><strong>Apache Tomcat Development</strong></p><ul><li><a href="building.html">Building</a></li><li><a href="changelog.html">Changelog</a></li><li><a href="status.html">Status</a></li><li><a href="developers.html">Developers</a></li><li><a href="architecture/index.html">Architecture</a></li><li><a href="funcspecs/index.html">Functional Specs.</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left"><table border="0" width="100%" cellspacing="4"><tr><td align="left" valign="top"><h1>Apache Tomcat 6.0</h1><h2>Manager App HOW-TO</h2></td><td align="right" valign="top" nowrap="true"><small><a href="printer/manager-howto.html"><img src="./images/printer.gif" border="0" alt="Printer Friendly Version"><br>print-friendly<br>version
|
||
|
|
</a></small></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Table of Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
<a href="#Introduction">Introduction</a><br>
|
||
|
|
<a href="#Configuring Manager Application Access">
|
||
|
|
Configuring Manager Application Access</a><br>
|
||
|
|
<a href="#Supported Manager Commands">Supported Manager Commands</a><br>
|
||
|
|
<blockquote>
|
||
|
|
<a href="#Deploy A New Application Remotely">Deploy A New Application Remotely</a><br>
|
||
|
|
<a href="#Deploy A New Application from a Local Path">Deploy A New Application from a Local Path</a><br>
|
||
|
|
<a href="#List Currently Deployed Applications">
|
||
|
|
List Currently Deployed Applications</a><br>
|
||
|
|
<a href="#Reload An Existing Application">Reload An Existing Application</a><br>
|
||
|
|
<a href="#List OS and JVM Properties">List OS and JVM Properties</a><br>
|
||
|
|
<a href="#List Available Global JNDI Resources">
|
||
|
|
List Available Global JNDI Resources</a><br>
|
||
|
|
<a href="#List Available Security Roles">List Available Security Roles</a><br>
|
||
|
|
<a href="#Session Statistics">Session Statistics</a><br>
|
||
|
|
<a href="#Start an Existing Application">Start an Existing Application</a><br>
|
||
|
|
<a href="#Stop an Existing Application">Stop an Existing Application</a><br>
|
||
|
|
<a href="#Undeploy an Existing Application">
|
||
|
|
Undeploy an Existing Application</a><br>
|
||
|
|
</blockquote>
|
||
|
|
<a href="#Executing Manager Commands With Ant">
|
||
|
|
Executing Manager Commands With Ant</a><br>
|
||
|
|
<a href="#Using the JMX Proxy Servlet">
|
||
|
|
Using the JMX Proxy Servlet</a><br>
|
||
|
|
<blockquote>
|
||
|
|
<a href="#What is JMX Proxy Servlet">What is JMX Proxy Servlet?</a><br>
|
||
|
|
<a href="#JMX Query command">Query command</a><br>
|
||
|
|
<a href="#JMX Set command">Set command</a><br>
|
||
|
|
</blockquote>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>In many production environments, it is very useful to have the capability
|
||
|
|
to deploy a new web application, or undeploy an existing one, without having
|
||
|
|
to shut down and restart the entire container. In addition, you can request
|
||
|
|
an existing application to reload itself, even if you have not declared it
|
||
|
|
to be <code>reloadable</code> in the Tomcat 6 server
|
||
|
|
configuration file.</p>
|
||
|
|
|
||
|
|
<p>To support these capabilities, Tomcat 6 includes a web application
|
||
|
|
(installed by default on context path <code>/manager</code>) that supports
|
||
|
|
the following functions:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Deploy a new web application from the uploaded contents of a WAR file.</li>
|
||
|
|
<li>Deploy a new web application, on a specified context path, from the
|
||
|
|
server file system.</li>
|
||
|
|
<li>List the currently deployed web applications, as well as the
|
||
|
|
sessions that are currently active for those web apps.</li>
|
||
|
|
<li>Reload an existing web application, to reflect changes in the
|
||
|
|
contents of <code>/WEB-INF/classes</code> or <code>/WEB-INF/lib</code>.
|
||
|
|
</li>
|
||
|
|
<li>List the OS and JVM property values.</li>
|
||
|
|
<li>List the available global JNDI resources, for use in deployment
|
||
|
|
tools that are preparing <code><ResourceLink></code> elements
|
||
|
|
nested in a <code><Context></code> deployment description.</li>
|
||
|
|
<li>List the available security roles defined in the user database.</li>
|
||
|
|
<li>Start a stopped application (thus making it available again).</li>
|
||
|
|
<li>Stop an existing application (so that it becomes unavailable), but
|
||
|
|
do not undeploy it.</li>
|
||
|
|
<li>Undeploy a deployed web application and delete its document base
|
||
|
|
directory (unless it was deployed from file system).</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>A default Tomcat installation includes the manager. To add an instance of the
|
||
|
|
Manager web application <code>Context</code> to a new host install the
|
||
|
|
<code>manager.xml</code> context configuration file in the
|
||
|
|
<code>$CATALINA_HOME/conf/[enginename]/[hostname]</code> folder. Here is an
|
||
|
|
example:
|
||
|
|
<pre>
|
||
|
|
<Context path="/manager" debug="0" privileged="true"
|
||
|
|
docBase="/usr/local/kinetic/tomcat6/server/webapps/manager">
|
||
|
|
</Context>
|
||
|
|
</pre>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>If you have Tomcat configured to support multiple virtual hosts
|
||
|
|
(websites) you would need to configure a Manager for each.</p>
|
||
|
|
|
||
|
|
<p>There are three ways to use the <code>Manager</code> web application.
|
||
|
|
<ul>
|
||
|
|
<li>As an application with a user interface you use in your browser.
|
||
|
|
Here is an example URL where you can replace <code>localhost</code> with
|
||
|
|
your website host name: <code>http://localhost/manager/html/</code> .</li>
|
||
|
|
<li>A minimal version using HTTP requests only which is suitable for use
|
||
|
|
by scripts setup by system administrators. Commands are given as part of the
|
||
|
|
request URI, and responses are in the form of simple text that can be easily
|
||
|
|
parsed and processed. See <a href="#Supported Manager Commands">
|
||
|
|
Supported Manager Commands</a> for more information.</li>
|
||
|
|
<li>A convenient set of task definitions for the <em>Ant</em>
|
||
|
|
(version 1.4 or later) build tool. See
|
||
|
|
<a href="#Executing Manager Commands With Ant">Executing Manager Commands
|
||
|
|
With Ant</a> for more information.</li>
|
||
|
|
</ul>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Configuring Manager Application Access"><strong>Configuring Manager Application Access</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<blockquote><em>
|
||
|
|
<p>The description below uses the variable name $CATALINA_HOME
|
||
|
|
to refer to the directory into which you have installed Tomcat 6,
|
||
|
|
and is the base directory against which most relative paths are
|
||
|
|
resolved. However, if you have configured Tomcat 6 for multiple
|
||
|
|
instances by setting a CATALINA_BASE directory, you should use
|
||
|
|
$CATALINA_BASE instead of $CATALINA_HOME for each of these
|
||
|
|
references.</p>
|
||
|
|
</em></blockquote>
|
||
|
|
|
||
|
|
<p>It would be quite unsafe to ship Tomcat with default settings that allowed
|
||
|
|
anyone on the Internet to execute the Manager application on your server.
|
||
|
|
Therefore, the Manager application is shipped with the requirement that anyone
|
||
|
|
who attempts to use it must authenticate themselves, using a username and
|
||
|
|
password that have the role <strong>manager</strong> associated with them.
|
||
|
|
Further, there is no username in the default users file
|
||
|
|
(<conf>$CATALINA_HOME/conf/tomcat-users.xml</conf>) that is assigned this
|
||
|
|
role. Therefore, access to the Manager application is completely disabled
|
||
|
|
by default.</p>
|
||
|
|
|
||
|
|
<p>To enable access to the Manager web application, you must either create
|
||
|
|
a new username/password combination and associate the role name
|
||
|
|
<strong>manager</strong> with it, or add the <strong>manager</strong> role
|
||
|
|
to some existing username/password combination. Exactly where this is done
|
||
|
|
depends on which <code>Realm</code> implementation you are using:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>MemoryRealm</em> - If you have not customized your
|
||
|
|
<code>$CATALINA_HOME/conf/server.xml</code> to select a different one,
|
||
|
|
Tomcat 6 defaults to an XML-format file stored at
|
||
|
|
<code>$CATALINA_HOME/conf/tomcat-users.xml</code>, which can be
|
||
|
|
edited with any text editor. This file contains an XML
|
||
|
|
<code><user></code> for each individual user, which might
|
||
|
|
look something like this:
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
<user name="craigmcc" password="secret" roles="standard,manager" />
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
which defines the username and password used by this individual to
|
||
|
|
log on, and the role names he or she is associated with. You can
|
||
|
|
add the <strong>manager</strong> role to the comma-delimited
|
||
|
|
<code>roles</code> attribute for one or more existing users, and/or
|
||
|
|
create new users with that assigned role.</li>
|
||
|
|
<li><em>JDBCRealm</em> - Your user and role information is stored in
|
||
|
|
a database accessed via JDBC. Add the <strong>manager</strong> role
|
||
|
|
to one or more existing users, and/or create one or more new users
|
||
|
|
with this role assigned, following the standard procedures for your
|
||
|
|
environment.</li>
|
||
|
|
<li><em>JNDIRealm</em> - Your user and role information is stored in
|
||
|
|
a directory server accessed via LDAP. Add the <strong>manager</strong>
|
||
|
|
role to one or more existing users, and/or create one or more new users
|
||
|
|
with this role assigned, following the standard procedures for your
|
||
|
|
environment.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>The first time you attempt to issue one of the Manager commands
|
||
|
|
described in the next section, you will be challenged to log on using
|
||
|
|
BASIC authentication. The username and password you enter do not matter,
|
||
|
|
as long as they identify a valid user in the users database who possesses
|
||
|
|
the role <strong>manager</strong>.</p>
|
||
|
|
|
||
|
|
<p>In addition to the password restrictions the manager web application
|
||
|
|
could be restricted by the remote IP address or host by adding a
|
||
|
|
<code>RemoteAddrValve</code> or <code>RemoteHostValve</code>. Here is
|
||
|
|
an example of restricting access to the localhost by IP address:
|
||
|
|
<pre>
|
||
|
|
<Context path="/manager" privileged="true"
|
||
|
|
docBase="/usr/local/kinetic/tomcat6/server/webapps/manager">
|
||
|
|
<Valve className="org.apache.catalina.valves.RemoteAddrValve"
|
||
|
|
allow="127\.0\.0\.1"/>
|
||
|
|
</Context>
|
||
|
|
</pre>
|
||
|
|
</p>
|
||
|
|
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Supported Manager Commands"><strong>Supported Manager Commands</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>All commands that the Manager application knows how to process are
|
||
|
|
specified in a single request URI like this:</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://{host}:{port}/manager/{command}?{parameters}
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
<p>where <code>{host}</code> and <code>{port}</code> represent the hostname
|
||
|
|
and port number on which Tomcat is running, <code>{command}</code>
|
||
|
|
represents the Manager command you wish to execute, and
|
||
|
|
<code>{parameters}</code> represents the query parameters
|
||
|
|
that are specific to that command. In the illustrations below, customize
|
||
|
|
the host and port appropriately for your installation.</p>
|
||
|
|
|
||
|
|
<p>Most commands accept one or more of the following query parameters:</p>
|
||
|
|
<ul>
|
||
|
|
<li><strong>path</strong> - The context path (including the leading slash)
|
||
|
|
of the web application you are dealing with. To select the ROOT web
|
||
|
|
application, specify "/". <strong>NOTE</strong> -
|
||
|
|
It is not possible to perform administrative commands on the
|
||
|
|
Manager application itself.</li>
|
||
|
|
<li><strong>war</strong> - URL of a web application archive (WAR) file,
|
||
|
|
pathname of a directory which contains the web application, or a
|
||
|
|
Context configuration ".xml" file. You can use URLs in any of the
|
||
|
|
following formats:
|
||
|
|
<ul>
|
||
|
|
<li><strong>file:/absolute/path/to/a/directory</strong> - The absolute
|
||
|
|
path of a directory that contains the unpacked version of a web
|
||
|
|
application. This directory will be attached to the context path
|
||
|
|
you specify without any changes.</li>
|
||
|
|
<li><strong>file:/absolute/path/to/a/webapp.war</strong> - The absolute
|
||
|
|
path of a web application archive (WAR) file. This is valid
|
||
|
|
<strong>only</strong> for the <code>/deploy</code> command, and is
|
||
|
|
the only acceptable format to that command.</li>
|
||
|
|
<li><strong>jar:file:/absolute/path/to/a/warfile.war!/</strong> - The
|
||
|
|
URL to a local web application archive (WAR) file. You can use any
|
||
|
|
syntax that is valid for the <code>JarURLConnection</code> class
|
||
|
|
for reference to an entire JAR file.</li>
|
||
|
|
<li><strong>file:/absolute/path/to/a/context.xml</strong> - The
|
||
|
|
absolute path of a web application Context configuration ".xml"
|
||
|
|
file which contains the Context configuration element.</li>
|
||
|
|
<li><strong>directory</strong> - The directory name for the web
|
||
|
|
applciation context in the Host's application base directory.</li>
|
||
|
|
<li><strong>webapp.war</strong> - The name of a web application war file
|
||
|
|
located in the Host's application base directory.</li>
|
||
|
|
</ul></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>Each command will return a response in <code>text/plain</code> format
|
||
|
|
(i.e. plain ASCII with no HTML markup), making it easy for both humans and
|
||
|
|
programs to read). The first line of the response wil begin with either
|
||
|
|
<code>OK</code> or <code>FAIL</code>, indicating whether the requested
|
||
|
|
command was successful or not. In the case of failure, the rest of the first
|
||
|
|
line will contain a description of the problem that was encountered. Some
|
||
|
|
commands include additional lines of information as described below.</p>
|
||
|
|
|
||
|
|
<p><em>Internationalization Note</em> - The Manager application looks up
|
||
|
|
its message strings in resource bundles, so it is possible that the strings
|
||
|
|
have been translated for your platform. The examples below show the English
|
||
|
|
version of the messages.</p>
|
||
|
|
|
||
|
|
<blockquote><em>
|
||
|
|
<p><strong>WARNING:</strong> the legacy commands <code>/install</code> and
|
||
|
|
<code>/remove</code> are deprecated.
|
||
|
|
They are presently equivalent to <code>/deploy</code> and <code>/undeploy</code>,
|
||
|
|
but could be removed in a future release.</p>
|
||
|
|
</em></blockquote>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Deploy A New Application Remotely"><strong>Deploy A New Application Remotely</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/deploy?path=/foo
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Upload the web application archive (WAR) file that is specified as the
|
||
|
|
request data in this HTTP PUT request, install it into the <code>appBase</code>
|
||
|
|
directory of our corresponding virtual host, and start , using the directory
|
||
|
|
name or the war file name without the .war extension as the path. The
|
||
|
|
application can later be undeployed (and the corresponding application directory
|
||
|
|
removed) by use of the <code>/undeploy</code> command.</p>
|
||
|
|
|
||
|
|
<p>The .WAR file may include Tomcat specific deployment configuration, by
|
||
|
|
including a Context configuration XML file in
|
||
|
|
<code>/META-INF/context.xml</code>.</p>
|
||
|
|
|
||
|
|
<p>URL parameters include:
|
||
|
|
<ul>
|
||
|
|
<li><code>update</code>: When set to true, any existing update will be
|
||
|
|
undeployed first. The default value is set to false.</li>
|
||
|
|
<li><code>tag</code>: Specifying a tag name, this allows associating the
|
||
|
|
deployed webapp with a version number. The application version can
|
||
|
|
be later redeployed when needed using only the tag.</li>
|
||
|
|
</ul>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p><strong>NOTE</strong> - This command is the logical
|
||
|
|
opposite of the <code>/undeploy</code> command.</p>
|
||
|
|
|
||
|
|
<p>If installation and startup is successful, you will receive a response
|
||
|
|
like this:</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
OK - Deployed application at context path /foo
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Otherwise, the response will start with <code>FAIL</code> and include an
|
||
|
|
error message. Possible causes for problems include:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>Application already exists at path /foo</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>The context paths for all currently running web applications must be
|
||
|
|
unique. Therefore, you must undeploy the existing web
|
||
|
|
application using this context path, or choose a different context path
|
||
|
|
for the new one. The <code>update</code> parameter may be specified as
|
||
|
|
a parameter on the URL, with a value of <code>true</code> to avoid this
|
||
|
|
error. In that case, an undeploy will be performed on an existing
|
||
|
|
application before performing the deployment.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Encountered exception</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>An exception was encountered trying to start the new web application.
|
||
|
|
Check the Tomcat 6 logs for the details, but likely explanations include
|
||
|
|
problems parsing your <code>/WEB-INF/web.xml</code> file, or missing
|
||
|
|
classes encountered when initializing application event listeners and
|
||
|
|
filters.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Deploy A New Application from a Local Path"><strong>Deploy A New Application from a Local Path</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>Deploy and start a new web application, attached to the specified context
|
||
|
|
<code>path</code> (which must not be in use by any other web application).
|
||
|
|
This command is the logical opposite of the <code>/undeploy</code> command.</p>
|
||
|
|
|
||
|
|
<p>There are a number of different ways the deploy command can be used.</p>
|
||
|
|
|
||
|
|
<h3>Deploy a version of a previously deployed webapp</h3>
|
||
|
|
|
||
|
|
<p>This can be used to deploy a previous version of a web application, which
|
||
|
|
has been deployed using the <code>tag</code> attribute. Note that the work
|
||
|
|
directory for the manager webapp will contain the previously deployed WARs;
|
||
|
|
removing it would make the deployment fail.
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/deploy?path=/footoo&tag=footag
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<h3>Deploy a Directory or WAR by URL</h3>
|
||
|
|
|
||
|
|
<p>Deploy a web application directory or ".war" file located on the Tomcat
|
||
|
|
server. If no <code>path</code> is specified, the directory name or the war file
|
||
|
|
name without the ".war" extension is used as the path. The <code>war</code>
|
||
|
|
parameter specifies a URL (including the <code>file:</code> scheme) for either
|
||
|
|
a directory or a web application archive (WAR) file. The supported syntax for
|
||
|
|
a URL referring to a WAR file is described on the Javadocs page for the
|
||
|
|
<code>java.net.JarURLConnection</code> class. Use only URLs that refer to
|
||
|
|
the entire WAR file.</p>
|
||
|
|
|
||
|
|
<p>In this example the web application located in the directory
|
||
|
|
<code>/path/to/foo</code> on the Tomcat server is deployed as the
|
||
|
|
web application context named <code>/footoo</code>.
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/deploy?path=/footoo&war=file:/path/to/foo
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>In this example the ".war" file <code>/path/to/bar.war</code> on the
|
||
|
|
Tomcat server is deployed as the web application context named
|
||
|
|
<code>/bar</code>. Notice that there is no <code>path</code> parameter
|
||
|
|
so the context path defaults to the name of the web application archive
|
||
|
|
file without the ".war" extension.
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/deploy?war=jar:file:/path/to/bar.war!/
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<h3>Deploy a Directory or War from the Host appBase</h3>
|
||
|
|
|
||
|
|
<p>Deploy a web application directory or ".war" file located in your Host
|
||
|
|
appBase directory. The directory name or the war file name without the ".war"
|
||
|
|
extension is used as the path.</p>
|
||
|
|
|
||
|
|
<p>In this example the web application located in a sub directory named
|
||
|
|
<code>foo</code> in the Host appBase directory of the Tomcat server is
|
||
|
|
deployed as the web application context named <code>/foo</code>. Notice
|
||
|
|
that the context path used is the name of the web application directory.
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/deploy?war=foo
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>In this example the ".war" file <code>bar.war</code> located in your
|
||
|
|
Host appBase directory on the Tomcat server is deployed as the web
|
||
|
|
application context named <code>/bar</code>.
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/deploy?war=bar.war
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<h3>Deploy using a Context configuration ".xml" file</h3>
|
||
|
|
|
||
|
|
<p>If the Host deployXML flag is set to true you can deploy a web
|
||
|
|
application using a Context configuration ".xml" file and an optional
|
||
|
|
".war" file or web application directory. The context <code>path</code>
|
||
|
|
is not used when deploying a web application using a context ".xml"
|
||
|
|
configuration file.</p>
|
||
|
|
|
||
|
|
<p>A Context configuration ".xml" file can contain valid XML for a
|
||
|
|
web application Context just as if it were configured in your
|
||
|
|
Tomcat <code>server.xml</code> configuration file. Here is an
|
||
|
|
example:
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
<Context path="/foobar" docBase="/path/to/application/foobar"
|
||
|
|
debug="0">
|
||
|
|
|
||
|
|
<!-- Link to the user database we will get roles from -->
|
||
|
|
<ResourceLink name="users" global="UserDatabase"
|
||
|
|
type="org.apache.catalina.UserDatabase"/>
|
||
|
|
|
||
|
|
</Context>
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>When the optional <code>war</code> parameter is set to the URL
|
||
|
|
for a web application ".war" file or directory it overrides any
|
||
|
|
docBase configured in the context configuration ".xml" file.</p>
|
||
|
|
|
||
|
|
<p>Here is an example of deploying an application using a Context
|
||
|
|
configuration ".xml" file.
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/deploy?config=file:/path/context.xml
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>Here is an example of deploying an application using a Context
|
||
|
|
configuration ".xml" file and a web application ".war" file located
|
||
|
|
on the server.
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/deploy?config=file:/path/context.xml&war=jar:file:/path/bar.war!/
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<h3>Deployment Notes</h3>
|
||
|
|
|
||
|
|
<p>If the Host is configured with unpackWARs=true and you deploy a war
|
||
|
|
file, the war will be unpacked into a directory in your Host appBase
|
||
|
|
directory.</p>
|
||
|
|
|
||
|
|
<p>If the application war or directory is installed in your Host appBase
|
||
|
|
directory and either the Host is configured with autoDeploy=true or
|
||
|
|
liveDeploy=true, the Context path must match the directory name or
|
||
|
|
war file name without the ".war" extension.</p>
|
||
|
|
|
||
|
|
<p>For security when untrusted users can manage web applications, the
|
||
|
|
Host deployXML flag can be set to false. This prevents untrusted users
|
||
|
|
from deploying web applications using a configuration XML file and
|
||
|
|
also prevents them from deploying application directories or ".war"
|
||
|
|
files located outside of their Host appBase.</p>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Deploy Response</h3>
|
||
|
|
|
||
|
|
<p>If installation and startup is successful, you will receive a response
|
||
|
|
like this:</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
OK - Deployed application at context path /foo
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Otherwise, the response will start with <code>FAIL</code> and include an
|
||
|
|
error message. Possible causes for problems include:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>Application already exists at path /foo</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>The context paths for all currently running web applications must be
|
||
|
|
unique. Therefore, you must undeploy the existing web
|
||
|
|
application using this context path, or choose a different context path
|
||
|
|
for the new one. The <code>update</code> parameter may be specified as
|
||
|
|
a parameter on the URL, with a value of <code>true</code> to avoid this
|
||
|
|
error. In that case, an undeploy will be performed on an existing
|
||
|
|
application before performing the deployment.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Document base does not exist or is not a readable directory</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>The URL specified by the <code>war</code> parameter must identify a
|
||
|
|
directory on this server that contains the "unpacked" version of a
|
||
|
|
web application, or the absolute URL of a web application archive (WAR)
|
||
|
|
file that contains this application. Correct the value specified by
|
||
|
|
the <code>war</code> parameter.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Encountered exception</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>An exception was encountered trying to start the new web application.
|
||
|
|
Check the Tomcat 6 logs for the details, but likely explanations include
|
||
|
|
problems parsing your <code>/WEB-INF/web.xml</code> file, or missing
|
||
|
|
classes encountered when initializing application event listeners and
|
||
|
|
filters.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Invalid application URL was specified</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>The URL for the directory or web application that you specified
|
||
|
|
was not valid. Such URLs must start with <code>file:</code>, and URLs
|
||
|
|
for a WAR file must end in ".war".</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Invalid context path was specified</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>The context path must start with a slash character. To reference the
|
||
|
|
ROOT web application use "/".</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Context path must match the directory or WAR file name:</em>
|
||
|
|
<blockquote>
|
||
|
|
If the application war or directory is installed in your Host appBase
|
||
|
|
directory and either the Host is configured with autoDeploy=true or
|
||
|
|
liveDeploy=true, the Context path must match the directory name or
|
||
|
|
war file name without the ".war" extension.
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Only web applications in the Host web application directory can
|
||
|
|
be installed</em>
|
||
|
|
<blockquote>
|
||
|
|
If the Host deployXML flag is set to false this error will happen
|
||
|
|
if an attempt is made to deploy a web application directory or
|
||
|
|
".war" file outside of the Host appBase directory.
|
||
|
|
</blockquote></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="List Currently Deployed Applications"><strong>List Currently Deployed Applications</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/list
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>List the context paths, current status (<code>running</code> or
|
||
|
|
<code>stopped</code>), and number of active sessions for all currently
|
||
|
|
deployed web applications. A typical response immediately
|
||
|
|
after starting Tomcat might look like this:</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
OK - Listed applications for virtual host localhost
|
||
|
|
/webdav:running:0
|
||
|
|
/examples:running:0
|
||
|
|
/manager:running:0
|
||
|
|
/:running:0
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Reload An Existing Application"><strong>Reload An Existing Application</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/reload?path=/examples
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Signal an existing application to shut itself down and reload. This can
|
||
|
|
be useful when the web application context is not reloadable and you have
|
||
|
|
updated classes or property files in the <code>/WEB-INF/classes</code>
|
||
|
|
directory or when you have added or updated jar files in the
|
||
|
|
<code>/WEB-INF/lib</code> directory.
|
||
|
|
</p>
|
||
|
|
<p><strong>NOTE:</strong> The <code>/WEB-INF/web.xml</code>
|
||
|
|
web application configuration file is not reread on a reload.
|
||
|
|
If you have made changes to your web.xml file you must stop
|
||
|
|
then start the web application.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>If this command succeeds, you will see a response like this:</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
OK - Reloaded application at context path /examples
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Otherwise, the response will start with <code>FAIL</code> and include an
|
||
|
|
error message. Possible causes for problems include:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>Encountered exception</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>An exception was encountered trying to restart the web application.
|
||
|
|
Check the Tomcat 6 logs for the details.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Invalid context path was specified</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>The context path must start with a slash character. To reference the
|
||
|
|
ROOT web application use "/".</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>No context exists for path /foo</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>There is no deployed application on the context path
|
||
|
|
that you specified.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>No context path was specified</em>
|
||
|
|
<blockquote>
|
||
|
|
The <code>path</code> parameter is required.
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Reload not supported on WAR deployed at path /foo</em>
|
||
|
|
<blockquote>
|
||
|
|
Currently, application reloading (to pick up changes to the classes or
|
||
|
|
<code>web.xml</code> file) is not supported when a web application is
|
||
|
|
deployed directly from a WAR file. It only works when the web application
|
||
|
|
is deployed from an unpacked directory. If you are using a WAR file,
|
||
|
|
you should <code>undeploy</code> and then <code>deploy</code> or
|
||
|
|
<code>deploy</code> with the <code>update</code> parameter the
|
||
|
|
application again to pick up your changes.
|
||
|
|
</blockquote></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="List OS and JVM Properties"><strong>List OS and JVM Properties</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/serverinfo
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Lists information about the Tomcat version, OS, and JVM properties.</p>
|
||
|
|
|
||
|
|
<p>If an error occurs, the response will start with <code>FAIL</code> and
|
||
|
|
include an error message. Possible causes for problems include:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>Encountered exception</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>An exception was encountered trying to enumerate the system properties.
|
||
|
|
Check the Tomcat 6 logs for the details.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="List Available Global JNDI Resources"><strong>List Available Global JNDI Resources</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/resources[?type=xxxxx]
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>List the global JNDI resources that are available for use in resource
|
||
|
|
links for context configuration files. If you specify the <code>type</code>
|
||
|
|
request parameter, the value must be the fully qualified Java class name of
|
||
|
|
the resource type you are interested in (for example, you would specify
|
||
|
|
<code>javax.sql.DataSource</code> to acquire the names of all available
|
||
|
|
JDBC data sources). If you do not specify the <code>type</code> request
|
||
|
|
parameter, resources of all types will be returned.</p>
|
||
|
|
|
||
|
|
<p>Depending on whether the <code>type</code> request parameter is specfied
|
||
|
|
or not, the first line of a normal response will be:</p>
|
||
|
|
<pre>
|
||
|
|
OK - Listed global resources of all types
|
||
|
|
</pre>
|
||
|
|
<p>or</p>
|
||
|
|
<pre>
|
||
|
|
OK - Listed global resources of type xxxxx
|
||
|
|
</pre>
|
||
|
|
<p>followed by one line for each resource. Each line is composed of fields
|
||
|
|
delimited by colon characters (":"), as follows:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>Global Resource Name</em> - The name of this global JNDI resource,
|
||
|
|
which would be used in the <code>global</code> attribute of a
|
||
|
|
<code><ResourceLink></code> element.</li>
|
||
|
|
<li><em>Global Resource Type</em> - The fully qualified Java class name of
|
||
|
|
this global JNDI resource.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>If an error occurs, the response will start with <code>FAIL</code> and
|
||
|
|
include an error message. Possible causes for problems include:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>Encountered exception</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>An exception was encountered trying to enumerate the global JNDI
|
||
|
|
resources. Check the Tomcat 6 logs for the details.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>No global JNDI resources are available</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>The Tomcat server you are running has been configured without
|
||
|
|
global JNDI resources.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="List Available Security Roles"><strong>List Available Security Roles</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/roles
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>List the security role names (and corresponding descriptions) that are
|
||
|
|
available in the <code>org.apache.catalina.UserDatabase</code> resource that
|
||
|
|
is linked to the <code>users</code> resource reference in the web.xml file
|
||
|
|
for the Manager web application. This would typically be used, for example,
|
||
|
|
by a deployment tool that wanted to create
|
||
|
|
<code><security-role-ref></code> elements to map security role names
|
||
|
|
used in a web application to the role names actually defined within the
|
||
|
|
container.</p>
|
||
|
|
|
||
|
|
<p>By default, the <code>users</code> resource reference is pointed at the
|
||
|
|
global <code>UserDatabase</code> resource. If you choose to utilize a
|
||
|
|
different user database per virtual host, you should modify the
|
||
|
|
<code><ResourceLink></code> element in the default
|
||
|
|
<code>manager.xml</code> context configuration file to point at the global
|
||
|
|
user database resource for this virtual host.</p>
|
||
|
|
|
||
|
|
<p>When this command is executed, the first line of the response will be:</p>
|
||
|
|
<pre>
|
||
|
|
OK - Listed security roles
|
||
|
|
</pre>
|
||
|
|
<p>followed by one line for each security role. Each line is composed of
|
||
|
|
fields delimited by colon characters (":") as follows:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>Security Role Name</em> - A security role name that is known to Tomcat
|
||
|
|
in the user database.</li>
|
||
|
|
<li><em>Description</em> - Description of this security role (useful in
|
||
|
|
creating user interfaces for selecting roles.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>If an error occurs, the response will start with <code>FAIL</code> and
|
||
|
|
include an error message. Possible causes for problems include:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>Cannot resolve user database reference</em> - A JNDI error prevented
|
||
|
|
the successful lookup of the <code>org.apache.catalina.UserDatabase</code>
|
||
|
|
resource. Check the Tomcat log files for a stack trace associated with
|
||
|
|
this error.</li>
|
||
|
|
<li><em>No user database is available</em> - You have not configured a resource
|
||
|
|
reference for the <code>users</code> resource that points at an
|
||
|
|
appropriate user database instance. Check your <code>manager.xml</code>
|
||
|
|
file and ensure that you have created an appropriate
|
||
|
|
<code><ResourceLink></code> or
|
||
|
|
<code><ResourceParams></code> element for this resource.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Session Statistics"><strong>Session Statistics</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/sessions?path=/examples
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Display the default session timeout for a web application, and the
|
||
|
|
number of currently active sessions that fall within ten-minute ranges of
|
||
|
|
their actual timeout times. For example, after restarting Tomcat and then
|
||
|
|
executing one of the JSP samples in the <code>/examples</code> web app,
|
||
|
|
you might get something like this:</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
OK - Session information for application at context path /examples
|
||
|
|
Default maximum session inactive interval 30 minutes
|
||
|
|
30 - <40 minutes:1 sessions
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Start an Existing Application"><strong>Start an Existing Application</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/start?path=/examples
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Signal a stopped application to restart, and make itself available again.
|
||
|
|
Stopping and starting is useful, for example, if the database required by
|
||
|
|
your application becomes temporarily unavailable. It is usually better to
|
||
|
|
stop the web application that relies on this database rather than letting
|
||
|
|
users continuously encounter database exceptions.</p>
|
||
|
|
|
||
|
|
<p>If this command succeeds, you will see a response like this:</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
OK - Started application at context path /examples
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Otherwise, the response will start with <code>FAIL</code> and include an
|
||
|
|
error message. Possible causes for problems include:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>Encountered exception</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>An exception was encountered trying to start the web application.
|
||
|
|
Check the Tomcat 6 logs for the details.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Invalid context path was specified</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>The context path must start with a slash character. To reference the
|
||
|
|
ROOT web application use "/".</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>No context exists for path /foo</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>There is no deployed application on the context path
|
||
|
|
that you specified.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>No context path was specified</em>
|
||
|
|
<blockquote>
|
||
|
|
The <code>path</code> parameter is required.
|
||
|
|
</blockquote></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Stop an Existing Application"><strong>Stop an Existing Application</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/stop?path=/examples
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Signal an existing application to make itself unavailable, but leave it
|
||
|
|
deployed. Any request that comes in while an application is
|
||
|
|
stopped will see an HTTP error 404, and this application will show as
|
||
|
|
"stopped" on a list applications command.</p>
|
||
|
|
|
||
|
|
<p>If this command succeeds, you will see a response like this:</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
OK - Stopped application at context path /examples
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Otherwise, the response will start with <code>FAIL</code> and include an
|
||
|
|
error message. Possible causes for problems include:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>Encountered exception</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>An exception was encountered trying to stop the web application.
|
||
|
|
Check the Tomcat 6 logs for the details.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Invalid context path was specified</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>The context path must start with a slash character. To reference the
|
||
|
|
ROOT web application use "/".</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>No context exists for path /foo</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>There is no deployed application on the context path
|
||
|
|
that you specified.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>No context path was specified</em>
|
||
|
|
<blockquote>
|
||
|
|
The <code>path</code> parameter is required.
|
||
|
|
</blockquote></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Undeploy an Existing Application"><strong>Undeploy an Existing Application</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/undeploy?path=/examples
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p><strong><font color="red">WARNING</font> - This command will delete any web
|
||
|
|
application artifacts that exist within <code>appBase</code> directory
|
||
|
|
(typically "webapps") for this virtual host</strong>.
|
||
|
|
This will delete the the application .WAR, if present,
|
||
|
|
the application directory resulting either from a deploy in unpacked form
|
||
|
|
or from .WAR expansion as well as the XML Context definition from
|
||
|
|
<code>$CATALINA_HOME/conf/[enginename]/[hostname]/</code> directory.
|
||
|
|
If you simply want to take an application
|
||
|
|
out of service, you should use the <code>/stop</code> command instead.</p>
|
||
|
|
|
||
|
|
<p>Signal an existing application to gracefully shut itself down, and
|
||
|
|
remove it from Tomcat (which also makes this context path available for
|
||
|
|
reuse later). In addition, the document root directory is removed, if it
|
||
|
|
exists in the <code>appBase</code> directory (typically "webapps") for
|
||
|
|
this virtual host. This command is the logical opposite of the
|
||
|
|
<code>/deploy</code> command.</p>
|
||
|
|
|
||
|
|
<p>If this command succeeds, you will see a response like this:</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
OK - Undeployed application at context path /examples
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>Otherwise, the response will start with <code>FAIL</code> and include an
|
||
|
|
error message. Possible causes for problems include:</p>
|
||
|
|
<ul>
|
||
|
|
<li><em>Encountered exception</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>An exception was encountered trying to undeploy the web application.
|
||
|
|
Check the Tomcat 6 logs for the details.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>Invalid context path was specified</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>The context path must start with a slash character. To reference the
|
||
|
|
ROOT web application use "/".</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>No context exists for path /foo</em>
|
||
|
|
<blockquote>
|
||
|
|
<p>There is no deployed application on the context path
|
||
|
|
that you specified.</p>
|
||
|
|
</blockquote></li>
|
||
|
|
<li><em>No context path was specified</em>
|
||
|
|
<blockquote>
|
||
|
|
The <code>path</code> parameter is required.
|
||
|
|
</blockquote></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Executing Manager Commands With Ant"><strong>Executing Manager Commands With Ant</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>In addition to the ability to execute Manager commands via HTTP requests,
|
||
|
|
as documented above, Tomcat 6 includes a convenient set of Task definitions
|
||
|
|
for the <em>Ant</em> (version 1.4 or later) build tool. In order to use these
|
||
|
|
commands, you must perform the following setup operations:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Download the binary distribution of Ant from
|
||
|
|
<a href="http://ant.apache.org">http://ant.apache.org</a>.
|
||
|
|
You must use version <strong>1.4</strong> or later.</li>
|
||
|
|
<li>Install the Ant distribution in a convenient directory (called
|
||
|
|
ANT_HOME in the remainder of these instructions).</li>
|
||
|
|
<li>Copy the file <code>server/lib/catalina-ant.jar</code> from your Tomcat 6
|
||
|
|
installation into Ant's library directory (<code>$ANT_HOME/lib</code>).
|
||
|
|
</li>
|
||
|
|
<li>Add the <code>$ANT_HOME/bin</code> directory to your <code>PATH</code>
|
||
|
|
environment variable.</li>
|
||
|
|
<li>Configure at least one username/password combination in your Tomcat
|
||
|
|
user database that includes the <code>manager</code> role.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>To use custom tasks within Ant, you must declare them first with a
|
||
|
|
<code><taskdef></code> element. Therefore, your <code>build.xml</code>
|
||
|
|
file might look something like this:</p>
|
||
|
|
|
||
|
|
<table border="1">
|
||
|
|
<tr><td><pre>
|
||
|
|
<project name="My Application" default="compile" basedir=".">
|
||
|
|
|
||
|
|
<!-- Configure the directory into which the web application is built -->
|
||
|
|
<property name="build" value="${basedir}/build"/>
|
||
|
|
|
||
|
|
<!-- Configure the context path for this application -->
|
||
|
|
<property name="path" value="/myapp"/>
|
||
|
|
|
||
|
|
<!-- Configure properties to access the Manager application -->
|
||
|
|
<property name="url" value="http://localhost:8080/manager"/>
|
||
|
|
<property name="username" value="myusername"/>
|
||
|
|
<property name="password" value="mypassword"/>
|
||
|
|
|
||
|
|
<!-- Configure the custom Ant tasks for the Manager application -->
|
||
|
|
<taskdef name="deploy" classname="org.apache.catalina.ant.DeployTask"/>
|
||
|
|
<taskdef name="list" classname="org.apache.catalina.ant.ListTask"/>
|
||
|
|
<taskdef name="reload" classname="org.apache.catalina.ant.ReloadTask"/>
|
||
|
|
<taskdef name="resources" classname="org.apache.catalina.ant.ResourcesTask"/>
|
||
|
|
<taskdef name="roles" classname="org.apache.catalina.ant.RolesTask"/>
|
||
|
|
<taskdef name="start" classname="org.apache.catalina.ant.StartTask"/>
|
||
|
|
<taskdef name="stop" classname="org.apache.catalina.ant.StopTask"/>
|
||
|
|
<taskdef name="undeploy" classname="org.apache.catalina.ant.UndeployTask"/>
|
||
|
|
|
||
|
|
<!-- Executable Targets -->
|
||
|
|
<target name="compile" description="Compile web application">
|
||
|
|
<!-- ... construct web application in ${build} subdirectory, and
|
||
|
|
generated a ${path}.war ... -->
|
||
|
|
</target>
|
||
|
|
|
||
|
|
<target name="deploy" description="Install web application"
|
||
|
|
depends="compile">
|
||
|
|
<deploy url="${url}" username="${username}" password="${password}"
|
||
|
|
path="${path}" war="file:${build}${path}.war"/>
|
||
|
|
</target>
|
||
|
|
|
||
|
|
<target name="reload" description="Reload web application"
|
||
|
|
depends="compile">
|
||
|
|
<reload url="${url}" username="${username}" password="${password}"
|
||
|
|
path="${path}"/>
|
||
|
|
</target>
|
||
|
|
|
||
|
|
<target name="undeploy" description="Remove web application">
|
||
|
|
<undeploy url="${url}" username="${username}" password="${password}"
|
||
|
|
path="${path}"/>
|
||
|
|
</target>
|
||
|
|
|
||
|
|
</project>
|
||
|
|
</pre></td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>Now, you can execute commands like <code>ant deploy</code> to deploy the
|
||
|
|
application to a running instance of Tomcat, or <code>ant reload</code> to
|
||
|
|
tell Tomcat to reload it. Note also that most of the interesting values in
|
||
|
|
this <code>build.xml</code> file are defined as replaceable properties, so
|
||
|
|
you can override their values from the command line. For example, you might
|
||
|
|
consider it a security risk to include the real manager password in your
|
||
|
|
<code>build.xml</code> file's source code. To avoid this, omit the password
|
||
|
|
property, and specify it from the command line:</p>
|
||
|
|
<pre>
|
||
|
|
ant -Dpassword=secret deploy
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Tasks output capture"><strong>Tasks output capture</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>Using <em>Ant</em> version <strong>1.6.2</strong> or later,
|
||
|
|
the Catalina tasks offer the option to capture their output in
|
||
|
|
properties or external files. They support directly the following subset of the
|
||
|
|
<code><redirector></code> type attributes:
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><b>Attribute</b></td>
|
||
|
|
<td valign="top"><b>Description</b></td>
|
||
|
|
<td align="center" valign="top"><b>Required</b></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">output</td>
|
||
|
|
<td valign="top">Name of a file to which to write the output. If
|
||
|
|
the error stream is not also redirected to a file or property, it will
|
||
|
|
appear in this output.</td>
|
||
|
|
<td align="center" valign="top">No</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">error</td>
|
||
|
|
<td valign="top">The file to which the standard error of the
|
||
|
|
command should be redirected.</td>
|
||
|
|
<td align="center" valign="top">No</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">logError</td>
|
||
|
|
<td valign="top">This attribute is used when you wish to see
|
||
|
|
error output in Ant's log and you are redirecting output to a
|
||
|
|
file/property. The error output will not be included in the output
|
||
|
|
file/property. If you redirect error with the <i>error</i> or <i>errorProperty</i>
|
||
|
|
attributes, this will have no effect.</td>
|
||
|
|
<td align="center" valign="top">No</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">append</td>
|
||
|
|
<td valign="top">Whether output and error files should be
|
||
|
|
appended to or overwritten. Defaults to <code>false</code>.</td>
|
||
|
|
<td align="center" valign="top">No</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">createemptyfiles</td>
|
||
|
|
<td valign="top">Whether output and error files should be created
|
||
|
|
even when empty. Defaults to <code>true</code>.</td>
|
||
|
|
<td align="center" valign="top">No</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">outputproperty</td>
|
||
|
|
<td valign="top">The name of a property in which the output of
|
||
|
|
the command should be stored. Unless the error stream is redirected to
|
||
|
|
a separate file or stream, this property will include the error output.</td>
|
||
|
|
<td align="center" valign="top">No</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">errorproperty</td>
|
||
|
|
<td valign="top">The name of a property in which the standard
|
||
|
|
error of the command should be stored.</td>
|
||
|
|
<td align="center" valign="top">No</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>A couple of additional attributes can also be specified:
|
||
|
|
</p>
|
||
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><b>Attribute</b></td>
|
||
|
|
<td valign="top"><b>Description</b></td>
|
||
|
|
<td align="center" valign="top"><b>Required</b></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">alwaysLog</td>
|
||
|
|
<td valign="top">This attribute is used when you wish to see the
|
||
|
|
output you are capturing, appearing also in the Ant's log. It must not be
|
||
|
|
used unless you are capturing task output.
|
||
|
|
Defaults to <code>false</code>.
|
||
|
|
<em>This attribute will be supported directly by <code><redirector></code>
|
||
|
|
in Ant 1.6.3</em></td>
|
||
|
|
<td align="center" valign="top">No</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">failonerror</td>
|
||
|
|
<td valign="top">This attribute is used when you wish to avoid that
|
||
|
|
any manager command processing error terminates the ant execution. Defaults to <code>true</code>.
|
||
|
|
It must be set to <code>false</code>, if you want to capture error output,
|
||
|
|
otherwise execution will terminate before anything can be captured.
|
||
|
|
<br>
|
||
|
|
This attribute acts only on manager command execution,
|
||
|
|
any wrong or missing command attribute will still cause Ant execution termination.
|
||
|
|
</td>
|
||
|
|
<td align="center" valign="top">No</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>They also support the embedded <code><redirector></code> element
|
||
|
|
in which you can specify
|
||
|
|
its full set of attributes, but <code>input</code>, <code>inputstring</code> and
|
||
|
|
<code>inputencoding</code> that, even if accepted, are not used because they have
|
||
|
|
no meaning in this context.
|
||
|
|
Refer to <a href="http://ant.apache.org">ant manual</a> for details on
|
||
|
|
<code><redirector></code> element attributes.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Here is a sample build file extract that shows how this output redirection support
|
||
|
|
can be used:
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<table border="1">
|
||
|
|
<tr><td><pre>
|
||
|
|
<target name="manager.deploy"
|
||
|
|
depends="context.status"
|
||
|
|
if="context.notInstalled">
|
||
|
|
<deploy url="${mgr.url}"
|
||
|
|
username="${mgr.username}"
|
||
|
|
password="${mgr.password}"
|
||
|
|
path="${mgr.context.path}"
|
||
|
|
config="${mgr.context.descriptor}"/>
|
||
|
|
</target>
|
||
|
|
|
||
|
|
<target name="manager.deploy.war"
|
||
|
|
depends="context.status"
|
||
|
|
if="context.deployable">
|
||
|
|
<deploy url="${mgr.url}"
|
||
|
|
username="${mgr.username}"
|
||
|
|
password="${mgr.password}"
|
||
|
|
update="${mgr.update}"
|
||
|
|
path="${mgr.context.path}"
|
||
|
|
war="${mgr.war.file}"/>
|
||
|
|
</target>
|
||
|
|
|
||
|
|
<target name="context.status">
|
||
|
|
<property name="running" value="${mgr.context.path}:running"/>
|
||
|
|
<property name="stopped" value="${mgr.context.path}:stopped"/>
|
||
|
|
|
||
|
|
<list url="${mgr.url}"
|
||
|
|
outputproperty="ctx.status"
|
||
|
|
username="${mgr.username}"
|
||
|
|
password="${mgr.password}">
|
||
|
|
</list>
|
||
|
|
|
||
|
|
<condition property="context.running">
|
||
|
|
<contains string="${ctx.status}" substring="${running}"/>
|
||
|
|
</condition>
|
||
|
|
<condition property="context.stopped">
|
||
|
|
<contains string="${ctx.status}" substring="${stopped}"/>
|
||
|
|
</condition>
|
||
|
|
<condition property="context.notInstalled">
|
||
|
|
<and>
|
||
|
|
<isfalse value="${context.running}"/>
|
||
|
|
<isfalse value="${context.stopped}"/>
|
||
|
|
</and>
|
||
|
|
</condition>
|
||
|
|
<condition property="context.deployable">
|
||
|
|
<or>
|
||
|
|
<istrue value="${context.notInstalled}"/>
|
||
|
|
<and>
|
||
|
|
<istrue value="${context.running}"/>
|
||
|
|
<istrue value="${mgr.update}"/>
|
||
|
|
</and>
|
||
|
|
<and>
|
||
|
|
<istrue value="${context.stopped}"/>
|
||
|
|
<istrue value="${mgr.update}"/>
|
||
|
|
</and>
|
||
|
|
</or>
|
||
|
|
</condition>
|
||
|
|
<condition property="context.undeployable">
|
||
|
|
<or>
|
||
|
|
<istrue value="${context.running}"/>
|
||
|
|
<istrue value="${context.stopped}"/>
|
||
|
|
</or>
|
||
|
|
</condition>
|
||
|
|
</target>
|
||
|
|
</pre></td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>WARNING:</strong> even if it doesn't make many sense, and is always a bad idea,
|
||
|
|
calling a Catalina task more than once,
|
||
|
|
badly set Ant tasks depends chains may cause that a task be called
|
||
|
|
more than once in the same Ant run, even if not intended to. A bit of caution should be exercised when you are
|
||
|
|
capturing output from that task, because this could lead to something unexpected:
|
||
|
|
<ul>
|
||
|
|
<li>when capturing in a property you will find in it only the output from the <em>first</em> call, because
|
||
|
|
Ant properties are immutable and once set they cannot be changed,
|
||
|
|
</li>
|
||
|
|
<li>when capturing in a file, each run will overwrite it and you will find in it only the <em>last</em> call
|
||
|
|
output, unless you are using the <code>append="true"</code> attribute, in which case you will
|
||
|
|
see the output of each task call appended to the file.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Using the JMX Proxy Servlet"><strong>Using the JMX Proxy Servlet</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="What is JMX Proxy Servlet"><strong>What is JMX Proxy Servlet</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
The JMX Proxy Servlet is a lightweight proxy to get and set the
|
||
|
|
tomcat internals. (Or any class that has been exposed via an MBean)
|
||
|
|
Its usage is not very user friendly but the UI is
|
||
|
|
extremely help for integrating command line scripts for monitoring
|
||
|
|
and changing the internals of tomcat. You can do two things with the proxy:
|
||
|
|
get information and set information. For you to really understand the
|
||
|
|
JMX Proxy Servlet, you should have a general understanding of JMX.
|
||
|
|
If you don't know what JMX is, then prepare to be confused.
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JMX Query command"><strong>JMX Query command</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
This takes the form:
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://webserver/manager/jmxproxy/?qry=STUFF
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
Where <code>STUFF</code> is the JMX query you wish to perform. For example,
|
||
|
|
here are some queries you might wish to run:
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<code>qry=*%3Atype%3DRequestProcessor%2C* -->
|
||
|
|
type=RequestProcessor</code> which will locate all
|
||
|
|
workers which can process requests and report
|
||
|
|
their state.
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<code>qry=*%3Aj2eeType=Servlet%2c* -->
|
||
|
|
j2eeType=Servlet</code> which return all loaded servlets.
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<code>qry=Catalina%3Atype%3DEnvironment%2Cresourcetype%3DGlobal%2Cname%3DsimpleValue -->
|
||
|
|
Catalina:type=Environment,resourcetype=Global,name=simpleValue</code>
|
||
|
|
which look for a specific MBean by the given name.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
You'll need to experiment with this to really understand its capabilites.
|
||
|
|
If you provide no <code>qry</code> parameter, then all of the MBeans will
|
||
|
|
be displayed. We really recommend looking at the tomcat source code and
|
||
|
|
understand the JMX spec to get a better understanding of all the queries
|
||
|
|
you may run.
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JMX Set command"><strong>JMX Set command</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
Now that you can query an MBean, its time to muck with Tomcat's internals!
|
||
|
|
The general form of the set command is :
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://webserver/manager/jmxproxy/?set=BEANNAME&att=MYATTRIBUTE&val=NEWVALUE
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
So you need to provide 3 request parameters:
|
||
|
|
<ol>
|
||
|
|
<li><code>set</code>: The full bean name</li>
|
||
|
|
<li><code>att</code>: The attribute you wish to alter</li>
|
||
|
|
<li><code>val</code>: The new value </li>
|
||
|
|
</ol>
|
||
|
|
If all goes ok, then it will say OK, otherwise an error message will be
|
||
|
|
shown. For example, lets say we wish to turn up debugging on the fly for the
|
||
|
|
<code>ErrorReportValve</code>. The following will set debugging to 10.
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/jmxproxy/
|
||
|
|
?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost&att=debug&val=10
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
and my result is (YMMV):
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
Result: ok
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
Here is what I see if I pass in a bad value. Here is the URL I used,
|
||
|
|
I try set debugging equal to 'cowbell':
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
http://localhost:8080/manager/jmxproxy/
|
||
|
|
?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost&att=debug&val=cowbell
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
When I try that, my result is
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
Error: java.lang.NumberFormatException: For input string: "cowbell"
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
|
||
|
|
</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
|
||
|
|
Copyright © 1999-2006, Apache Software Foundation
|
||
|
|
</em></font></div></td></tr></table></body></html>
|