Added: tomcat/tc6.0.x/trunk/webapps/docs/funcspecs/mbean-names.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/funcspecs/mbean-names.xml?rev=420006&view=auto
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/funcspecs/mbean-names.xml (added)
+++ tomcat/tc6.0.x/trunk/webapps/docs/funcspecs/mbean-names.xml Fri Jul 7
15:40:04 2006
@@ -0,0 +1,870 @@
+<?xml version="1.0"?>
+<!DOCTYPE document [
+ <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="mbean-names.html">
+
+ &project;
+
+ <properties>
+ <author email="[EMAIL PROTECTED]">Craig McClanahan</author>
+ <author email="[EMAIL PROTECTED]">Amy Roh</author>
+ <title>Tomcat MBean Names</title>
+ <revision>$Id: mbean-names.xml 303281 2004-09-27 16:00:31Z yoavs
$</revision>
+ </properties>
+
+<body>
+
+
+<section name="Background">
+
+ <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>
+
+</section>
+
+<section name="Catalina Object Hierarchy">
+
+<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 / DefaultContext</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td><code>type=${DEFAULT-CONTEXT}, service=${service.name}</code></td>
+ </tr>
+
+<!--
+ <tr>
+ <td>Server / Service / Engine / DefaultContext / InstanceListener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / DefaultContext / Listener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td><code>type=${LISTENER}, sequence=${###}</code></td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / DefaultContext / Loader</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / DefaultContext / Manager</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / DefaultContext / Realm</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / DefaultContext / Resources</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / DefaultContext / Valve</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / DefaultContext / WrapperLifecycle</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / DefaultContext / WrapperListener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td></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}, path=${path}, 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=${###}, path=${context.path},
+ 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=${###}, path=${context.path},
+ 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}, path=${context.path}, 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}, path=${context.path}, 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}, path=${context.path}, 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}, path=${context.path}, 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=${###}, path=${context.path},
+ host=${host.name}, service=${service.name}</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=${###}, path=${context.path},
+ 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=${###}, path=${context.path},
+ host=${host.name}, service=${service.name}</code></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / DefaultContext</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td><code>type=DefaultContext, host=${host.name},
+ service=${service.name}</code></td>
+ </tr>
+
+<!--
+ <tr>
+ <td>Server / Service / Engine / Host / DefaultContext /
InstanceListener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / DefaultContext / Listener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / DefaultContext / Loader</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / DefaultContext / Manager</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / DefaultContext / Realm</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / DefaultContext / Resources</td>
+ <td align="center">0..1</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / DefaultContext / Valve</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / DefaultContext /
WrapperLifecycle</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>Server / Service / Engine / Host / DefaultContext /
WrapperListener</td>
+ <td align="center">0..n</td>
+ <td align="center">(none)</td>
+ <td></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>
+
+</section>
+
+<section name="MBean Groups and Names">
+
+<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>DefaultContext</code></td>
+ <td align="center"><code>DEFAULT-CONTEXT</code></td>
+ <td><code>org.apache.catalina.DefaultContext</code></td>
+ <td><code>org.apache.catalina.core.StandardDefaultContext</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>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>
+
+</section>
+
+<section name="JSR-77 Cross Reference">
+
+<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><strong>FIXME</strong> - Not yet identified as an MBean</td>
+ </tr>
+
+ <tr>
+ <td><code>WebModule</code></td>
+ <td><code>${CONTEXT}</code></td>
+ <td></td>
+ </tr>
+
+</table>
+
+</section>
+
+<section name="JSR-88 Cross Reference">
+
+<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>
+
+</section>
+
+</body>
+
+</document>
Propchange: tomcat/tc6.0.x/trunk/webapps/docs/funcspecs/mbean-names.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tomcat/tc6.0.x/trunk/webapps/docs/funcspecs/project.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/funcspecs/project.xml?rev=420006&view=auto
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/funcspecs/project.xml (added)
+++ tomcat/tc6.0.x/trunk/webapps/docs/funcspecs/project.xml Fri Jul 7 15:40:04
2006
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="Catalina Functional Specifications"
+ href="http://jakarta.apache.org/tomcat/";>
+
+ <title>Catalina Functional Specifications</title>
+
+ <logo href="/images/tomcat.gif">
+ Catalina Functional Specifications
+ </logo>
+
+ <body>
+
+ <menu name="Links">
+ <item name="Docs Home" href="../../index.html"/>
+ <item name="Functional Specs" href="index.html"/>
+ </menu>
+
+ <menu name="Administrative Apps">
+ <item name="Overall Requirements" href="fs-admin-apps.html"/>
+ <item name="Tomcat MBean Names" href="mbean-names.html"/>
+ <item name="Administered Objects" href="fs-admin-objects.html"/>
+ <item name="Supported Operations" href="fs-admin-opers.html"/>
+ </menu>
+
+ <menu name="Internal Servlets">
+ <item name="Default Servlet" href="fs-default.html"/>
+ <item name="Invoker Servlet" href="fs-invoker.html"/>
+ </menu>
+
+ <menu name="Realm Implementations">
+ <item name="JDBC Realm" href="fs-jdbc-realm.html"/>
+ <item name="JNDI Realm" href="fs-jndi-realm.html"/>
+ <item name="Memory Realm" href="fs-memory-realm.html"/>
+ </menu>
+
+
+ </body>
+
+</project>
Propchange: tomcat/tc6.0.x/trunk/webapps/docs/funcspecs/project.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tomcat/tc6.0.x/trunk/webapps/docs/html-manager-howto.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/html-manager-howto.xml?rev=420006&view=auto
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/html-manager-howto.xml (added)
+++ tomcat/tc6.0.x/trunk/webapps/docs/html-manager-howto.xml Fri Jul 7
15:40:04 2006
@@ -0,0 +1,543 @@
+<?xml version="1.0"?>
+<!DOCTYPE document [
+ <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="html-manager-howto.html">
+
+ &project;
+
+ <properties>
+ <author email="[EMAIL PROTECTED]">Glenn L. Nielsen</author>
+ <title>Tomcat Web Application Manager How To</title>
+ </properties>
+
+<body>
+
+<section name="Introduction">
+
+<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 five sections:
+<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>Server Information</strong> - Information about the Tomcat
+ server.</li>
+</ul>
+</p>
+
+</section>
+
+<section name="Message">
+
+<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>
+
+</section>
+
+<section name="Manager">
+
+<p>The Manager section has three links:
+<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>
+</p>
+
+</section>
+
+<section name="Applications">
+
+<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:
+<ul>
+ <li><strong>Path</strong> - The web applicaton 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>
+</p>
+
+<subsection name="Start">
+
+<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>
+<source>
+OK - Started application at context path /examples
+</source>
+
+<p>Otherwise, the Message will start with <code>FAIL</code> and include an
+error message. Possible causes for problems include:
+<ul>
+<li><em>Encountered exception</em>
+ <blockquote>
+ <p>An exception was encountered trying to start the web application.
+ Check the Tomcat 5 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>
+</p>
+
+</subsection>
+
+<subsection name="Stop">
+
+<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>
+<source>
+OK - Stopped application at context path /examples
+</source>
+
+<p>Otherwise, the Message will start with <code>FAIL</code> and include an
+error message. Possible causes for problems include:
+<ul>
+<li><em>Encountered exception</em>
+ <blockquote>
+ <p>An exception was encountered trying to stop the web application.
+ Check the Tomcat 5 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>
+</p>
+
+</subsection>
+
+<subsection name="Reload">
+
+<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>
+<source>
+OK - Reloaded application at context path /examples
+</source>
+
+<p>Otherwise, the Message will start with <code>FAIL</code> and include an
+error message. Possible causes for problems include:
+<ul>
+<li><em>Encountered exception</em>
+ <blockquote>
+ <p>An exception was encountered trying to restart the web application.
+ Check the Tomcat 5 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>
+</p>
+
+</subsection>
+
+<subsection name="Undeploy">
+
+<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>
+<source>
+OK - Undeployed application at context path /examples
+</source>
+
+<p>Otherwise, the Message will start with <code>FAIL</code> and include an
+error message. Possible causes for problems include:
+<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>
+</p>
+
+</subsection>
+
+</section>
+
+<section name="Deploy">
+
+<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>
+
+<subsection name="Deploy directory or WAR file located on server">
+
+<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>.
+<source>
+Context Path: /footoo
+WAR or Directory URL: file:C:/path/to/foo
+</source>
+</p>
+
+<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.
+<source>
+WAR or Directory URL: jar:file:/path/to/bar.war!/
+</source>
+</p>
+
+<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.
+<source>
+WAR or Directory URL: foo
+</source>
+</p>
+
+<p>In this example the ".war" file <code>bar.war</code> located in your
+Host appBase directory on the Tomcat server is deployed as the web
+application context named <code>/bartoo</code>.
+<source>
+Context Path: /bartoo
+WAR or Directory URL: bar.war
+</source>
+</p>
+
+<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:
+<source>
+<Context path="/foobar" docBase="C:\path\to\application\foobar"
+ debug="0">
+
+ <!-- Link to the user database we will get roles from -->
+ <ResourceLink name="users" global="UserDatabase"
+ type="org.apache.catalina.UserDatabase"/>
+
+</Context>
+</source>
+</p>
+
+<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.
+<source>
+XML Configuration file URL: file:C:/path/to/context.xml
+</source>
+</p>
+
+<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).
+<source>
+XML Configuration file URL: file:/path/to/context.xml
+WAR or Directory URL: jar:file:/path/to/bar.war!/
+</source>
+</p>
+
+</subsection>
+
+<subsection name="Upload a WAR file to install">
+
+<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>
+
+</subsection>
+
+<subsection name="Deployment Notes">
+
+<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 or
+liveDeploy=true, the Context path must match the directory name or
+war file name without the ".war" extension.</p>
+
+<p>For security when untrusted users can manage web applications, the
+Host deployXML flag can be set to false. This prevents untrusted users
+from 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>
+
+</subsection>
+
+<subsection name="Deploy Message">
+
+<p>If deployment and startup is successful, you will receive a Message
+like this:</p>
+<source>
+OK - Deployed application at context path /foo
+</source>
+
+<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 5 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 or
+ liveDeploy=true, the Context path must match the directory name or
+ war file name without the ".war" extension.
+ </blockquote></li>
+<li><em>Only web applications in the Host web application directory can
+ be 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>
+
+</subsection>
+</section>
+
+<section name="Server Information">
+
+<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>
+
+</section>
+
+</body>
+
+</document>
Propchange: tomcat/tc6.0.x/trunk/webapps/docs/html-manager-howto.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tomcat/tc6.0.x/trunk/webapps/docs/images/add.gif
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/images/add.gif?rev=420006&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tomcat/tc6.0.x/trunk/webapps/docs/images/add.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tomcat/tc6.0.x/trunk/webapps/docs/images/asf-logo.gif
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/images/asf-logo.gif?rev=420006&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tomcat/tc6.0.x/trunk/webapps/docs/images/asf-logo.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tomcat/tc6.0.x/trunk/webapps/docs/images/code.gif
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/images/code.gif?rev=420006&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tomcat/tc6.0.x/trunk/webapps/docs/images/code.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tomcat/tc6.0.x/trunk/webapps/docs/images/design.gif
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/images/design.gif?rev=420006&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tomcat/tc6.0.x/trunk/webapps/docs/images/design.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tomcat/tc6.0.x/trunk/webapps/docs/images/docs.gif
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/images/docs.gif?rev=420006&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tomcat/tc6.0.x/trunk/webapps/docs/images/docs.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tomcat/tc6.0.x/trunk/webapps/docs/images/fix.gif
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/images/fix.gif?rev=420006&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tomcat/tc6.0.x/trunk/webapps/docs/images/fix.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tomcat/tc6.0.x/trunk/webapps/docs/images/printer.gif
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/images/printer.gif?rev=420006&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tomcat/tc6.0.x/trunk/webapps/docs/images/printer.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tomcat/tc6.0.x/trunk/webapps/docs/images/tomcat.gif
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/images/tomcat.gif?rev=420006&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tomcat/tc6.0.x/trunk/webapps/docs/images/tomcat.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
