Attachment 35489 Details for Bug 61223 – Updated patch file for individual file as suggested.

[patch] Updated patch file for individual file as suggested.

mbean-descriptors-howto.patch (text/plain), 7.25 KB, created by Kapil on 2017-11-05 16:41:55 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Kapil

Created: 2017-11-05 16:41:55 UTC

Size: 7.25 KB

patch

obsolete

>--- mbeans-descriptors-howto.xml	2017-10-27 21:51:58.155120500 +0530
>+++ mbeans-descriptors-howto-updated.xml	2017-11-05 09:40:21.282582900 +0530
>@@ -1,86 +1,126 @@
>-<?xml version="1.0" encoding="UTF-8"?>
>-
>-<!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>
>+<?xml version="1.0" encoding="UTF-8"?>
>+
>+<!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 "mbeans-descriptors" element is the root of the configuration file
>+hierarchy, and contains nested elements for all of the other
>+configuration settings.  Remaining element definitions are listed
>+in alphabetical order.
>+
>+<![CDATA[ <!ELEMENT mbeans-descriptors (mbean*)>
>+<!ATTLIST mbeans-descriptors id          ID             #IMPLIED> ]]>
>+</p>
>+
>+<p>The "mbean" element describes a particular JMX ModelMBean implementation,
>+including the information necessary to construct the corresponding
>+ModelMBeanInfo structures.  The following attributes are supported:
>+
>+     className        Fully qualified Java class name of the ModelMBean
>+                      implementation class.  If not specified, the standard
>+                      implementation provided by JMX will be utilized.
>+
>+     description      Human-readable description of this managed bean.
>+
>+     domain           The JMX MBeanServer domain in which the ModelMBean
>+                      created by this managed bean should be registered,
>+                      when creating its ObjectName.
>+
>+     group            Optional name of a "grouping classification" that can
>+                      be used to select groups of similar MBean implementation
>+                      classes.
>+
>+     name             Unique name of this MBean (normally corresponds to the
>+                      base class name of the corresponding server component).
>+
>+     type             Fully qualified Java class name of the underlying
>+                      managed resource implementation class.
>+<![CDATA[ <!ELEMENT mbean (descriptor?, attribute*, constructor*, notification*, operation*)
>+<!ATTLIST mbean             id           ID             #IMPLIED>
>+<!ATTLIST mbean             className    %ClassName;    #IMPLIED>
>+<!ATTLIST mbean             description  CDATA          #IMPLIED>
>+<!ATTLIST mbean             domain       CDATA          #IMPLIED>
>+<!ATTLIST mbean             group        CDATA          #IMPLIED>
>+<!ATTLIST mbean             name         %MethodName;   #IMPLIED>
>+<!ATTLIST mbean             type         %ClassName;    #IMPLIED> ]]>
>+</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>

Actions: View | Diff

Attachments on bug 61223: 35469 | 35489