From 6ddee4ed684e181f53065ed00b7a32608074ea4b Mon Sep 17 00:00:00 2001
From: markt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Date: Mon, 22 Nov 2010 11:46:46 +0000
Subject: [PATCH] Update docs to new MBean names

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@1037682 13f79535-47bb-0310-9956-ffa450edef68
---
 .../catalina/ant/jmx/JMXAccessorInvokeTask.java    |  4 +--
 .../catalina/ant/jmx/JMXAccessorSetTask.java       |  2 +-
 webapps/docs/cluster-howto.xml                     |  8 +++---
 webapps/docs/funcspecs/mbean-names.xml             | 29 ++++++++++++----------
 webapps/docs/monitoring.xml                        | 22 ++++++++--------
 5 files changed, 34 insertions(+), 31 deletions(-)

diff --git a/java/org/apache/catalina/ant/jmx/JMXAccessorInvokeTask.java b/java/org/apache/catalina/ant/jmx/JMXAccessorInvokeTask.java
index 7004aef6d..e7a087882 100644
--- a/java/org/apache/catalina/ant/jmx/JMXAccessorInvokeTask.java
+++ b/java/org/apache/catalina/ant/jmx/JMXAccessorInvokeTask.java
@@ -44,10 +44,10 @@ import org.apache.tools.ant.BuildException;
  * <ul>
  * <li>
  * Get a session attribute hello from session with ref <em>${sessionid.0}</em> form 
- * app <em>Catalina:type=Manager,path=/ClusterTest,host=localhost</em> 
+ * app <em>Catalina:type=Manager,context=/ClusterTest,host=localhost</em> 
  * <pre>
  *   &lt;jmx:invoke
- *           name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
+ *           name="Catalina:type=Manager,context=/ClusterTest,host=localhost" 
  *           operation="getSessionAttribute"
  *           resultproperty="hello"&gt;
  *         &lt;arg value="${sessionid.0}"/&gt;
diff --git a/java/org/apache/catalina/ant/jmx/JMXAccessorSetTask.java b/java/org/apache/catalina/ant/jmx/JMXAccessorSetTask.java
index ae7e3eb6c..9c3a3aec4 100644
--- a/java/org/apache/catalina/ant/jmx/JMXAccessorSetTask.java
+++ b/java/org/apache/catalina/ant/jmx/JMXAccessorSetTask.java
@@ -44,7 +44,7 @@ import org.apache.tools.ant.BuildException;
  *           host="127.0.0.1"
  *           port="9014"
  *           ref=""
- *           name="Catalina:type=Manager,path="/ClusterTest",host=localhost" 
+ *           name="Catalina:type=Manager,context="/ClusterTest",host=localhost" 
  *           attribute="maxActiveSessions"
  *           value="100"
  *           type="int"
diff --git a/webapps/docs/cluster-howto.xml b/webapps/docs/cluster-howto.xml
index 03afde6fe..3e8824c48 100644
--- a/webapps/docs/cluster-howto.xml
+++ b/webapps/docs/cluster-howto.xml
@@ -666,8 +666,8 @@ List of Cluster Mbeans<br/>
   <tr>
     <td>DeltaManager</td>
     <td>This manager control the sessions and handle session replication </td>
-    <td><code>type=Manager,path=${APP.CONTEXT.PATH}, host=${HOST}</code></td>
-    <td><code>type=Manager,path=${APP.CONTEXT.PATH}, host=${HOST}</code></td>
+    <td><code>type=Manager,context=${APP.CONTEXT.PATH}, host=${HOST}</code></td>
+    <td><code>type=Manager,context=${APP.CONTEXT.PATH}, host=${HOST}</code></td>
   </tr>
 
   <tr>
@@ -681,9 +681,9 @@ List of Cluster Mbeans<br/>
     <td>JvmRouteBinderValve</td>
     <td>This is a cluster fallback valve to change the Session ID to the current tomcat jvmroute.</td>
     <td><code>type=Valve,name=JvmRouteBinderValve,
-              path=${APP.CONTEXT.PATH}</code></td>
+              context=${APP.CONTEXT.PATH}</code></td>
     <td><code>type=Valve,name=JvmRouteBinderValve,host=${HOST},
-              path=${APP.CONTEXT.PATH}</code></td>
+              context=${APP.CONTEXT.PATH}</code></td>
   </tr>
 
 </table>
diff --git a/webapps/docs/funcspecs/mbean-names.xml b/webapps/docs/funcspecs/mbean-names.xml
index 088a7a7db..25e3c2034 100644
--- a/webapps/docs/funcspecs/mbean-names.xml
+++ b/webapps/docs/funcspecs/mbean-names.xml
@@ -169,7 +169,7 @@ corresponding values:</p>
     <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},
+    <td><code>type=${CONTEXT}, context=${name}, host=${host.name},
         service=${service.name}</code></td>
   </tr>
 
@@ -177,15 +177,16 @@ corresponding values:</p>
     <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>
+    <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=${###}, path=${context.path},
+    <td><code>type=${LISTENER}, sequence=${###}, context=${context.name},
         host=${host.name}, service=${service.name}</code></td>
   </tr>
 
@@ -193,7 +194,7 @@ corresponding values:</p>
     <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},
+    <td><code>type=${LOADER}, context=${context.name}, host=${host.name},
         service=${service.name}</code></td>
   </tr>
 
@@ -201,7 +202,7 @@ corresponding values:</p>
     <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},
+    <td><code>type=${MANAGER}, context=${context.name}, host=${host.name},
         service=${service.name}</code></td>
   </tr>
 
@@ -209,7 +210,7 @@ corresponding values:</p>
     <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},
