public class

ModelMBeanOperationInfo

extends MBeanOperationInfo
implements DescriptorAccess
java.lang.Object
   ↳ javax.management.MBeanFeatureInfo
     ↳ javax.management.MBeanOperationInfo
       ↳ javax.management.modelmbean.ModelMBeanOperationInfo

Class Overview

The ModelMBeanOperationInfo object describes a management operation of the ModelMBean. It is a subclass of MBeanOperationInfo with the addition of an associated Descriptor and an implementation of the DescriptorAccess interface.

 The fields in the descriptor are defined, but not limited to, the following:
 name           : operation name
 descriptorType : must be "operation"
 class          : class where method is defined (fully qualified)
 role           : must be "operation", "getter", or "setter
 targetObject   : object on which to execute this method
 targetType     : type of object reference for targetObject. Can be: ObjectReference | Handle | EJBHandle | IOR | RMIReference.
 value          : cached value for operation
 currencyTimeLimit : how long cached value is valid
 lastUpdatedTimeStamp : when cached value was set
 visibility            : 1-4 where 1: always visible 4: rarely visible
 presentationString :  xml formatted string to describe how to present operation
 
The default descriptor will have name, descriptorType, displayName and role fields set.

Note: because of inconsistencies in previous versions of this specification, it is recommended not to use negative or zero values for currencyTimeLimit. To indicate that a cached value is never valid, omit the currencyTimeLimit field. To indicate that it is always valid, use a very large number for this field.

The serialVersionUID of this class is 6532732096650090465L.

Summary

[Expand]
Inherited Constants
From class javax.management.MBeanOperationInfo
[Expand]
Inherited Fields
From class javax.management.MBeanFeatureInfo
Public Constructors
ModelMBeanOperationInfo(String description, Method operationMethod)
Constructs a ModelMBeanOperationInfo object with a default descriptor.
ModelMBeanOperationInfo(String description, Method operationMethod, Descriptor descriptor)
Constructs a ModelMBeanOperationInfo object.
ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact)
Constructs a ModelMBeanOperationInfo object with a default descriptor.
ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)
Constructs a ModelMBeanOperationInfo object.
ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)
Constructs a new ModelMBeanOperationInfo object from this ModelMBeanOperation Object.
Public Methods
Object clone()
Creates and returns a new ModelMBeanOperationInfo which is a duplicate of this ModelMBeanOperationInfo.
Descriptor getDescriptor()
Returns a copy of the associated Descriptor of the ModelMBeanOperationInfo.
void setDescriptor(Descriptor inDescriptor)
Sets associated Descriptor (full replace) for the ModelMBeanOperationInfo If the new Descriptor is null, then the associated Descriptor reverts to a default descriptor.
String toString()
Returns a string containing the entire contents of the ModelMBeanOperationInfo in human readable form.
[Expand]
Inherited Methods
From class javax.management.MBeanOperationInfo
From class javax.management.MBeanFeatureInfo
From class java.lang.Object
From interface javax.management.DescriptorAccess
From interface javax.management.DescriptorRead

Public Constructors

public ModelMBeanOperationInfo (String description, Method operationMethod)

Constructs a ModelMBeanOperationInfo object with a default descriptor. The Descriptor of the constructed object will include fields contributed by any annotations on the Method object that contain the DescriptorKey meta-annotation.

Parameters
description A human readable description of the operation.
operationMethod The java.lang.reflect.Method object describing the MBean operation.

public ModelMBeanOperationInfo (String description, Method operationMethod, Descriptor descriptor)

Constructs a ModelMBeanOperationInfo object. The Descriptor of the constructed object will include fields contributed by any annotations on the Method object that contain the DescriptorKey meta-annotation.

Parameters
description A human readable description of the operation.
operationMethod The java.lang.reflect.Method object describing the MBean operation.
descriptor An instance of Descriptor containing the appropriate metadata for this instance of the ModelMBeanOperationInfo. If it is null a default descriptor will be created. If the descriptor does not contain the fields "displayName" or "role" these fields are added in the descriptor with their default values.
Throws
RuntimeOperationsException Wraps an IllegalArgumentException. The descriptor is invalid; or descriptor field "name" is not equal to operation name; or descriptor field "DescriptorType" is not equal to "operation"; or descriptor optional field "role" is not equal to "operation", "getter", or "setter".

public ModelMBeanOperationInfo (String name, String description, MBeanParameterInfo[] signature, String type, int impact)

Constructs a ModelMBeanOperationInfo object with a default descriptor.

Parameters
name The name of the method.
description A human readable description of the operation.
signature MBeanParameterInfo objects describing the parameters(arguments) of the method.
type The type of the method's return value.
impact The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.

public ModelMBeanOperationInfo (String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)

Constructs a ModelMBeanOperationInfo object.

Parameters
name The name of the method.
description A human readable description of the operation.
signature MBeanParameterInfo objects describing the parameters(arguments) of the method.
type The type of the method's return value.
impact The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
descriptor An instance of Descriptor containing the appropriate metadata. for this instance of the MBeanOperationInfo.If it is null then a default descriptor will be created. If the descriptor does not contain the fields "displayName" or "role" these fields are added in the descriptor with their default values.
Throws
RuntimeOperationsException Wraps an IllegalArgumentException. The descriptor is invalid; or descriptor field "name" is not equal to operation name; or descriptor field "DescriptorType" is not equal to "operation"; or descriptor optional field "role" is not equal to "operation", "getter", or "setter".

public ModelMBeanOperationInfo (ModelMBeanOperationInfo inInfo)

Constructs a new ModelMBeanOperationInfo object from this ModelMBeanOperation Object.

Parameters
inInfo the ModelMBeanOperationInfo to be duplicated

Public Methods

public Object clone ()

Creates and returns a new ModelMBeanOperationInfo which is a duplicate of this ModelMBeanOperationInfo.

Returns
  • a clone of this instance.

public Descriptor getDescriptor ()

Returns a copy of the associated Descriptor of the ModelMBeanOperationInfo.

Returns
  • Descriptor associated with the ModelMBeanOperationInfo object.

public void setDescriptor (Descriptor inDescriptor)

Sets associated Descriptor (full replace) for the ModelMBeanOperationInfo If the new Descriptor is null, then the associated Descriptor reverts to a default descriptor. The Descriptor is validated before it is assigned. If the new Descriptor is invalid, then a RuntimeOperationsException wrapping an IllegalArgumentException is thrown.

Parameters
inDescriptor replaces the Descriptor associated with the ModelMBeanOperation.
Throws
RuntimeOperationsException Wraps an IllegalArgumentException for invalid Descriptor.
See Also

public String toString ()

Returns a string containing the entire contents of the ModelMBeanOperationInfo in human readable form.

Returns
  • a string representation of the object.