mx4j

Interface MBeanDescription

Known Implementing Classes:
CosNamingServiceMBeanDescription, DefaultMBeanServerInterceptorMBeanDescription, HttpAdaptorMBeanDescription, InvokerMBeanServerInterceptorMBeanDescription, JythonRunnerMBeanDescription, MBeanDescriptionAdapter, MBeanServerInterceptorConfiguratorMBeanDescription, NamingServiceMBeanDescription, ObserverStatisticsRecorderMBeanDescription, ProcessorMBeanDescription, SecurityMBeanServerInterceptorMBeanDescription, SSLAdaptorServerSocketFactoryMBeanDescription, StatisticsRecorderMBeanDescription, TimedStatisticsRecorderMBeanDescription, ValueStatisticsRecorderMBeanDescription, XSLTProcessorMBeanDescription

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.5 $

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 Details

getAttributeDescription

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

getConstructorDescription

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

getConstructorParameterDescription

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

getConstructorParameterName

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

getMBeanDescription

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

getOperationDescription

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

getOperationParameterDescription

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

getOperationParameterName

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

Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.