You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by rj...@apache.org on 2012/12/05 21:21:01 UTC
svn commit: r1417624 [23/38] - in /tomcat/site/trunk/docs/tomcat-8.0-doc: ./
api/ appdev/ appdev/sample/ appdev/sample/docs/ appdev/sample/src/
appdev/sample/src/mypackage/ appdev/sample/web/ appdev/sample/web/WEB-INF/
appdev/sample/web/images/ archite...
Added: tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/index.html
URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/index.html?rev=1417624&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/index.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/index.html Wed Dec 5 20:20:35 2012
@@ -0,0 +1,78 @@
+<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Catalina Functional Specifications (8.0.0-dev) - Table of Contents</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="
+ Catalina Functional Specifications
+ " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 8</font></h1><font face="arial,helvetica,sanserif">Version 8.0.0-dev, Dec 5 2012</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="index.html">Functional Specs</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>Administrative Apps</strong></p><ul><li><a href="fs-admin-apps.html">Overall Requirements</a></li><li><a href="mbean-names.html">Tomcat MBean Names</a></li><li><a href="fs-admin-objects.html">Ad
ministered Objects</a></li><li><a href="fs-admin-opers.html">Supported Operations</a></li></ul><p><strong>Internal Servlets</strong></p><ul><li><a href="fs-default.html">Default Servlet</a></li></ul><p><strong>Realm Implementations</strong></p><ul><li><a href="fs-jdbc-realm.html">JDBC Realm</a></li><li><a href="fs-jndi-realm.html">JNDI Realm</a></li><li><a href="fs-memory-realm.html">Memory Realm</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Table of Contents</h1><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Catalina Functional Specifications"><!--()--></a><a name="Catalina_Functional_Specifications"><strong>Catalina Functional Specifications</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>This documentation area includes <em>functional specifications</em> for
+many features supported by the <strong>Catalina</strong> servlet container
+portion of Tomcat. In most cases, these features are not documented in the
+underlying Servlet or JSP specifications, so a definition of the expected
+correct behavior is important both to implementors of those features, and to
+test writers trying to decide what to test.</p>
+
+<p>The functional specifications are divided into the following categories
+in the menu (to the left):</p>
+<ul>
+<li><em>Administrative Apps</em> - Overall requirements for supporting an
+ ability to configure and operate a Tomcat installation through tools,
+ as well as detailed requirements for the tools themselves.</li>
+<li><em>Internal Servlets</em> - Requirements for Catalina features that are
+ implemented as internal, container-managed, servlets.</li>
+<li><em>Realm Implementations</em> - Requirements for the implementations of
+ the <code>org.apache.catalina.Realm</code> interface (providing access to
+ collections of users, passwords and roles) that are included in the
+ standard Tomcat distribution.</li>
+</ul>
+
+<p><em>NOTE</em> - In some cases, the contents of these functional specs has
+been "reverse engineered" from existing implementations. This exercise is
+still useful, because it provides an introduction to <strong>what</strong>
+Catalina does, without being as concerned with <strong>how</strong> this is
+accomplished.</p>
+
+<p><strong>TODO</strong> - Obviously, this area has a long ways to go before
+it is complete. Contributions are welcome!</p>
+
+</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 is not a Q&A section.
+ The Apache Comments System is explained
+ <a href="/tomcat-8.0-doc/comments.html">here</a>.
+ Comments should be pointed towards suggestions on improving the documentation
+ or server, and may be removed again by our moderators if they are either
+ implemented or considered invalid/off-topic.
+ Questions on how to manage Apache Tomcat should be directed
+ to our <a href="http://tomcat.apache.org/lists.html">mailing lists</a>.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
+ var comments_shortname = 'tomcat';
+ var comments_identifier = 'http://tomcat.apache.org/tomcat-8.0-doc/funcspecs/index.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 © 1999-2012, Apache Software Foundation
+ </em></font></div></td></tr></table></body></html>
\ No newline at end of file
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/index.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/index.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/mbean-names.html
URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/mbean-names.html?rev=1417624&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/mbean-names.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/mbean-names.html Wed Dec 5 20:20:35 2012
@@ -0,0 +1,754 @@
+<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Catalina Functional Specifications (8.0.0-dev) - Tomcat MBean Names</title><meta name="author" content="Craig McClanahan"><meta name="author" content="Amy Roh"><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="
+ Catalina Functional Specifications
+ " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 8</font></h1><font face="arial,helvetica,sanserif">Version 8.0.0-dev, Dec 5 2012</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="index.html">Functional Specs</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>Administrative Apps</strong></p><ul><li><a href="fs-admin-apps.html">Overall Requirements</a></li><li><a href="mbean-names.html">Tomcat MBean Names</a></li><li><a href="fs-admin-objects.html">Ad
ministered Objects</a></li><li><a href="fs-admin-opers.html">Supported Operations</a></li></ul><p><strong>Internal Servlets</strong></p><ul><li><a href="fs-default.html">Default Servlet</a></li></ul><p><strong>Realm Implementations</strong></p><ul><li><a href="fs-jdbc-realm.html">JDBC Realm</a></li><li><a href="fs-jndi-realm.html">JNDI Realm</a></li><li><a href="fs-memory-realm.html">Memory Realm</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Tomcat MBean Names</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="#Background">Background</a></li><li><a href="#Catalina_Object_Hierarchy">Catalina Object Hierarchy</a></li><li><a href="#MBean_Groups_and_Names">MBean Groups and Names</a></li><li><a href="#JSR-77_Cross_Reference">JSR-77 Cross Reference</a></li><li><a href="#JSR-88_Cross_Reference">JSR-88 Cross Reference</a></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="Background"><strong>Background</strong></a></font></td></tr><tr><td><blockquote>
+
+ <p>We will be using <em>JMX MBeans</em> as the technology for
+ implementing manageability of Tomcat.</p>
+
+ <p>One of the key concepts of JMX (and JSR-77) is that each management
+ bean has a unique name in the MBeanServer's registry, and that
+ management applications can utilize these names to retrieve the MBean
+ of interest to them for a particular management operation.
+ This document proposes a naming convention for MBeans that allows easy
+ calculation of the name for a particular MBean. For background
+ information on JMX MBean names, see the <em>Java Management Extensions
+ Instrumentation and Agent Specification</em>, version 1.0, section 6.
+ In particular, we will be discussing the String Representation of
+ <code>ObjectName</code> instances.</p>
+
+</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Catalina Object Hierarchy"><!--()--></a><a name="Catalina_Object_Hierarchy"><strong>Catalina Object Hierarchy</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>Tomcat's servlet container implementation, called Catalina, can be
+represented as a hierarchy of objects that contain references to each other.
+The object hierarchy can be represented as a tree, or (isomorphically) based
+on the nesting of configuration elements in the <code>conf/server.xml</code>
+file that is traditionally used to configure Tomcat stand-alone.</p>
+
+<p>The valid component nestings for Catalina are depicted in the following
+table, with columns that contain the following values:</p>
+<ul>
+<li><em>Pattern</em> - Nesting pattern of XML elements (in the
+ <code>conf/server.xml</code> file) used to configure this component.</li>
+<li><em>Cardinality</em> - Minimum and maximum number of occurrences of
+ this element at this nesting position, which also corresponds to the
+ minimum and maximum number of Catalina components.</li>
+<li><em>Identifier</em> - Name of the JavaBeans property of this component
+ that represents the unique identifier (within the nested hierarchy),
+ if any.</li>
+<li><em>MBean ObjectName</em> - The portion of the MBean object name that
+ appears <strong>after</strong> the domain name. For now, it should be
+ assumed that all of these MBeans appear in the default JMX domain.</li>
+</ul>
+
+<p>In the <em>MBean ObjectName</em> descriptions, several types of symbolic
+expressions are utilized to define variable text that is replaced by
+corresponding values:</p>
+<ul>
+<li><em>${GROUP}</em> - One of the standard MBean names of the specified
+ "group" category. For example, the expression <code>${REALM}</code>
+ represents the values like <code>JDBCRealm</code> and <code>JAASRealm</code>
+ that identify the various MBeans for possible <code>Realm</code> components.</li>
+<li><em>${name}</em> - Replaced by the value of property <code>name</code>
+ from the current component.</li>
+<li><em>${parent.name}</em> - Replaced by the value of property
+ <code>name</code> from a parent of the current component, with the
+ parent's type identified by <em>parent</em>.</li>
+<li><em>${###}</em> - An arbitrary numeric identifier that preserves
+ order but has no other particular meaning. In general, the server will
+ assign numeric values to existing instances with large gaps into which
+ new items can be configured if desired.</li>
+</ul>
+
+<table border="1" cellpadding="5">
+
+ <tr>
+ <th align="center" bgcolor="aqua">Pattern</th>
+ <th align="center" bgcolor="aqua">Cardinality</th>
+ <th align="center" bgcolor="aqua">Identifier</th>
+ <th align="center" bgcolor="aqua">MBean ObjectName</th>
+ </tr>
+
+ <tr>
+ <td>Server</td>
+ <td align="center">1..1</td>
+ <td align="center">(none)</td>
+ <td><code>type=${SERVER}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Listener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${LISTENER}, sequence=${###}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service</td>
+ <td align="center">1..n</td>
+ <td align="center"><code>name</code></td>
+ <td><code>type=${SERVICE}, name=${name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Connector</td>
+ <td align="center">1..n</td>
+ <td align="center"><code>address, port</code></td>
+ <td><code>type=${CONNECTOR}, service=${service}, port=${port},
+ address=${address}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Connector / Factory</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td>(Only defined explicitly for an SSL connector, but can be treated
+ as part of the connector component)</td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Connector / Listener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${LISTENER}, sequence=${###}, service=${service},
+ port=${connector.port}, address=${connector.address}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine</td>
+ <td align="center">1..1</td>
+ <td align="center">(none)</td>
+ <td><code>type=${ENGINE}, service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host</td>
+ <td align="center">1..n</td>
+ <td align="center"><code>name</code></td>
+ <td><code>type=${HOST}, host=${name},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Context</td>
+ <td align="center">1..n</td>
+ <td align="center"><code>path</code></td>
+ <td><code>type=${CONTEXT}, context=${name}, host=${host.name},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Context / InstanceListener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${INSTANCE-LISTENER}, sequence=${###},
+ context=${context.name}, host=${host.name},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Context / Listener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${LISTENER}, sequence=${###}, context=${context.name},
+ host=${host.name}, service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Context / Loader</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td><code>type=${LOADER}, context=${context.name}, host=${host.name},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Context / Manager</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td><code>type=${MANAGER}, context=${context.name}, host=${host.name},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Context / Realm</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td><code>type=${REALM}, context=${context.name}, host=${host.name},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Context / Resources</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td><code>type=${RESOURCES}, context=${context.name}, host=${host.name},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Context / Valve</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${VALVE}, sequence=${###}, context=${context.name},
+ host=${host.name}, service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Context / Wrapper</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>j2eeType=Servlet,name=${name},
+ WebModule=//${host.name}/${context.name},
+ J2EEApplication=${context.J2EEApplication},
+ J2EEServer=${context.J2EEServer}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Context / WrapperLifecycle</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${WRAPPER-LIFECYCLE}, sequence=${###},
+ context=${context.name}, host=${host.name},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Context / WrapperListener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${WRAPPER-LISTENER}, sequence=${###},
+ context=${context.name}, host=${host.name},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Listener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${LISTENER}, sequence=${###}, host=${host.name},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Realm</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td><code>type=${REALM}, host=${host.name},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / Valve</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${VALVE}, sequence=${###},
+ host=${host.name}, service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Listener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${LISTENER}, sequence=${###}</code>
+ (<strong>FIXME</strong> - disambiguate from Server / Service /
+ Listener)</td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Realm</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td><code>type=${REALM}, service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Valve</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${VALVE}, sequence=${###},
+ service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Listener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${LISTENER}, sequence=${###}</code>
+ (<strong>FIXME</strong> - disambiguate from Server / Service /
+ Engine / Listener)</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="MBean Groups and Names"><!--()--></a><a name="MBean_Groups_and_Names"><strong>MBean Groups and Names</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>The following MBean names shall be defined in the resource file
+<code>/org/apache/catalina/mbeans/mbeans-descriptors.xml</code> (and
+therefore available for use within the Administration/Configuration
+web application for Tomcat):</p>
+
+<table border="1" cellpadding="5">
+
+ <tr>
+ <th align="center" bgcolor="aqua">MBean Name</th>
+ <th align="center" bgcolor="aqua">Group Name</th>
+ <th align="center" bgcolor="aqua">Catalina Interface</th>
+ <th align="center" bgcolor="aqua">Implementation Class</th>
+ </tr>
+
+ <tr>
+ <td><code>AccessLogValve</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.valves.AccessLogValve</code></td>
+ </tr>
+
+ <tr>
+ <td><code>BasicAuthenticator</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.authenticator.BasicAuthenticator</code></td>
+ </tr>
+
+ <tr>
+ <td><code>CertificatesValve</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.valves.CertificatesValve</code></td>
+ </tr>
+
+ <tr>
+ <td><code>ContextConfig</code></td>
+ <td align="center"><code>LISTENER</code></td>
+ <td><code>org.apache.catalina.LifecycleListener</code></td>
+ <td><code>org.apache.catalina.startup.ContextConfig</code></td>
+ </tr>
+
+ <tr>
+ <td><code>ContextEnvironment</code></td>
+ <td align="center"><code>RESOURCES</code></td>
+ <td><code>org.apache.catalina.deploy.ContextEnvironment</code></td>
+ <td><code>org.apache.catalina.deploy.ContextEnvironment</code></td>
+ </tr>
+
+ <tr>
+ <td><code>ContextResource</code></td>
+ <td align="center"><code>RESOURCES</code></td>
+ <td><code>org.apache.catalina.deploy.ContextResource</code></td>
+ <td><code>org.apache.catalina.deploy.ContextResource</code></td>
+ </tr>
+
+ <tr>
+ <td><code>ContextResourceLink</code></td>
+ <td align="center"><code>RESOURCES</code></td>
+ <td><code>org.apache.catalina.deploy.ContextResourceLink</code></td>
+ <td><code>org.apache.catalina.deploy.ContextResourceLink</code></td>
+ </tr>
+
+ <tr>
+ <td><code>CoyoteConnector</code></td>
+ <td align="center"><code>CONNECTOR</code></td>
+ <td><code>org.apache.catalina.Connector</code></td>
+ <td><code>org.apache.coyote.tomcat4.CoyoteConnector</code></td>
+ </tr>
+
+ <tr>
+ <td><code>DigestAuthenticator</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.authenticator.DigestAuthenticator</code></td>
+ </tr>
+
+ <tr>
+ <td><code>EngineConfig</code></td>
+ <td align="center"><code>LISTENER</code></td>
+ <td><code>org.apache.catalina.LifecycleListener</code></td>
+ <td><code>org.apache.catalina.startup.EngineConfig</code></td>
+ </tr>
+
+ <tr>
+ <td><code>ErrorReportValve</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.valves.ErrorReportValve</code></td>
+ </tr>
+
+ <tr>
+ <td><code>ErrorDispatcherValve</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.valves.ErrorDispatcherValve</code></td>
+ </tr>
+
+ <tr>
+ <td><code>FormAuthenticator</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.authenticator.FormAuthenticator</code></td>
+ </tr>
+
+ <tr>
+ <td><code>Group</code></td>
+ <td align="center"><code>GROUP</code></td>
+ <td><code>org.apache.catalina.Group</code></td>
+ <td><code>org.apache.catalina.Group</code></td>
+ </tr>
+
+ <tr>
+ <td><code>HostConfig</code></td>
+ <td align="center"><code>LISTENER</code></td>
+ <td><code>org.apache.catalina.LifecycleListener</code></td>
+ <td><code>org.apache.catalina.startup.HostConfig</code></td>
+ </tr>
+
+ <tr>
+ <td><code>HttpConnector10</code></td>
+ <td align="center"><code>CONNECTOR</code></td>
+ <td><code>org.apache.catalina.Connector</code></td>
+ <td><code>org.apache.catalina.connector.http10.HttpConnector</code></td>
+ </tr>
+
+ <tr>
+ <td><code>HttpConnector11</code></td>
+ <td align="center"><code>CONNECTOR</code></td>
+ <td><code>org.apache.catalina.Connector</code></td>
+ <td><code>org.apache.catalina.connector.http.HttpConnector</code></td>
+ </tr>
+
+ <tr>
+ <td><code>JAASRealm</code></td>
+ <td align="center"><code>REALM</code></td>
+ <td><code>org.apache.catalina.Realm</code></td>
+ <td><code>org.apache.catalina.realm.JAASRealm</code></td>
+ </tr>
+
+ <tr>
+ <td><code>JDBCRealm</code></td>
+ <td align="center"><code>REALM</code></td>
+ <td><code>org.apache.catalina.Realm</code></td>
+ <td><code>org.apache.catalina.realm.JDBCRealm</code></td>
+ </tr>
+
+ <tr>
+ <td><code>JDBCUserDatabase</code></td>
+ <td align="center"><code>USERDATABASE</code></td>
+ <td><code>org.apache.catalina.users.JDBCUserDatabase</code></td>
+ <td><code>org.apache.catalina.users.JDBCUserDatabase</code></td>
+ </tr>
+
+ <tr>
+ <td><code>JNDIRealm</code></td>
+ <td align="center"><code>REALM</code></td>
+ <td><code>org.apache.catalina.Realm</code></td>
+ <td><code>org.apache.catalina.realm.JNDIRealm</code></td>
+ </tr>
+
+ <tr>
+ <td><code>MBeanFactory</code></td>
+ <td align="center"><code></code></td>
+ <td><code></code></td>
+ <td><code>org.apache.catalina.mbeans.MBeanFactory</code></td>
+ </tr>
+
+ <tr>
+ <td><code>MemoryRealm</code></td>
+ <td align="center"><code>REALM</code></td>
+ <td><code>org.apache.catalina.Realm</code></td>
+ <td><code>org.apache.catalina.realm.MemoryRealm</code></td>
+ </tr>
+
+ <tr>
+ <td><code>MemoryUserDatabase</code></td>
+ <td align="center"><code>USERDATABASE</code></td>
+ <td><code>org.apache.catalina.users.MemoryUserDatabase</code></td>
+ <td><code>org.apache.catalina.users.MemoryUserDatabase</code></td>
+ </tr>
+
+ <tr>
+ <td><code>NamingContextListener</code></td>
+ <td align="center"><code>LISTENER</code></td>
+ <td><code>org.apache.catalina.LifecycleListener</code></td>
+ <td><code>org.apache.catalina.core.NamingContextListener</code></td>
+ </tr>
+
+ <tr>
+ <td><code>NamingResources</code></td>
+ <td align="center"><code>RESOURCES</code></td>
+ <td><code>org.apache.catalina.deploy.NamingResources</code></td>
+ <td><code>org.apache.catalina.deploy.NamingResources</code></td>
+ </tr>
+
+ <tr>
+ <td><code>NonLoginAuthenticator</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.authenticator.NonLoginAuthenticator</code></td>
+ </tr>
+
+ <tr>
+ <td><code>PersistentManager</code></td>
+ <td align="center"><code>MANAGER</code></td>
+ <td><code>org.apache.catalina.Manager</code></td>
+ <td><code>org.apache.catalina.session.PersistentManager</code></td>
+ </tr>
+
+ <tr>
+ <td><code>RemoteAddrValve</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.valves.RemoteAddrValve</code></td>
+ </tr>
+
+ <tr>
+ <td><code>RemoteHostValve</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.valves.RemoteHostValve</code></td>
+ </tr>
+
+ <tr>
+ <td><code>RequestDumperValve</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.valves.RequestDumperValve</code></td>
+ </tr>
+
+ <tr>
+ <td><code>Role</code></td>
+ <td align="center"><code>ROLE</code></td>
+ <td><code>org.apache.catalina.Role</code></td>
+ <td><code>org.apache.catalina.Role</code></td>
+ </tr>
+
+ <tr>
+ <td><code>SingleSignOn</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.valves.SingleSignOn</code></td>
+ </tr>
+
+ <tr>
+ <td><code>SSLAuthenticator</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.authenticator.SSLAuthenticator</code></td>
+ </tr>
+
+ <tr>
+ <td><code>StandardContext</code></td>
+ <td align="center"><code>CONTEXT</code></td>
+ <td><code>org.apache.catalina.Context</code></td>
+ <td><code>org.apache.catalina.core.StandardContext</code></td>
+ </tr>
+
+ <tr>
+ <td><code>StandardContextValve</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.core.StandardContextValve</code></td>
+ </tr>
+
+ <tr>
+ <td><code>StandardEngine</code></td>
+ <td align="center"><code>ENGINE</code></td>
+ <td><code>org.apache.catalina.Engine</code></td>
+ <td><code>org.apache.catalina.core.StandardEngine</code></td>
+ </tr>
+
+ <tr>
+ <td><code>StandardEngineValve</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.core.StandardEngineValve</code></td>
+ </tr>
+
+ <tr>
+ <td><code>StandardHost</code></td>
+ <td align="center"><code>HOST</code></td>
+ <td><code>org.apache.catalina.Host</code></td>
+ <td><code>org.apache.catalina.core.StandardHost</code></td>
+ </tr>
+
+ <tr>
+ <td><code>StandardHostValve</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.core.StandardHostValve</code></td>
+ </tr>
+
+ <tr>
+ <td><code>StandardManager</code></td>
+ <td align="center"><code>MANAGER</code></td>
+ <td><code>org.apache.catalina.Manager</code></td>
+ <td><code>org.apache.catalina.session.StandardManager</code></td>
+ </tr>
+
+ <tr>
+ <td><code>StandardServer</code></td>
+ <td align="center"><code>SERVER</code></td>
+ <td><code>org.apache.catalina.Server</code></td>
+ <td><code>org.apache.catalina.core.StandardServer</code></td>
+ </tr>
+
+ <tr>
+ <td><code>StandardService</code></td>
+ <td align="center"><code>SERVICE</code></td>
+ <td><code>org.apache.catalina.Service</code></td>
+ <td><code>org.apache.catalina.core.StandardService</code></td>
+ </tr>
+
+ <tr>
+ <td><code>StandardWrapper</code></td>
+ <td align="center"><code>WRAPPER</code></td>
+ <td><code>org.apache.catalina.Wrapper</code></td>
+ <td><code>org.apache.catalina.core.StandardWrapper</code></td>
+ </tr>
+
+ <tr>
+ <td><code>StandardWrapperValve</code></td>
+ <td align="center"><code>VALVE</code></td>
+ <td><code>org.apache.catalina.Valve</code></td>
+ <td><code>org.apache.catalina.core.StandardWrapperValve</code></td>
+ </tr>
+
+ <tr>
+ <td><code>User</code></td>
+ <td align="center"><code>USER</code></td>
+ <td><code>org.apache.catalina.User</code></td>
+ <td><code>org.apache.catalina.User</code></td>
+ </tr>
+
+ <tr>
+ <td><code>UserDatabaseRealm</code></td>
+ <td align="center"><code>REALM</code></td>
+ <td><code>org.apache.catalina.Realm</code></td>
+ <td><code>org.apache.catalina.realm.UserDatabaseRealm</code></td>
+ </tr>
+
+ <tr>
+ <td><code>WebappLoader</code></td>
+ <td align="center"><code>LOADER</code></td>
+ <td><code>org.apache.catalina.Loader</code></td>
+ <td><code>org.apache.catalina.loader.WebappLoader</code></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="JSR-77 Cross Reference"><!--()--></a><a name="JSR-77_Cross_Reference"><strong>JSR-77 Cross Reference</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>The managed objects in the JSR-77 object hierarchy correspond
+to the specified MBean names or groups as follows:</p>
+
+<table border="1" cellpadding="5">
+
+ <tr>
+ <th align="center" bgcolor="aqua">JSR-77 Managed Object</th>
+ <th align="center" bgcolor="aqua">MBean Name or Group</th>
+ <th align="center" bgcolor="aqua">Comments</th>
+ </tr>
+
+ <tr>
+ <td><code>J2EEServer</code></td>
+ <td><code>${SERVICE}</code></td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td><code>Node</code></td>
+ <td><code>${SERVICE}</code></td>
+ <td>Tomcat supports a single node only.</td>
+ </tr>
+
+ <tr>
+ <td><code>Port</code></td>
+ <td><code>${CONNECTOR}</code></td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td><code>Servlet</code></td>
+ <td><code>${WRAPPER}</code></td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td><code>WebModule</code></td>
+ <td><code>${CONTEXT}</code></td>
+ <td></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="JSR-88 Cross Reference"><!--()--></a><a name="JSR-88_Cross_Reference"><strong>JSR-88 Cross Reference</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>The deployment objects in the JSR-88 API object hierarchy correspond
+to the specified MBean names or groups as follows:</p>
+
+<table border="1" cellpadding="5">
+
+ <tr>
+ <th align="center" bgcolor="aqua">JSR-88 API Object</th>
+ <th align="center" bgcolor="aqua">MBean Name or Group</th>
+ <th align="center" bgcolor="aqua">Comments</th>
+ </tr>
+
+ <tr>
+ <td><code>DeployableObject</code></td>
+ <td><code>${CONTEXT}</code></td>
+ <td>Context deployment info plus the corresponding WAR file</td>
+ </tr>
+
+ <tr>
+ <td><code>Target</code></td>
+ <td><code>${HOST}</code></td>
+ <td></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 is not a Q&A section.
+ The Apache Comments System is explained
+ <a href="/tomcat-8.0-doc/comments.html">here</a>.
+ Comments should be pointed towards suggestions on improving the documentation
+ or server, and may be removed again by our moderators if they are either
+ implemented or considered invalid/off-topic.
+ Questions on how to manage Apache Tomcat should be directed
+ to our <a href="http://tomcat.apache.org/lists.html">mailing lists</a>.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
+ var comments_shortname = 'tomcat';
+ var comments_identifier = 'http://tomcat.apache.org/tomcat-8.0-doc/funcspecs/mbean-names.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 © 1999-2012, Apache Software Foundation
+ </em></font></div></td></tr></table></body></html>
\ No newline at end of file
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/mbean-names.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/funcspecs/mbean-names.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: tomcat/site/trunk/docs/tomcat-8.0-doc/html-manager-howto.html
URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/html-manager-howto.html?rev=1417624&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/html-manager-howto.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/html-manager-howto.html Wed Dec 5 20:20:35 2012
@@ -0,0 +1,575 @@
+<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 8 (8.0.0-dev) - Tomcat Web Application Manager How To</title><meta name="author" content="Glenn L. Nielsen"><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 8</font></h1><font face="arial,helvetica,sanserif">Version 8.0.0-dev, Dec 5 2012</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/i
ndex.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/index.html">Tribes</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Tomcat Web Application Manager 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="#Message">Message</a></li><li><a href="#Manager">Manager</a></li><li><a href="#Applications">Applications</a><ol><li><a href="#Start">Start</a></li><li><a href="#Stop">Stop</a></li><li><a href="#Reload">Reload</a></li><li><a href="#Undeploy">Undeploy</a></li></ol></li><li><a href="#Deploy">Deploy</a><ol><li><a href="#Deploy_directory_or_WAR_file_located_on_server">Deploy directory or WAR file located on server</a></li><li><a href="#Upload_a_WAR_file_to_install">Upload a WAR file to install</a></li><li><a href="#Deployment_Notes">Deployment Notes</a></li><li><a href="#Deploy_Message">Deploy Message</a></li></ol></li><li><a href="#Diagnostics">Diagnostics</a><ol><li><a href="#Finding_memory_leaks">Finding memory leaks</a></li></ol></li><li><a href="#Server_Information">Server Information</a></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 manage your web applications without having to shut down and restart
+Tomcat. This document is for the HTML web interface to the web application
+<a href="manager-howto.html">manager</a>.</p>
+
+<p>The interface is divided into six sections:</p>
+<ul>
+ <li><strong>Message</strong> - Displays success and failure messages.</li>
+ <li><strong>Manager</strong> - General manager operations like list and
+ help.</li>
+ <li><strong>Applications</strong> - List of web applications and
+ commands.</li>
+ <li><strong>Deploy</strong> - Deploying web applications.</li>
+ <li><strong>Diagnostics</strong> - Identifying potential problems.</li>
+ <li><strong>Server Information</strong> - Information about the Tomcat
+ server.</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="Message"><strong>Message</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>
+Displays information about the success or failure of the last web application
+manager command you performed. If it succeeded <strong>OK</strong> is displayed
+and may be followed by a success message. If it failed <strong>FAIL</strong>
+is displayed followed by an error message. Common failure messages are
+documented below for each command. The complete list of failure messages for
+each command can be found in the <a href="manager-howto.html">manager</a> web
+application documentation.
+</p>
+
+</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Manager"><strong>Manager</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>The Manager section has three links:</p>
+<ul>
+ <li><strong>List Applications</strong> - Redisplay a list of web
+ applications.</li>
+ <li><strong>HTML Manager Help</strong> - A link to this document.</li>
+ <li><strong>Manager Help</strong> - A link to the comprehensive Manager
+ App HOW TO.</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="Applications"><strong>Applications</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>The Applications section lists information about all the installed web
+applications and provides links for managing them. For each web application
+the following is displayed:</p>
+<ul>
+ <li><strong>Path</strong> - The web application context path.</li>
+ <li><strong>Display Name</strong> - The display name for the web application
+ if it has one configured in its "web.xml" file.</li>
+ <li><strong>Running</strong> - Whether the web application is running and
+ available (true), or not running and unavailable (false).</li>
+ <li><strong>Sessions</strong> - The number of active sessions for remote
+ users of this web application. The number of sessions is a link which
+ when submitted displays more details about session usage by the web
+ application in the Message box.</li>
+ <li><strong>Commands</strong> - Lists all commands which can be performed on
+ the web application. Only those commands which can be performed will be
+ listed as a link which can be submitted. No commands can be performed on
+ the manager web application itself. The following commands can be
+ performed:
+ <ul>
+ <li><strong>Start</strong> - Start a web application which had been
+ stopped.</li>
+ <li><strong>Stop</strong> - Stop a web application which is currently
+ running and make it unavailable.</li>
+ <li><strong>Reload</strong> - Reload the web application so that new
+ ".jar" files in <code>/WEB-INF/lib/</code> or new classes in
+ <code>/WEB-INF/classes/</code> can be used.</li>
+ <li><strong>Undeploy</strong> - Stop and then remove this web
+ application from the server.</li>
+ </ul>
+ </li>
+</ul>
+
+<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Start"><strong>Start</strong></a></font></td></tr><tr><td><blockquote>
+
+<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 Message 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 Message 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, unless you are
+ referencing the ROOT web application -- in which case the context path
+ must be a zero-length string.</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"><strong>Stop</strong></a></font></td></tr><tr><td><blockquote>
+
+<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 Message 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 Message 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, unless you are
+ referencing the ROOT web application -- in which case the context path
+ must be a zero-length string.</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="Reload"><strong>Reload</strong></a></font></td></tr><tr><td><blockquote>
+
+<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 checked on a reload;
+the previous web.xml configuration is used.
+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 Message 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 Message 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, unless you are
+ referencing the ROOT web application -- in which case the context path
+ must be a zero-length string.</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
+ installed directly from a WAR file, which happens when the host is
+ configured to not unpack WAR files. As it only works when the web
+ application is installed from an unpacked directory, if you are using
+ a WAR file, you should <code>undeploy</code> and then <code>deploy</code>
+ 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="Undeploy"><strong>Undeploy</strong></a></font></td></tr><tr><td><blockquote>
+
+<p><strong><font color="red">WARNING</font> - This command will delete the
+contents of the web application directory and/or ".war" file if it exists within
+the <code>appBase</code> directory (typically "webapps") for this virtual host
+</strong>. The web application temporary work directory is also deleted. 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 then
+remove it from Tomcat (which also makes this context path available for
+reuse later). This command is the logical opposite of the
+<code>/deploy</code> Ant command, and the related deploy features available
+in the HTML manager.</p>
+
+<p>If this command succeeds, you will see a Message 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 Message 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, unless you are
+ referencing the ROOT web application -- in which case the context path
+ must be a zero-length string.</p>
+ </blockquote></li>
+<li><em>No context exists for path /foo</em>
+ <blockquote>
+ <p>There is no deployed application on the context path
+ that you specified.</p>
+ </blockquote></li>
+<li><em>No context path was specified</em>
+ <blockquote>
+ The <code>path</code> parameter is required.
+ </blockquote></li>
+</ul>
+
+</blockquote></td></tr></table>
+
+</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Deploy"><strong>Deploy</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>Web applications can be deployed using files or directories located
+on the Tomcat server or you can upload a web application archive (WAR)
+file to the server.</p>
+
+<p>To install an application, fill in the appropriate fields for the type
+of install you want to do and then submit it using the <i>Install</i>
+button.</p>
+
+<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Deploy directory or WAR file located on server"><!--()--></a><a name="Deploy_directory_or_WAR_file_located_on_server"><strong>Deploy directory or WAR file located on server</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>Deploy and start a new web application, attached to the specified <i>Context
+Path:</i> (which must not be in use by any other web application).
+This command is the logical opposite of the <em>Undeploy</em> command.</p>
+
+<p>There are a number of different ways the deploy command can be used.</p>
+
+<h3>Deploy a Directory or WAR by URL</h3>
+
+<p>Install a web application directory or ".war" file located on the Tomcat
+server. If no <i>Context Path</i> is specified, the directory name or the
+war file name without the ".war" extension is used as the path. The
+<i>WAR or Directory URL</i> 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>C:\path\to\foo</code> on the Tomcat server (running on Windows)
+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>
+Context Path: /footoo
+WAR or Directory URL: file:C:/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 (running on Unix) 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>
+WAR or Directory URL: 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>Install a web application directory or ".war" file located in your Host
+appBase directory. If no <i>Context Path</i> is specified 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 subdirectory 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 there is no <code>path</code> parameter so the context path defaults
+to 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>
+WAR or Directory URL: 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>/bartoo</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>
+Context Path: /bartoo
+WAR or Directory URL: 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 install a web
+application using a Context configuration ".xml" file and an optional
+".war" file or web application directory. The <i>Context Path</i>
+is not used when installing 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 for Tomcat running on Windows:</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>
+<Context path="/foobar" docBase="C:\path\to\application\foobar">
+</Context>
+</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>Use of the <i>WAR or Directory URL</i> is optional. When used
+to select 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 installing an application using a Context
+configuration ".xml" file for Tomcat running on Windows.</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>
+XML Configuration file URL: file:C:/path/to/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 installing an application using a Context
+configuration ".xml" file and a web application ".war" file located
+on the server (Tomcat running on Unix).</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>
+XML Configuration file URL: file:/path/to/context.xml
+WAR or Directory URL: 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>
+
+
+</blockquote></td></tr></table>
+
+<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Upload a WAR file to install"><!--()--></a><a name="Upload_a_WAR_file_to_install"><strong>Upload a WAR file to install</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>Upload a WAR file from your local system and install it into the
+appBase for your Host. The name of the WAR file without the ".war"
+extension is used as the context path name.</p>
+
+<p>Use the <i>Browse</i> button to select a WAR file to upload to the
+server from your local desktop system.</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>Upload of a WAR file could fail for the following reasons:</p>
+<ul>
+<li><em>File uploaded must be a .war</em>
+ <blockquote>
+ <p>The upload install will only accept files which have the filename
+ extension of ".war".</p>
+ </blockquote></li>
+<li><em>War file already exists on server</em>
+ <blockquote>
+ <p>If a war file of the same name already exists in your Host's
+ appBase the upload will fail. Either undeploy the existing war file
+ from your Host's appBase or upload the new war file using a different
+ name.</p>
+ </blockquote></li>
+<li><em>File upload failed, no file</em>
+ <blockquote>
+ <p>The file upload failed, no file was received by the server.</p>
+ </blockquote></li>
+<li><em>Install Upload Failed, Exception:</em>
+ <blockquote>
+ <p>The war file upload or install failed with a Java Exception.
+ The exception message will be listed.</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="Deployment Notes"><!--()--></a><a name="Deployment_Notes"><strong>Deployment Notes</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>If the Host is configured with unpackWARs=true and you install 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 deployed 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.</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 installing web applications using a configuration XML file and
+also prevents them from installing application directories or ".war"
+files located outside of their Host appBase.</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="Deploy Message"><!--()--></a><a name="Deploy_Message"><strong>Deploy Message</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>If deployment and startup is successful, you will receive a Message
+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 Message 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 either undeploy the existing web
+ application using this context path, or choose a different context path
+ for the new one.</p>
+ </blockquote></li>
+<li><em>Document base does not exist or is not a readable directory</em>
+ <blockquote>
+ <p>The URL specified by the <i>WAR or Directory URL:</i> field 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 entered for
+ the <i>WAR or Directory URL:</i> field.</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 <i>WAR or Directory URL:</i> field 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, unless you are
+ referencing the ROOT web application -- in which case the context path
+ must be a "/" string.</p>
+ </blockquote></li>
+<li><em>Context path must match the directory or WAR file name:</em>
+ <blockquote>
+ If the application war or directory is deployed 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 deployed</em>
+ <blockquote>
+ If the Host deployXML flag is set to false this error will happen
+ if an attempt is made to install a web application directory or
+ ".war" file outside of the Host appBase directory.
+ </blockquote></li>
+</ul>
+
+</blockquote></td></tr></table>
+</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Diagnostics"><strong>Diagnostics</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="Finding memory leaks"><!--()--></a><a name="Finding_memory_leaks"><strong>Finding memory leaks</strong></a></font></td></tr><tr><td><blockquote>
+
+<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>This diagnostic will list context paths for the web applications that were
+stopped, reloaded or undeployed, but which classes from the previous runs
+are still present in memory, thus being a memory leak. If an application
+has been reloaded several times, it may be listed several times.</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>
+
+</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="Server Information"><!--()--></a><a name="Server_Information"><strong>Server Information</strong></a></font></td></tr><tr><td><blockquote>
+
+<p>This section displays information about Tomcat, the operating system of
+the server Tomcat is hosted on, and the Java Virtual Machine Tomcat is
+running in.</p>
+
+</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 is not a Q&A section.
+ The Apache Comments System is explained
+ <a href="/tomcat-8.0-doc/comments.html">here</a>.
+ Comments should be pointed towards suggestions on improving the documentation
+ or server, and may be removed again by our moderators if they are either
+ implemented or considered invalid/off-topic.
+ Questions on how to manage Apache Tomcat should be directed
+ to our <a href="http://tomcat.apache.org/lists.html">mailing lists</a>.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
+ var comments_shortname = 'tomcat';
+ var comments_identifier = 'http://tomcat.apache.org/tomcat-8.0-doc/html-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 © 1999-2012, Apache Software Foundation
+ </em></font></div></td></tr></table></body></html>
\ No newline at end of file
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/html-manager-howto.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/html-manager-howto.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org