增加初始版本
diff --git a/webapps/docs/manager-howto.html b/webapps/docs/manager-howto.html
new file mode 100644
index 0000000..7804a1c
--- /dev/null
+++ b/webapps/docs/manager-howto.html
@@ -0,0 +1,1363 @@
+<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.42) - Manager App HOW-TO</title><meta name="author" content="Craig R. McClanahan"><style type="text/css" media="print">

+            .noPrint {display: none;}

+            td#mainBody {width: 100%;}

+        </style><style type="text/css">

+            code {background-color:rgb(224,255,255);padding:0 0.1em;}

+            code.attributeName, code.propertyName {background-color:transparent;}

+        </style><style type="text/css">

+            .wrapped-source code { display: block; background-color: transparent; }

+            .wrapped-source div { margin: 0 0 0 1.25em; }

+            .wrapped-source p { margin: 0 0 0 1.25em; text-indent: -1.25em; }

+        </style><style type="text/css">

+            p.notice {

+                border: 1px solid rgb(255, 0, 0);

+                background-color: rgb(238, 238, 238);

+                color: rgb(0, 51, 102);

+                padding: 0.5em;

+                margin: 1em 2em 1em 1em;

+            }

+        </style></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><h1><font face="arial,helvetica,sanserif">Apache Tomcat 7</font></h1><font face="arial,helvetica,sanserif">Version 7.0.42, Jul 2 2013</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 size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap class="noPrint"><p><strong>Links</strong></p><ul><li><a href="index.html">Docs Home</a></li><li><a href="http://wiki.apache.org/tomcat/FAQ">FAQ</a></li><li><a href="#comments_section">User Comments</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/Native</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><li><a href="security-howto.html">28) Security Considerations</a></li><li><a href="windows-service-howto.html">29) Windows Service</a></li><li><a href="windows-auth-howto.html">30) Windows Authentication</a></li><li><a href="jdbc-pool.html">31) Tomcat's JDBC Pool</a></li><li><a href="web-socket-howto.html">32) WebSocket</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">Tomcat Javadocs</a></li><li><a href="servletapi/index.html">Servlet Javadocs</a></li><li><a href="jspapi/index.html">JSP 2.2 Javadocs</a></li><li><a href="elapi/index.html">EL 2.2 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="http://wiki.apache.org/tomcat/TomcatVersions">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><li><a href="tribes/introduction.html">Tribes</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Manager App HOW-TO</h1><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote>

+<ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Configuring_Manager_Application_Access">Configuring Manager Application Access</a></li><li><a href="#Supported_Manager_Commands">Supported Manager Commands</a><ol><li><a href="#Deploy_A_New_Application_Remotely">Deploy A New Application Remotely</a></li><li><a href="#Deploy_A_New_Application_from_a_Local_Path">Deploy A New Application from a Local Path</a></li><li><a href="#List_Currently_Deployed_Applications">List Currently Deployed Applications</a></li><li><a href="#Reload_An_Existing_Application">Reload An Existing Application</a></li><li><a href="#List_OS_and_JVM_Properties">List OS and JVM Properties</a></li><li><a href="#List_Available_Global_JNDI_Resources">List Available Global JNDI Resources</a></li><li><a href="#Session_Statistics">Session Statistics</a></li><li><a href="#Start_an_Existing_Application">Start an Existing Application</a></li><li><a href="#Stop_an_Existing_Application">Stop an Existing Application</a></li><li><a href="#Undeploy_an_Existing_Application">Undeploy an Existing Application</a></li><li><a href="#Finding_memory_leaks">Finding memory leaks</a></li><li><a href="#Server_Status">Server Status</a></li></ol></li><li><a href="#Executing_Manager_Commands_With_Ant">Executing Manager Commands With Ant</a><ol><li><a href="#Tasks_output_capture">Tasks output capture</a></li></ol></li><li><a href="#Using_the_JMX_Proxy_Servlet">Using the JMX Proxy Servlet</a><ol><li><a href="#What_is_JMX_Proxy_Servlet">What is JMX Proxy Servlet</a></li><li><a href="#JMX_Query_command">JMX Query command</a></li><li><a href="#JMX_Get_command">JMX Get command</a></li><li><a href="#JMX_Set_command">JMX Set command</a></li><li><a href="#JMX_Invoke_command">JMX Invoke command</a></li></ol></li></ul>

