Apache Tomcat 7 (7.0.109) - MBeans Descriptors How To
Author: Amy Roh

| # Apache Tomcat 7 Version 7.0.109, Apr 22 2021 |

Links Docs Home FAQ User Comments User Guide 1) Introduction 2) Setup 3) First webapp 4) Deployer 5) Manager 6) Host Manager 7) Realms and AAA 8) Security Manager 9) JNDI Resources 10) JDBC DataSources 11) Classloading 12) JSPs 13) SSL/TLS 14) SSI 15) CGI 16) Proxy Support 17) MBeans Descriptors 18) Default Servlet 19) Clustering 20) Load Balancer 21) Connectors 22) Monitoring and Management 23) Logging 24) APR/Native 25) Virtual Hosting 26) Advanced IO 27) Additional Components 28) Mavenized 29) Security Considerations 30) Windows Service 31) Windows Authentication 32) Tomcat's JDBC Pool 33) WebSocket Reference Release Notes Configuration Tomcat Javadocs Servlet Javadocs JSP 2.2 Javadocs EL 2.2 Javadocs WebSocket 1.1 Javadocs Common Annotations 1.1 Javadocs JK 1.2 Documentation Apache Tomcat Development Building Changelog Status Developers Architecture Tribes | # MBeans Descriptors How To
Table of Contents
Introduction Adding MBean descriptions
Introduction
Tomcat uses JMX MBeans as the technology for implementing manageability of Tomcat. The descriptions of JMX MBeans for Catalina are in the mbeans-descriptors.xml file in each package. You will need to add MBean descriptions for your custom components in order to avoid a "ManagedBean is not found" exception.
Adding MBean descriptions
> You may also add MBean descriptions for custom components in an mbeans-descriptors.xml file, located in the same package as the class files it describes. The permitted syntax for the mbeans-descriptors.xml is defined by the DTD file. The entries for a custom LDAP authentication Realm may look like this:
>       <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>
Copyright © 1999-2021, Apache Software Foundation