| java.lang.Object | |||
| ↳ | javax.management.MBeanFeatureInfo | ||
| ↳ | javax.management.MBeanOperationInfo | ||
| ↳ | javax.management.modelmbean.ModelMBeanOperationInfo | ||
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 operationThe 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.
| [Expand] Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|  From class
javax.management.MBeanOperationInfo | |||||||||||
| [Expand] Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|  From class
javax.management.MBeanFeatureInfo | |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Constructs a ModelMBeanOperationInfo object with a default
 descriptor. | |||||||||||
| Constructs a ModelMBeanOperationInfo object. | |||||||||||
| Constructs a ModelMBeanOperationInfo object with a default descriptor. | |||||||||||
| Constructs a ModelMBeanOperationInfo object. | |||||||||||
| Constructs a new ModelMBeanOperationInfo object from this ModelMBeanOperation Object. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Creates and returns a new ModelMBeanOperationInfo which is a duplicate of this ModelMBeanOperationInfo. | |||||||||||
| Returns a copy of the associated Descriptor of the
 ModelMBeanOperationInfo. | |||||||||||
| Sets associated Descriptor (full replace) for the
 ModelMBeanOperationInfo If the new Descriptor is null, then
 the associated Descriptor reverts to a default descriptor. | |||||||||||
| 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 | |||||||||||
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.
| description | A human readable description of the operation. | 
|---|---|
| operationMethod | The java.lang.reflect.Method object describing the MBean operation. | 
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.
| 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. | 
| 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". | 
|---|
Constructs a ModelMBeanOperationInfo object with a default descriptor.
| 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. | 
Constructs a ModelMBeanOperationInfo object.
| 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. | 
| 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". | 
|---|
Constructs a new ModelMBeanOperationInfo object from this ModelMBeanOperation Object.
| inInfo | the ModelMBeanOperationInfo to be duplicated | 
|---|
Creates and returns a new ModelMBeanOperationInfo which is a duplicate of this ModelMBeanOperationInfo.
Returns a copy of the associated Descriptor of the ModelMBeanOperationInfo.
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.
| inDescriptor | replaces the Descriptor associated with the ModelMBeanOperation. | 
|---|
| RuntimeOperationsException | Wraps an IllegalArgumentException for invalid Descriptor. | 
|---|
Returns a string containing the entire contents of the ModelMBeanOperationInfo in human readable form.