Description for Standard MBean

Question

I want to make my Standard MBean verbose in JBoss jmx-console. DynamicMBean has getMBeanInfo() to do it. Method return MBeanInfo with description of MBean. But how I can to do the same thing for Standard MBean? E.g. I have following MBean interface:

public interface MyMBean {
  String f();
}

... with following implementation:

public class My implements MyMBean {
  public String f() {
    return "test";
  }
}

What should be done to add description in such example?

Thanks

As I understanding Java Doc for MBeanInfo says that it's possible, but there are no examples and definitions is enough unclear: http://download.oracle.com/javase/1.5.0/docs/api/javax/management/MBeanInfo.html — Raman, Mar 10 '11 at 14:44

score 4 · Accepted Answer · edited Jan 24 '13 at 16:49

For StandardMBeans there is no way for adding description or other meta information.

From the JavaDoc of MBeanInfo:

The remaining details of the MBeanInfo for a Standard MBean are not specified. This includes the description of the MBeanInfo and of any contained constructors, attributes, operations, and notifications; and the names and descriptions of parameters to constructors and operations.

So you need to use at least DynamicMBeans (or a ModelMBean or OpenMBean) for specifying this information. Spring can help you insofar as it allows the creation of DynamicMBeans via annotations, which at the end is even simpler to use than to write own StandardMBeans. Example (from the spring documentation) :

@ManagedResource(objectName="bean:name=testBean4",
                 description="My Managed Bean")
public class AnnotationTestBean {

    private int age;

    @ManagedAttribute(description="The Age Attribute", currencyTimeLimit=15)
    public int getAge() {
        return age;
    }
}

See this article for details.

Note that those annotations are from Spring! So if you don't use Spring, you can't use those annotations either. — Joachim Sauer, Mar 11 '11 at 08:12

score 1 · Answer 2 · edited May 23 '17 at 10:28

1

You can do this via an xmbean-descriptor without the need to modify the existing mbean source code.

See How to add description for MBean method to see it in jmx-console of JBOSS for an answer to this.

edited May 23 '17 at 10:28

Community

1
1

answered Mar 13 '11 at 09:44

Heiko Rupp

30,426
13
82
119

I guess this only works if you declare you MBeans declaratively within JBoss and not when you register them programatically e.g. from within your servlet directly at an MBeanServer. – Roland Huß Mar 15 '11 at 22:18
@Roland Yes. When you want do it programatically, you can still "wrap" the existing StandardMBean where attributes/operations are determined by looking at the MBean Interface and the DynamicMBean as wrapper provides the info -- this is basically what JBoss does; You may even be able to use the class from within JBossAS that does this. – Heiko Rupp Mar 16 '11 at 07:26

Donatello · Answer 3 · 2012-09-06T09:17:09.687

The way to get the description information from Spring annotations @Managed* is just to declare a standard Spring "managed bean", and not an MBean or MXBean.

To do this, in your example, you must not implements the interface with "MBean" suffix. Then, the bean will be detected as a standard "managed bean" when MBeanExporter will registerBeanInstance(..), and will be converted to a ModelMBean using all spring annotations, including descriptions of attributes, operations, parameters, etc..

As a requirement, you should declare in your spring context the MBeanExporter with AnnotationJmxAttributeSource, MetadataNamingStrategy, and MetadataMBeanInfoAssembler attributes, which can be simplified like this :

<bean id="mbeanExporter"
     class="org.springframework.jmx.export.annotation.AnnotationMBeanExporter" />

or

<context:mbean-export />

And your managed bean should look like this (as explained by Roland) :

@Component("myManagedBean")
@ManagedResource(objectName="your.domain.jmx:name=MyMBean",
                 description="My MBean goal")
public class AnnotationTestBean {

    private int age;

    @ManagedAttribute(description="The age attribute", currencyTimeLimit=15)
    public int getAge() {
        return age;
    }

    @ManagedOperation(description = "Check permissions for the given activity")
    @ManagedOperationParameters( {
        @ManagedOperationParameter(name = "activity",
                                   description = "The activity to check")
    })
    public boolean isAllowedTo(final String activity) {
        // impl
    }
}

Remember to not implements an MBean interface, which would be a StandardMBean !!

Description for Standard MBean

3 Answers3

Linked