JDK-4853303 : Annotations to define MBean*Info descriptions and MBeanOperationInfo impact
  • Type: Enhancement
  • Component: core-svc
  • Sub-Component: javax.management
  • Affected Version: 6
  • Priority: P4
  • Status: Closed
  • Resolution: Duplicate
  • OS: generic
  • CPU: generic
  • Submitted: 2003-04-24
  • Updated: 2008-01-24
  • Resolved: 2008-01-24
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
Related Reports
Duplicate :  
Relates :  
Relates :  
Relates :  
It would be extremely useful if JMX's Standard MBeans could include
a description for attributes, operations, and parameters.  Currently,
descriptions are possible with Dynamic MBeans but not Standard ones.

The metadata language feature defined by JSR 175 would be ideal
for this purpose.

The proposed tag would be @Description.  It could be defined either as
a general-purpose tag in, e.g., java.lang.metadata, or as a JMX-specific
tag in javax.management.  The definition would be this:

@Documented @RuntimeVisible
public @interface Description {
    String value();

Additionally, but less importantly, a JMX-specific tag could
describe the impact of an operation (INFO, ACTION, ACTION_INFO),
as defined by MBeanOperationInfo.getImpact():

@Documented @RuntimeVisible @Target({ElementType.METHOD})
public @interface OperationImpact {
    int value();

This would be in javax.management.

EVALUATION This is subsumed into the more general CR 6323980, which covers defining MBeans with annotations, and includes @Description as a special case.

EVALUATION This feature is postponed to Dolphin (Java SE 7). However, annotations can be used to specify the contents of Descriptors (see RFE 6221321) and this can easily be used by subclassing javax.management.StandardMBean to pull the values out of the Descriptors and into the description or impact. Also see <http://weblogs.java.net/blog/emcmanus/archive/2005/07/adding_informat.html>.

CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: mustang


EVALUATION Cannot change this in J2SE 1.5 because of required compatibility with J2EE 1.4. Revisit in Mustang. ###@###.### 2004-02-10