+    <td><code>type=${REALM}, context=${context.name}, host=${host.name},
         service=${service.name}</code></td>
   </tr>
 
@@ -217,7 +218,7 @@ corresponding values:</p>
     <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},
+    <td><code>type=${RESOURCES}, context=${context.name}, host=${host.name},
         service=${service.name}</code></td>
   </tr>
 
@@ -225,7 +226,7 @@ corresponding values:</p>
     <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},
+    <td><code>type=${VALVE}, sequence=${###}, context=${context.name},
         host=${host.name}, service=${service.name}</code></td>
   </tr>
 
@@ -243,16 +244,18 @@ corresponding values:</p>
     <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>
+    <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=${###}, path=${context.path},
-        host=${host.name}, service=${service.name}</code></td>
+    <td><code>type=${WRAPPER-LISTENER}, sequence=${###},
+        context=${context.name}, host=${host.name},
+        service=${service.name}</code></td>
   </tr>
 
   <tr>
diff --git a/webapps/docs/monitoring.xml b/webapps/docs/monitoring.xml
index 017f658a3..f4d2a0fee 100644
--- a/webapps/docs/monitoring.xml
+++ b/webapps/docs/monitoring.xml
@@ -126,7 +126,7 @@ controlRole tomcat
              property &lt;em&gt;clustertest.maxActiveSessions.orginal&lt;/em&gt;
         --&gt;
        &lt;jmx:get
-            name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
+            name="Catalina:type=Manager,context=/ClusterTest,host=localhost" 
             attribute="maxActiveSessions"
             resultproperty="clustertest.maxActiveSessions.orginal"
             echo="true"
@@ -134,7 +134,7 @@ controlRole tomcat
         &lt;!-- set maxActiveSession to 100
         --&gt;
         &lt;jmx:set
-            name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
+            name="Catalina:type=Manager,context=/ClusterTest,host=localhost" 
             attribute="maxActiveSessions"
             value="100"
             type="int"
@@ -143,7 +143,7 @@ controlRole tomcat
              access all session ids directly with Ant property sessions.[0..n].
         --&gt;
         &lt;jmx:invoke
-            name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
+            name="Catalina:type=Manager,context=/ClusterTest,host=localhost" 
             operation="listSessionIds"
             resultproperty="sessions"
             echo="false"
@@ -152,7 +152,7 @@ controlRole tomcat
         &lt;!-- Access session attribute &lt;em&gt;Hello&lt;/em&gt; from first session.
         --&gt;
         &lt;jmx:invoke
-            name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
+            name="Catalina:type=Manager,context=/ClusterTest,host=localhost" 
             operation="getSessionAttribute"
             resultproperty="Hello"
             echo="false"
@@ -391,7 +391,7 @@ List of Attributes<br/>
 Example to get remote MBean attribute from default JMX connection <br/>
 <source>
     &lt;jmx:get
-        name="Catalina:type=Manager,path=/servlets-examples,host=localhost" 
+        name="Catalina:type=Manager,context=/servlets-examples,host=localhost" 
         attribute="maxActiveSessions"
         resultproperty="servlets-examples.maxActiveSessions"
     /&gt;
@@ -493,7 +493,7 @@ List of Attributes<br/>
 Example to set remote MBean attribute value<br/>
 <source>
     &lt;jmx:set
-        name="Catalina:type=Manager,path=/servlets-examples,host=localhost" 
+        name="Catalina:type=Manager,context=/servlets-examples,host=localhost" 
         attribute="maxActiveSessions"
         value="500"
         type="int"
@@ -575,7 +575,7 @@ List of Attributes<br/>
 stop an application <br/>
 <source>
     &lt;jmx:invoke
-        name="Catalina:type=Manager,path=/servlets-examples,host=localhost" 
+        name="Catalina:type=Manager,context=/servlets-examples,host=localhost" 
         operation="stop"/&gt;
 </source>
 Now you can find the sessionid at <em>${sessions.[0..N}</em> properties and access the count
@@ -585,7 +585,7 @@ with ${sessions.length} property.
 Example to get all sessionids <br/>
 <source>
     &lt;jmx:invoke
-        name="Catalina:type=Manager,path=/servlets-examples,host=localhost" 
+        name="Catalina:type=Manager,context=/servlets-examples,host=localhost" 
         operation="listSessionIds"
         resultproperty="sessions"
         delimiter=" "        
@@ -598,7 +598,7 @@ with ${sessions.length} property.
 Example to get remote MBean session attribute from session ${sessionid.0}<br/>
 <source>
     &lt;jmx:invoke
-        name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
+        name="Catalina:type=Manager,context=/ClusterTest,host=localhost" 
         operation="getSessionAttribute"
         resultproperty="hello"&gt;
          &lt;arg value="${sessionid.0}"/&gt;
@@ -704,7 +704,7 @@ properties and access the result object counter with ${manager.length} property.
 Example to get the Manager from <em>servlet-examples</em> application an bind all MBean properties<br/>
 <source>
   &lt;jmx:query
-           name="Catalina:type=Manager,path=/servlet-examples,host=localhost*" 
+           name="Catalina:type=Manager,context=/servlet-examples,host=localhost*" 
            attributebinding="true"
            resultproperty="manager.servletExamples" /&gt;
 </source>
@@ -786,7 +786,7 @@ List of Attributes<br/>
     <td>classLoader</td>
     <td>ObjectName of server or web application classloader <br/>
     ( <em>Catalina:type=ServerClassLoader,name=[server,common,shared]</em> or<br/>
-     <em>Catalina:type=WebappClassLoader,path=/myapps,host=localhost</em>) 
+     <em>Catalina:type=WebappClassLoader,context=/myapps,host=localhost</em>) 
     </td>
     <td></td>
   </tr>
-- 
2.11.0