+</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 server

+configuration file.</p>

+

+<p>To support these capabilities, Tomcat 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>&lt;ResourceLink&gt;</code> elements

+    nested in a <code>&lt;Context&gt;</code> deployment description.</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_BASE/conf/[enginename]/[hostname]</code> folder. Here is an

+example:</p>

+<pre>

+&lt;Context privileged="true" antiResourceLocking="false"

+         docBase="${catalina.home}/webapps/manager"&gt;

+  &lt;Valve className="org.apache.catalina.valves.RemoteAddrValve"

+         allow="127\.0\.0\.1" /&gt;

+&lt;/Context&gt;

+</pre>

+

+<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 <strong>Manager</strong> web application.</p>

+<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>

+

+</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"><!--()--></a><a name="Configuring_Manager_Application_Access"><strong>Configuring Manager Application Access</strong></a></font></td></tr><tr><td><blockquote>

+

+    <blockquote>

+    <p><em>The description below uses the variable name $CATALINA_BASE to refer the

+    base directory against which most relative paths are resolved. If you have

+    not configured Tomcat for multiple instances by setting a CATALINA_BASE

+    directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,

+    the directory into which you have installed Tomcat.</em></p>

+    </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 one of <strong>manager-**</strong> roles associated with

+them (the role name depends on what functionality is required).

+Further, there is no username in the default users file

+(<code>$CATALINA_BASE/conf/tomcat-users.xml</code>) that is assigned to those

+roles.  Therefore, access to the Manager application is completely disabled

+by default.</p>

+

+<p>You can find the role names in the <code>web.xml</code> file of the Manager

+web application. The available roles are:</p>

+

+<ul>

+  <li><strong>manager-gui</strong> &mdash; Access to the HTML interface.</li>

+  <li><strong>manager-status</strong> &mdash; Access to the "Server Status"

+    page only.</li>

+  <li><strong>manager-script</strong> &mdash; Access to the tools-friendly

+    plain text interface that is described in this document,

+    and to the "Server Status" page.</li>

+  <li><strong>manager-jmx</strong> &mdash; Access to JMX proxy interface

+    and to the "Server Status" page.</li>

+</ul>

+

+<p>The HTML interface is protected against CSRF (Cross-Site Request Forgery)

+attacks, but the text and JMX interfaces cannot be protected. To maintain

+the CSRF protection:</p>

+

+<ul>

+  <li>Users with the <strong>manager-gui</strong> role should not be granted

+      the <strong>manager-script</strong> or <strong>manager-jmx</strong>

+      roles.</li>

+  <li>If you use web browser to access the Manager application using

+      a user that has either <strong>manager-script</strong> or

+      <strong>manager-jmx</strong> roles (for example for testing

+      the plain text or JMX interfaces),

+      then all windows of the browser MUST be closed afterwards to terminate

+      the session.</li>

+</ul>

+

+<p>Note that JMX proxy interface is effectively low-level root-like

+administrative interface of Tomcat. One can do a lot, if he knows

+what commands to call. You should be cautious when enabling the

+<strong>manager-jmx</strong> role.</p>

+

+<p>To enable access to the Manager web application, you must either create

+a new username/password combination and associate one of the

+<strong>manager-**</strong> roles with it, or add a

+<strong>manager-**</strong> role

+to some existing username/password combination.

+As the majority of this document describes the commands of plain textual

+interface, let the role name for further example to be

+<strong>manager-script</strong>.

+Exactly how the usernames/passwords are configured depends on which

+<code>Realm</code> implementation you are using:</p>

+<ul>

+<li><em>MemoryRealm</em> &mdash; This one is configured in the default

+    <code>$CATALINA_BASE/conf/server.xml</code>.

+    If you have not configured it differently, or replaced it with

+    a different <code>Realm</code> implementation, this realm

+    reads an XML-format file stored at

+    <code>$CATALINA_BASE/conf/tomcat-users.xml</code>, which can be

+    edited with any text editor.  This file contains an XML

