ASF Bugzilla – Attachment 35469 Details for
Bug 61223
Enhance the documentation for mbeans-descriptors.xml
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
Remember
[x]
|
Forgot Password
Login:
[x]
[patch]
Updated mbeans-descriptors-howto.xml
mbeans-descriptors-howto.xml (text/plain), 4.18 KB, created by
Kapil
on 2017-10-27 03:06:41 UTC
(
hide
)
Description:
Updated mbeans-descriptors-howto.xml
Filename:
MIME Type:
Creator:
Kapil
Created:
2017-10-27 03:06:41 UTC
Size:
4.18 KB
patch
obsolete
><?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 "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>
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
Attachments on
bug 61223
: 35469 |
35489