tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From violet...@apache.org
Subject svn commit: r1755717 - in /tomcat/trunk/webapps/docs: changelog.xml index.xml mbeans-descriptor-howto.xml mbeans-descriptors-howto.xml project.xml realm-howto.xml
Date Wed, 10 Aug 2016 10:45:42 GMT
Author: violetagg
Date: Wed Aug 10 10:45:42 2016
New Revision: 1755717

URL: http://svn.apache.org/viewvc?rev=1755717&view=rev
Log:
MBeans Descriptors How-To is moved to mbeans-descriptors-howto.html. Patch provided by Radoslav
Husar. This solves Github PR#33

Added:
    tomcat/trunk/webapps/docs/mbeans-descriptors-howto.xml   (with props)
Removed:
    tomcat/trunk/webapps/docs/mbeans-descriptor-howto.xml
Modified:
    tomcat/trunk/webapps/docs/changelog.xml
    tomcat/trunk/webapps/docs/index.xml
    tomcat/trunk/webapps/docs/project.xml
    tomcat/trunk/webapps/docs/realm-howto.xml

Modified: tomcat/trunk/webapps/docs/changelog.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/changelog.xml?rev=1755717&r1=1755716&r2=1755717&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/trunk/webapps/docs/changelog.xml Wed Aug 10 10:45:42 2016
@@ -175,6 +175,11 @@
         <code>SSLHostConfig</code> element in the configuration documentation.
         (markt)
       </fix>
+      <fix>
+        MBeans Descriptors How-To is moved to
+        <code>mbeans-descriptors-howto.html</code>. Patch provided by Radoslav
+        Husar. (violetagg)
+      </fix>
     </changelog>
   </subsection>
   <subsection name="jdbc-pool">

Modified: tomcat/trunk/webapps/docs/index.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/index.xml?rev=1755717&r1=1755716&r2=1755717&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/index.xml (original)
+++ tomcat/trunk/webapps/docs/index.xml Wed Aug 10 10:45:42 2016
@@ -101,7 +101,7 @@ Apache Tomcat, and using many of the Apa
 <li><a href="proxy-howto.html"><strong>Proxy Support</strong></a>
-
     Configuring Apache Tomcat to run behind a proxy server (or a web server
     functioning as a proxy server).</li>
-<li><a href="mbeans-descriptor-howto.html"><strong>MBean Descriptor</strong></a>
-
+<li><a href="mbeans-descriptors-howto.html"><strong>MBeans Descriptors</strong></a>
-
     Configuring MBean descriptors files for custom components.</li>
 <li><a href="default-servlet.html"><strong>Default Servlet</strong></a>
-
     Configuring the default servlet and customizing directory listings.</li>

Added: tomcat/trunk/webapps/docs/mbeans-descriptors-howto.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/mbeans-descriptors-howto.xml?rev=1755717&view=auto
==============================================================================
--- tomcat/trunk/webapps/docs/mbeans-descriptors-howto.xml (added)
+++ tomcat/trunk/webapps/docs/mbeans-descriptors-howto.xml Wed Aug 10 10:45:42 2016
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document [
+  <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="mbeans-descriptors-howto.html">
+
+    &project;
+
+    <properties>
+        <author email="amyroh@apache.org">Amy Roh</author>
+        <title>MBeans Descriptors How To</title>
+    </properties>
+
+<body>
+
+<section name="Table of Contents">
+<toc/>
+</section>
+
+<section name="Introduction">
+
+<p>Tomcat uses JMX MBeans as the technology for implementing
+manageability of Tomcat.</p>
+
+<p>The descriptions of JMX MBeans for Catalina are in the mbeans-descriptors.xml
+file in each package.</p>
+
+<p>You will need to add MBean descriptions for your custom components
+in order to avoid a "ManagedBean is not found" exception.</p>
+
+</section>
+
+<section name="Adding MBean descriptions">
+
+<p>You may also add MBean descriptions for custom components in
+a mbeans-descriptors.xml file, located in the same package as the class files
+it describes.</p>
+
+<source><![CDATA[  <mbean         name="LDAPRealm"
+            className="org.apache.catalina.mbeans.ClassNameMBean"
+          description="Custom LDAPRealm"
+               domain="Catalina"
+                group="Realm"
+                 type="com.myfirm.mypackage.LDAPRealm">
+
+    <attribute   name="className"
+          description="Fully qualified class name of the managed object"
+                 type="java.lang.String"
+            writeable="false"/>
+
+    <attribute   name="debug"
+          description="The debugging detail level for this component"
+                 type="int"/>
+    .
+    .
+    .
+
+  </mbean>]]></source>
+
+
+</section>
+
+</body>
+
+</document>

Propchange: tomcat/trunk/webapps/docs/mbeans-descriptors-howto.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: tomcat/trunk/webapps/docs/project.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/project.xml?rev=1755717&r1=1755716&r2=1755717&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/project.xml (original)
+++ tomcat/trunk/webapps/docs/project.xml Wed Aug 10 10:45:42 2016
@@ -51,8 +51,8 @@
         <item name="13) SSI"                href="ssi-howto.html"/>
         <item name="14) CGI"                href="cgi-howto.html"/>
         <item name="15) Proxy Support"      href="proxy-howto.html"/>
-        <item name="16) MBean Descriptor"
-              href="mbeans-descriptor-howto.html"/>
+        <item name="16) MBeans Descriptors"
+              href="mbeans-descriptors-howto.html"/>
         <item name="17) Default Servlet"    href="default-servlet.html"/>
         <item name="18) Clustering"         href="cluster-howto.html"/>
         <item name="19) Load Balancer"      href="balancer-howto.html"/>

Modified: tomcat/trunk/webapps/docs/realm-howto.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/realm-howto.xml?rev=1755717&r1=1755716&r2=1755717&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/realm-howto.xml (original)
+++ tomcat/trunk/webapps/docs/realm-howto.xml Wed Aug 10 10:45:42 2016
@@ -109,7 +109,7 @@ and integrate it with Tomcat.  To do so,
   <li>Implement <code>org.apache.catalina.Realm</code>,</li>
   <li>Place your compiled realm in $CATALINA_HOME/lib,</li>
   <li>Declare your realm as described in the "Configuring a Realm" section below,</li>
-  <li>Declare your realm to the <a href="mbeans-descriptor-howto.html">MBeans
Descriptor</a>.</li>
+  <li>Declare your realm to the <a href="mbeans-descriptors-howto.html">MBeans
Descriptors</a>.</li>
 </ul>
 
 </subsection>



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Mime
View raw message