+    <code>&lt;user&gt;</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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+&lt;user name="craigmcc" password="secret" roles="standard,manager-script" /&gt;

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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-script</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> &mdash; Your user and role information is stored in

+    a database accessed via JDBC.  Add the <strong>manager-script</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> &mdash; Your user and role information is stored in

+    a directory server accessed via LDAP.  Add the

+    <strong>manager-script</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-script</strong>.</p>

+

+<p>In addition to the password restrictions the Manager web application

+could be restricted by the <strong>remote IP address</strong> or host by adding

+a <code>RemoteAddrValve</code> or <code>RemoteHostValve</code>.

+See <a href="config/valve.html#Remote_Address_Filter">valves documentation</a>

+for details. Here is

+an example of restricting access to the localhost by IP address:</p>

+<pre>

+&lt;Context privileged="true"&gt;

+         &lt;Valve className="org.apache.catalina.valves.RemoteAddrValve"

+                allow="127\.0\.0\.1"/&gt;

+&lt;/Context&gt;

+</pre>

+

+</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"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://{host}:{port}/manager/text/{command}?{parameters}

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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>version</strong> - The version of this web application as used by

+    the parallel deployment feature,</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

+        application 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 will 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>

+

+<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"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/deploy?path=/foo

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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:</p>

+<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 tag or label. If the web application is undeployed,

+    it can be later redeployed when needed using only the tag.</li>

+</ul>

+

+<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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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 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"><!--()--></a><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 previously deployed webapp</h3>

+

+<p>This can be used to deploy a previously deployed 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.</p>

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/deploy?path=/footoo&amp;tag=footag

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+

+<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>.</p>

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/deploy?path=/footoo&amp;war=file:/path/to/foo

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+

+<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.</p>

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/deploy?war=jar:file:/path/to/bar.war!/

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+

+<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.</p>

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/deploy?war=foo

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+

+<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>.</p>

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/deploy?war=bar.war

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+

+<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:</p>

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+&lt;Context path="/foobar" docBase="/path/to/application/foobar"&gt;

+&lt;/Context&gt;

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+

+<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.</p>

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/deploy?config=file:/path/context.xml

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+

+<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.</p>

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/deploy

+ ?config=file:/path/context.xml&amp;war=jar:file:/path/bar.war!/

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+

+<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 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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 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 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"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/list

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/reload?path=/examples

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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 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"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/serverinfo

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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 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"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/resources[?type=xxxxx]

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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 specified

+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>&lt;ResourceLink&gt;</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 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="Session Statistics"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/sessions?path=/examples

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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 - &lt;40 minutes:1 sessions

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/start?path=/examples

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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 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"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/stop?path=/examples

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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 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"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/undeploy?path=/examples

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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_BASE/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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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 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="Finding memory leaks"><!--()--></a><a name="Finding_memory_leaks"><strong>Finding memory leaks</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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/text/findleaks[?statusLine=[true|false]]

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+<p><strong>The find leaks diagnostic triggers a full garbage collection. It

+should be used with extreme caution on production systems.</strong></p>

+

+<p>The find leaks diagnostic attempts to identify web applications that have

+caused memory leaks when they were stopped, reloaded or undeployed. Results

+should always be confirmed

+with a profiler. The diagnostic uses additional functionality provided by the

+StandardHost implementation. It will not work if a custom host is used that

+does not extend StandardHost.</p>

+

+<p>Explicitly triggering a full garbage collection from Java code is documented

+to be unreliable. Furthermore, depending on the JVM used, there are options to

+disable explicit GC triggering, like <code>-XX:+DisableExplicitGC</code>.

+If you want to make sure, that the diagnostics were successfully running a full

+GC, you will need to check using tools like GC logging, JConsole or similar.</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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+/leaking-webapp

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+<p>If you wish to see a status line included in the response then include the

+<code>statusLine</code> query parameter in the request with a value of

+<code>true</code>.</p>

+

+<p>Each context path for a web application that was stopped, reloaded or

+undeployed, but which classes from the previous runs are still loaded in memory,

+thus causing a memory leak, will be listed on a new line. If an application

+has been reloaded several times, it may be listed several times.</p>

+

+<p>If the command does not succeed, the response will start with

+<code>FAIL</code> and include an error message.</p>

+

+</blockquote></td></tr></table>

