org.apache.felix.mosgi.jmx.agent.mx4j
Interface MBeanDescription

All Known Implementing Classes:
MBeanDescriptionAdapter

public interface MBeanDescription

Implement this inteface to give descriptions to standard MBean.

The MX4J implementation will look, for every standard MBean, for a class with name composed by the fully qualified MBean class name + "MBeanDescription". If such a class is found, the MX4J implementation will call its methods to retrieve description information about the MBean itself. MBean descriptions are built-in in DynamicMBean, but not in standard MBeans. The XDoclet tool is used to automate the process of generating the MBeanDescription classes for a given MBean, along with the MBean interface.

Version:
$Revision: 1.1.1.1 $
Author:
Simone Bordet

Method Summary
 String getAttributeDescription(String attribute)
          Should return the description for the specified attribute.
 String getConstructorDescription(Constructor ctor)
          Should return the description for the given constructor of the MBean.
 String getConstructorParameterDescription(Constructor ctor, int index)
          Should return the description for the constructor's parameter for the given constructor and parameter index.
 String getConstructorParameterName(Constructor ctor, int index)
          Should return the name of the constructor's parameter for the given constructor and parameter index.
 String getMBeanDescription()
          Should return the description of the MBean.
 String getOperationDescription(Method operation)
          Should return the description for the specified operation.
 String getOperationParameterDescription(Method method, int index)
          Should return the description for the operations's parameter for the given operation and parameter index.
 String getOperationParameterName(Method method, int index)
          Should return the name of the operation's parameter for the given operation and parameter index.
 

Method Detail

getMBeanDescription

String getMBeanDescription()
Should return the description of the MBean. For example: "This MBean is the rmiregistry service"


getConstructorDescription

String getConstructorDescription(Constructor ctor)
Should return the description for the given constructor of the MBean. For example: "Creates an rmiregistry instance on the specified port"


getConstructorParameterName

String getConstructorParameterName(Constructor ctor,
                                   int index)
Should return the name of the constructor's parameter for the given constructor and parameter index. For example: "port"


getConstructorParameterDescription

String getConstructorParameterDescription(Constructor ctor,
                                          int index)
Should return the description for the constructor's parameter for the given constructor and parameter index. For example: "The port on which the rmiregistry will wait on for client requests"


getAttributeDescription

String getAttributeDescription(String attribute)
Should return the description for the specified attribute. For example: "The port on which the rmiregistry will wait on for client requests"


getOperationDescription

String getOperationDescription(Method operation)
Should return the description for the specified operation. For example: "Binds the given object to the given name"


getOperationParameterName

String getOperationParameterName(Method method,
                                 int index)
Should return the name of the operation's parameter for the given operation and parameter index. For example: "bindName"


getOperationParameterDescription

String getOperationParameterDescription(Method method,
                                        int index)
Should return the description for the operations's parameter for the given operation and parameter index. For example: "The name to which the object will be bound to"



Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.