ModelMBeanOperationInfo (Java SE 16 & JDK 16) (original) (raw)

All Implemented Interfaces:

[Serializable](../../../../java.base/java/io/Serializable.html "interface in java.io"), [Cloneable](../../../../java.base/java/lang/Cloneable.html "interface in java.lang"), [DescriptorAccess](../DescriptorAccess.html "interface in javax.management"), [DescriptorRead](../DescriptorRead.html "interface in javax.management")

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. Note that when the Type in this table is Number, a String that is the decimal representation of a Long can also be used.

ModelMBeanOperationInfo Fields

The default descriptor will have name, descriptorType, displayName and role fields set. The default value of the name and displayName fields is the operation name.

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 thecurrencyTimeLimit field. To indicate that it is always valid, use a very large number for this field.

The serialVersionUID of this class is 6532732096650090465L.

Since:

1.5

See Also:

Serialized Form

• Field Summary

• Constructor Summary

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.

• Method Summary

[clone](#clone%28%29)()
Creates and returns a new ModelMBeanOperationInfo which is a duplicate of this ModelMBeanOperationInfo.
Returns a copy of the associated Descriptor of the ModelMBeanOperationInfo.
void
Sets associated Descriptor (full replace) for the ModelMBeanOperationInfo If the new Descriptor is null, then the associated Descriptor reverts to a default descriptor.
[toString](#toString%28%29)()
Returns a string containing the entire contents of the ModelMBeanOperationInfo in human readable form.

• Constructor Details

  • ModelMBeanOperationInfo

  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:
  operationMethod - The java.lang.reflect.Method object describing the MBean operation.
  description - A human readable description of the operation.

  • ModelMBeanOperationInfo

  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:
  operationMethod - The java.lang.reflect.Method object describing the MBean operation.
  description - A human readable description of the 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", the missing ones are added with their default values.
  Throws:
  [RuntimeOperationsException](../RuntimeOperationsException.html "class in javax.management") - 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 present but not equal to "operation", "getter", or "setter".

  • ModelMBeanOperationInfo

  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.

  • ModelMBeanOperationInfo

  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 fields "displayName" or "role", the missing ones are added with their default values.
  Throws:
  [RuntimeOperationsException](../RuntimeOperationsException.html "class in javax.management") - 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 present but not equal to "operation", "getter", or "setter".

  • ModelMBeanOperationInfo

  Constructs a new ModelMBeanOperationInfo object from this ModelMBeanOperation Object.
  Parameters:
  inInfo - the ModelMBeanOperationInfo to be duplicated

• Method Details

  • clone

  Creates and returns a new ModelMBeanOperationInfo which is a duplicate of this ModelMBeanOperationInfo.
  Overrides:
  [clone](../MBeanOperationInfo.html#clone%28%29) in class [MBeanOperationInfo](../MBeanOperationInfo.html "class in javax.management")
  Returns:
  a clone of this instance.
  See Also:
  Cloneable

  • getDescriptor

  Returns a copy of the associated Descriptor of the ModelMBeanOperationInfo.
  Specified by:
  [getDescriptor](../DescriptorRead.html#getDescriptor%28%29) in interface [DescriptorRead](../DescriptorRead.html "interface in javax.management")
  Overrides:
  [getDescriptor](../MBeanFeatureInfo.html#getDescriptor%28%29) in class [MBeanFeatureInfo](../MBeanFeatureInfo.html "class in javax.management")
  Returns:
  Descriptor associated with the ModelMBeanOperationInfo object.
  See Also:
  setDescriptor(javax.management.Descriptor)

  • setDescriptor

  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.
  Specified by:
  [setDescriptor](../DescriptorAccess.html#setDescriptor%28javax.management.Descriptor%29) in interface [DescriptorAccess](../DescriptorAccess.html "interface in javax.management")
  Parameters:
  inDescriptor - replaces the Descriptor associated with the ModelMBeanOperation.
  Throws:
  [RuntimeOperationsException](../RuntimeOperationsException.html "class in javax.management") - Wraps an IllegalArgumentException for invalid Descriptor.
  See Also:
  getDescriptor()

  • toString

  Returns a string containing the entire contents of the ModelMBeanOperationInfo in human readable form.
  Overrides:
  [toString](../../../../java.base/java/lang/Object.html#toString%28%29) in class [Object](../../../../java.base/java/lang/Object.html "class in java.lang")
  Returns:
  a string representation of the object.