+

+<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Server Status"><!--()--></a><a name="Server_Status"><strong>Server Status</strong></a></font></td></tr><tr><td><blockquote>

+

+<p>From this link , you can view information about the server.</p>

+

+<p>First, you have the server and JVM version number, JVM provider, OS name

+and number followed by the architecture type.</p>

+

+<p>Second, there is several information about the memory usage of the JVM

+(available, total and max memory).</p>

+

+<p>Then, there is information about the Tomcat AJP and HTTP connectors.

+The same information is available for both of them :

+</p>

+<ul>

+    <li><p>Threads information : Max threads, min and max spare threads,

+    current thread count and current thread busy.</p></li>

+    <li><p>Request information : Max processing time and processing time,

+    request and error count, bytes received and sent.</p></li>

+    <li><p>A table showing Stage, Time, Bytes Sent, Bytes Receive, Client,

+    VHost and Request. All existing threads are listed in the table.

+    Here is the list of the possible thread stages :</p>

+    <ul>

+        <li><p><em>"Parse and Prepare Request"</em> : The request headers are

+        being parsed or the necessary preparation to read the request body (if

+        a transfer encoding has been specified) is taking place.</p></li>

+        <li><p><em>"Service"</em> : The thread is processing a request and

+        generating the response. This stage follows the "Parse and Prepare

+        Request" stage and precedes the "Finishing" stage. There is always at

+        least one thread in this stage (the server-status page).</p></li>

+        <li><p><em>"Finishing"</em> : The end of the request processing. Any

+        remainder of the response still in the output buffers is sent to the

+        client. This stage is followed by "Keep-Alive" if it is appropriate to

+        keep the connection alive or "Ready" if "Keep-Alive" is not

+        appropriate.</p></li>

+        <li><p><em>"Keep-Alive"</em> : The thread keeps the connection open to

+        the client in case the client sends another request. If another request

+        is received, the next stage will br "Parse and Prepare Requst". If no

+        request is received before the keep alive times out, the connection will

+        be closed and the next stage will be "Ready".</p></li>

+        <li><p><em>"Ready"</em> : The thread is at rest and ready to be

+        used.</p></li>

+    </ul>

+    </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"><!--()--></a><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 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

+    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-script</code> role.</li>

+</ul>

+

+<p>To use custom tasks within Ant, you must declare them first with a

+<code>&lt;taskdef&gt;</code> element.  Therefore, your <code>build.xml</code>

+file might look something like this:</p>

+

+<table border="1">

+<tr><td><pre>

+&lt;project name="My Application" default="compile" basedir="."&gt;

+

+  &lt;!-- Configure the directory into which the web application is built --&gt;

+  &lt;property name="build"    value="${basedir}/build"/&gt;

+

+  &lt;!-- Configure the context path for this application --&gt;

+  &lt;property name="path"     value="/myapp"/&gt;

+

+  &lt;!-- Configure properties to access the Manager application --&gt;

+  &lt;property name="url"      value="http://localhost:8080/manager/text"/&gt;

+  &lt;property name="username" value="myusername"/&gt;

+  &lt;property name="password" value="mypassword"/&gt;

+

+  &lt;!-- Configure the custom Ant tasks for the Manager application --&gt;

+  &lt;taskdef name="deploy"    classname="org.apache.catalina.ant.DeployTask"/&gt;

+  &lt;taskdef name="list"      classname="org.apache.catalina.ant.ListTask"/&gt;

+  &lt;taskdef name="reload"    classname="org.apache.catalina.ant.ReloadTask"/&gt;

+  &lt;taskdef name="findleaks" classname="org.apache.catalina.ant.FindLeaksTask"/&gt;

+  &lt;taskdef name="resources" classname="org.apache.catalina.ant.ResourcesTask"/&gt;

+  &lt;taskdef name="start"     classname="org.apache.catalina.ant.StartTask"/&gt;

+  &lt;taskdef name="stop"      classname="org.apache.catalina.ant.StopTask"/&gt;

+  &lt;taskdef name="undeploy"  classname="org.apache.catalina.ant.UndeployTask"/&gt;

+

+  &lt;!-- Executable Targets --&gt;

+  &lt;target name="compile" description="Compile web application"&gt;

