Apache Tomcat 7

Version 7.0.52, Jun 19 2015

Links

User Guide

Reference

Apache Tomcat Development

MBean Descriptor 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-descriptor.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 a mbeans-descriptor.xml file, located in the same package as the class files it describes.

  <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>

Comments

Notice: This comments section collects your suggestions on improving documentation for Apache Tomcat.

If you have trouble and need help, read Find Help page and ask your question on the tomcat-users mailing list. Do not ask such questions here. This is not a Q&A section.

The Apache Comments System is explained here. Comments may be removed by our moderators if they are either implemented or considered invalid/off-topic.