+    &lt;!-- ... construct web application in ${build} subdirectory, and

+            generated a ${path}.war ... --&gt;

+  &lt;/target&gt;

+

+  &lt;target name="deploy" description="Install web application"

+          depends="compile"&gt;

+    &lt;deploy url="${url}" username="${username}" password="${password}"

+            path="${path}" war="file:${build}${path}.war"/&gt;

+  &lt;/target&gt;

+

+  &lt;target name="reload" description="Reload web application"

+          depends="compile"&gt;

+    &lt;reload  url="${url}" username="${username}" password="${password}"

+            path="${path}"/&gt;

+  &lt;/target&gt;

+

+  &lt;target name="undeploy" description="Remove web application"&gt;

+    &lt;undeploy url="${url}" username="${username}" password="${password}"

+            path="${path}"/&gt;

+  &lt;/target&gt;

+

+&lt;/project&gt;

+</pre></td></tr>

+</table>

+

+<p>Note: The definition of the resources task above will override the resources

+datatype added in Ant 1.7. If you wish to use the resources datatype you will

+need to use Ant's namespace support to assign the Tomcat tasks to their own

+namespace.</p>

+

+<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"><!--()--></a><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>&lt;redirector&gt;</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>&lt;redirector&gt;</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>&lt;redirector&gt;</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>&lt;redirector&gt;</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>

+    &lt;target name="manager.deploy"

+        depends="context.status"

+        if="context.notInstalled"&gt;

+        &lt;deploy url="${mgr.url}"

+            username="${mgr.username}"

+            password="${mgr.password}"

+            path="${mgr.context.path}"

+            config="${mgr.context.descriptor}"/&gt;

+    &lt;/target&gt;

+

+    &lt;target name="manager.deploy.war"

+        depends="context.status"

+        if="context.deployable"&gt;

+        &lt;deploy url="${mgr.url}"

+            username="${mgr.username}"

+            password="${mgr.password}"

+            update="${mgr.update}"

+            path="${mgr.context.path}"

+            war="${mgr.war.file}"/&gt;

+    &lt;/target&gt;

+

+    &lt;target name="context.status"&gt;

+        &lt;property name="running" value="${mgr.context.path}:running"/&gt;

+        &lt;property name="stopped" value="${mgr.context.path}:stopped"/&gt;

+

+        &lt;list url="${mgr.url}"

+            outputproperty="ctx.status"

+            username="${mgr.username}"

+            password="${mgr.password}"&gt;

+        &lt;/list&gt;

+

+        &lt;condition property="context.running"&gt;

+            &lt;contains string="${ctx.status}" substring="${running}"/&gt;

+        &lt;/condition&gt;

+        &lt;condition property="context.stopped"&gt;

+            &lt;contains string="${ctx.status}" substring="${stopped}"/&gt;

+        &lt;/condition&gt;

+        &lt;condition property="context.notInstalled"&gt;

+            &lt;and&gt;

+                &lt;isfalse value="${context.running}"/&gt;

+                &lt;isfalse value="${context.stopped}"/&gt;

+            &lt;/and&gt;

+        &lt;/condition&gt;

+        &lt;condition property="context.deployable"&gt;

+            &lt;or&gt;

+                &lt;istrue value="${context.notInstalled}"/&gt;

+                &lt;and&gt;

+                    &lt;istrue value="${context.running}"/&gt;

+                    &lt;istrue value="${mgr.update}"/&gt;

+                &lt;/and&gt;

+                &lt;and&gt;

+                    &lt;istrue value="${context.stopped}"/&gt;

+                    &lt;istrue value="${mgr.update}"/&gt;

+                &lt;/and&gt;

+            &lt;/or&gt;

+        &lt;/condition&gt;

+        &lt;condition property="context.undeployable"&gt;

+            &lt;or&gt;

+                &lt;istrue value="${context.running}"/&gt;

+                &lt;istrue value="${context.stopped}"/&gt;

+            &lt;/or&gt;

+        &lt;/condition&gt;

+    &lt;/target&gt;

+</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:</p>

+<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>

+

+</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"><!--()--></a><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"><!--()--></a><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"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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* --&gt;

+         type=RequestProcessor</code> which will locate all

+         workers which can process requests and report

+         their state.

+      </li>

+      <li>

+        <code>qry=*%3Aj2eeType=Servlet%2c* --&gt;

+            j2eeType=Servlet</code> which return all loaded servlets.

+      </li>

+      <li>

+        <code>qry=Catalina%3Atype%3DEnvironment%2Cresourcetype%3DGlobal%2Cname%3DsimpleValue --&gt;

+            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 Get command"><!--()--></a><a name="JMX_Get_command"><strong>JMX Get command</strong></a></font></td></tr><tr><td><blockquote>

+    The JXMProxyServlet also supports a "get" command that you can use to

+    fetch the value of a specific MBean's attribute. The general form of

+    the <code>get</code> 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://webserver/manager/jmxproxy/?get=BEANNAME&amp;att=MYATTRIBUTE&amp;key=MYKEY

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+    You must provide the following parameters:

+    <ol>

+      <li><code>get</code>: The full bean name</li>

+      <li><code>att</code>: The attribute you wish to fetch</li>

+      <li><code>key</code>: (optional) The key into a CompositeData MBean attribute</li>

+    </ol>

+

+    If all goes well, then it will say OK, otherwise an error message will

+    be shown. For example, let's say we wish to fetch the current heap memory

+    data:

+

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://webserver/manager/jmxproxy/?get=java.lang:type=Memory&amp;att=HeapMemoryUsage

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+

+    Or, if you only want the "used" key:

+

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://webserver/manager/jmxproxy/

+ ?get=java.lang:type=Memory&amp;att=HeapMemoryUsage&amp;key=used

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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="JMX Set command"><!--()--></a><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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://webserver/manager/jmxproxy/?set=BEANNAME&amp;att=MYATTRIBUTE&amp;val=NEWVALUE

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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

+ &amp;att=debug&amp;val=10

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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 'cow':

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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

+ &amp;att=debug&amp;val=cow

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+Error: java.lang.NumberFormatException: For input string: "cow"

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" 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="JMX Invoke command"><!--()--></a><a name="JMX_Invoke_command"><strong>JMX Invoke command</strong></a></font></td></tr><tr><td><blockquote>

+    <p>The <code>invoke</code> command enables methods to be called on MBeans. The

+    general form of the command is:</p>

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://webserver/manager/jmxproxy/

+ ?invoke=BEANNAME&amp;op=METHODNAME&amp;ps=COMMASEPARATEDPARAMETERS

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+    <p>For example, to call the <code>findConnectors()</code> method of the

+    <strong>Service</strong> use:</p>

+<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>

+http://localhost:8080/manager/jmxproxy/

+ ?invoke=Catalina%3Atype%3DService&amp;op=findConnectors&amp;ps=

+</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" 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" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

+  </blockquote></td></tr></table>

+

+</blockquote></td></tr></table></td></tr><tr class="noPrint"><td width="20%" valign="top" nowrap class="noPrint"></td><td width="80%" valign="top" align="left"><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="comments_section" id="comments_section"><strong>Comments</strong></a></font></td></tr><tr><td><blockquote><p class="notice"><strong>Notice: </strong>This comments section collects your suggestions

+              on improving documentation for Apache Tomcat.<br><br>

+              If you have trouble and need help, read

+              <a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page

+              and ask your question on the tomcat-users

+              <a href="http://tomcat.apache.org/lists.html">mailing list</a>.

+              Do not ask such questions here. This is not a Q&amp;A section.<br><br>

+              The Apache Comments System is explained <a href="/tomcat-7.0-doc/comments.html">here</a>.

+              Comments may be removed by our moderators if they are either

+              implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!--

+              var comments_shortname = 'tomcat';

+              var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/manager-howto.html';

+              (function(w, d) {

+                  if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {

+                      d.write('<div id="comments_thread"><\/div>');

+                      var s = d.createElement('script');

+                      s.type = 'text/javascript';

+                      s.async = true;

+                      s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;

+                      (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);

+                  }

+                  else {

+                      d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>');

+                  }

+              })(window, document);

+              //--><!]]></script></blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>

+        Copyright &copy; 1999-2013, Apache Software Foundation

+        </em></font></div></td></tr></table></body></html>
\ No newline at end of file