OpenJDK 1.23 · 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. 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
Name	Type	Meaning
name	String	Operation name.
descriptorType	String	Must be "operation".
class	String	Class where method is defined (fully qualified).
role	String	Must be "operation", "getter", or "setter".
targetObject	Object	Object on which to execute this method.
targetType	String	type of object reference for targetObject. Can be: ObjectReference \| Handle \| EJBHandle \| IOR \| RMIReference.
value	Object	Cached value for operation.
displayName	String	Human readable display name of the operation.
currencyTimeLimit	Number	How long cached value is valid.
lastUpdatedTimeStamp	Number	When cached value was set.
visibility	Number	1-4 where 1: always visible 4: rarely visible.
presentationString	String	XML formatted string to describe how to present operation

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

Field Summary

Modifier and Type	Field and Description
private static boolean	compat
private static final String	currClass
private static final ObjectStreamField[]	newSerialPersistentFields
private static final long	newSerialVersionUID
private static final ObjectStreamField[]	oldSerialPersistentFields
private static final long	oldSerialVersionUID
private Descriptor	operationDescriptor
private static final ObjectStreamField[]	serialPersistentFields
private static final long	serialVersionUID Hides javax.management.MBeanOperationInfo.serialVersionUID.

Inherited from javax.management.MBeanOperationInfo:: ACTION ACTION_INFO INFO UNKNOWN

Constructor Summary

Access	Constructor and Description
public	ModelMBeanOperationInfo(String A human readable description of the operation. description, Method The java.lang.reflect.Method object describing the MBean operation. operationMethod) Constructs a ModelMBeanOperationInfo object with a default descriptor.
public	ModelMBeanOperationInfo(String A human readable description of the operation. description, Method The java.lang.reflect.Method object describing the MBean operation. operationMethod, 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. descriptor) Constructs a ModelMBeanOperationInfo object.
public	ModelMBeanOperationInfo(String The name of the method. name, String A human readable description of the operation. description, MBeanParameterInfo[] MBeanParameterInfo objects describing the parameters(arguments) of the method. signature, String The type of the method's return value. type, int The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN. impact) Constructs a ModelMBeanOperationInfo object with a default descriptor.
public	ModelMBeanOperationInfo(String The name of the method. name, String A human readable description of the operation. description, MBeanParameterInfo[] MBeanParameterInfo objects describing the parameters(arguments) of the method. signature, String The type of the method's return value. type, int The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN. impact, 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. descriptor) Constructs a ModelMBeanOperationInfo object.
public	ModelMBeanOperationInfo(ModelMBeanOperationInfo the ModelMBeanOperationInfo to be duplicated inInfo) Constructs a new ModelMBeanOperationInfo object from this ModelMBeanOperation Object.

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides javax.management.MBeanOperationInfo.clone. Creates and returns a new ModelMBeanOperationInfo which is a duplicate of this ModelMBeanOperationInfo.
public Descriptor	Returns: Descriptor associated with the ModelMBeanOperationInfo object. getDescriptor() Overrides javax.management.MBeanFeatureInfo.getDescriptor. Implements javax.management.DescriptorRead.getDescriptor. Returns a copy of the associated Descriptor of the ModelMBeanOperationInfo.
private void	readObject(ObjectInputStream in) Hides javax.management.MBeanFeatureInfo.readObject. Deserializes a `ModelMBeanOperationInfo` from an `ObjectInputStream`.
public void	setDescriptor(Descriptor replaces the Descriptor associated with the ModelMBeanOperation. inDescriptor) Implements javax.management.DescriptorAccess.setDescriptor. Sets associated Descriptor (full replace) for the ModelMBeanOperationInfo If the new Descriptor is null, then the associated Descriptor reverts to a default descriptor.
public String	toString() Overrides javax.management.MBeanOperationInfo.toString. Returns a string containing the entire contents of the ModelMBeanOperationInfo in human readable form.
private Descriptor	validDescriptor(final Descriptor Descriptor to be checked, or null which is equivalent to an empty Descriptor. in) Clones the passed in Descriptor, sets default values, and checks for validity.
private void	writeObject(ObjectOutputStream out) Hides javax.management.MBeanFeatureInfo.writeObject. Serializes a `ModelMBeanOperationInfo` to an `ObjectOutputStream`.

Inherited from javax.management.MBeanOperationInfo:: equals getImpact getReturnType getSignature hashCode

Field Detail

compat	back to summary
private static boolean compat

currClass	back to summary
private static final String currClass

newSerialPersistentFields	back to summary
private static final ObjectStreamField[] newSerialPersistentFields

newSerialVersionUID	back to summary
private static final long newSerialVersionUID

oldSerialPersistentFields	back to summary
private static final ObjectStreamField[] oldSerialPersistentFields

oldSerialVersionUID	back to summary
private static final long oldSerialVersionUID

operationDescriptor	back to summary
private Descriptor operationDescriptor

serialPersistentFields	back to summary
private static final ObjectStreamField[] serialPersistentFields Serial Fields: operationDescriptor:`Descriptor` The descriptor containing the appropriate metadata for this instance

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.management.MBeanOperationInfo.serialVersionUID.

Constructor Detail

ModelMBeanOperationInfo back to summary

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

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

ModelMBeanOperationInfo back to summary

ModelMBeanOperationInfo	back to summary
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:String A human readable description of the operation. operationMethod:Method The java.lang.reflect.Method object describing the MBean operation. descriptor: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. Exceptions 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 present but not equal to "operation", "getter", or "setter".

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

Exceptions

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 present but not equal to "operation", "getter", or "setter".

ModelMBeanOperationInfo	back to summary
public ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact) Constructs a ModelMBeanOperationInfo object with a default descriptor. Parameters name:String The name of the method. description:String A human readable description of the operation. signature:MBeanParameterInfo[] MBeanParameterInfo objects describing the parameters(arguments) of the method. type:String The type of the method's return value. impact:int The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.

ModelMBeanOperationInfo

back to summary

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

Constructs a ModelMBeanOperationInfo object with a default descriptor.

Parameters

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

ModelMBeanOperationInfo	back to summary
public ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor) Constructs a ModelMBeanOperationInfo object. Parameters name:String The name of the method. description:String A human readable description of the operation. signature:MBeanParameterInfo[] MBeanParameterInfo objects describing the parameters(arguments) of the method. type:String The type of the method's return value. impact:int The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN. descriptor: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. Exceptions 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 present but not equal to "operation", "getter", or "setter".

ModelMBeanOperationInfo

back to summary

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

Constructs a ModelMBeanOperationInfo object.

Parameters

name:String: The name of the method.
description:String: A human readable description of the operation.
signature:MBeanParameterInfo[]: MBeanParameterInfo objects describing the parameters(arguments) of the method.
type:String: The type of the method's return value.
impact:int: The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
descriptor: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.

Exceptions

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 present but not equal to "operation", "getter", or "setter".

ModelMBeanOperationInfo	back to summary
public ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo) Constructs a new ModelMBeanOperationInfo object from this ModelMBeanOperation Object. Parameters inInfo:ModelMBeanOperationInfo the ModelMBeanOperationInfo to be duplicated

ModelMBeanOperationInfo

back to summary

public ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)

Constructs a new ModelMBeanOperationInfo object from this ModelMBeanOperation Object.

Parameters

inInfo:ModelMBeanOperationInfo: the ModelMBeanOperationInfo to be duplicated

Method Detail

clone	back to summary
public Object clone() Overrides javax.management.MBeanOperationInfo.clone. Creates and returns a new ModelMBeanOperationInfo which is a duplicate of this ModelMBeanOperationInfo. Returns:Object Doc from java.lang.Object.clone. a clone of this instance.

clone

back to summary

public Object clone()

Overrides javax.management.MBeanOperationInfo.clone.

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

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

getDescriptor back to summary

getDescriptor	back to summary
public Descriptor getDescriptor() Overrides javax.management.MBeanFeatureInfo.getDescriptor. Implements javax.management.DescriptorRead.getDescriptor. Returns a copy of the associated Descriptor of the ModelMBeanOperationInfo. Returns:Descriptor Descriptor associated with the ModelMBeanOperationInfo object. See Also `setDescriptor`

public Descriptor getDescriptor()

Overrides javax.management.MBeanFeatureInfo.getDescriptor.

Implements javax.management.DescriptorRead.getDescriptor.

Returns a copy of the associated Descriptor of the ModelMBeanOperationInfo.

Returns:Descriptor: Descriptor associated with the ModelMBeanOperationInfo object.
See Also: setDescriptor

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException Hides javax.management.MBeanFeatureInfo.readObject. Deserializes a `ModelMBeanOperationInfo` from an `ObjectInputStream`.

private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException

Hides javax.management.MBeanFeatureInfo.readObject.

Deserializes a ModelMBeanOperationInfo from an ObjectInputStream.

setDescriptor back to summary

setDescriptor	back to summary
public void setDescriptor(Descriptor inDescriptor) Implements javax.management.DescriptorAccess.setDescriptor. 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:Descriptor replaces the Descriptor associated with the ModelMBeanOperation. Exceptions RuntimeOperationsException: Wraps an IllegalArgumentException for invalid Descriptor. See Also `getDescriptor`

public void setDescriptor(Descriptor inDescriptor)

Implements javax.management.DescriptorAccess.setDescriptor.

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:Descriptor: replaces the Descriptor associated with the ModelMBeanOperation.

Exceptions

RuntimeOperationsException:: Wraps an IllegalArgumentException for invalid Descriptor.

See Also

getDescriptor

toString	back to summary
public String toString() Overrides javax.management.MBeanOperationInfo.toString. Returns a string containing the entire contents of the ModelMBeanOperationInfo in human readable form. Returns:String Doc from java.lang.Object.toString. a string representation of the object

toString

back to summary

public String toString()

Overrides javax.management.MBeanOperationInfo.toString.

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

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

validDescriptor	back to summary
private Descriptor validDescriptor(final Descriptor in) throws RuntimeOperationsException Clones the passed in Descriptor, sets default values, and checks for validity. If the Descriptor is invalid (for instance by having the wrong "name"), this indicates programming error and a RuntimeOperationsException will be thrown. The following fields will be defaulted if they are not already set: displayName=this.getName(),name=this.getName(), descriptorType="operation", role="operation" Parameters in:Descriptor Descriptor to be checked, or null which is equivalent to an empty Descriptor. Exceptions RuntimeOperationsException: if Descriptor is invalid

validDescriptor

back to summary

private Descriptor validDescriptor(final Descriptor in) throws RuntimeOperationsException

Clones the passed in Descriptor, sets default values, and checks for validity. If the Descriptor is invalid (for instance by having the wrong "name"), this indicates programming error and a RuntimeOperationsException will be thrown. The following fields will be defaulted if they are not already set: displayName=this.getName(),name=this.getName(), descriptorType="operation", role="operation"

Parameters

in:Descriptor: Descriptor to be checked, or null which is equivalent to an empty Descriptor.

Exceptions

RuntimeOperationsException:: if Descriptor is invalid

writeObject back to summary

writeObject	back to summary
private void writeObject(ObjectOutputStream out) throws IOException Hides javax.management.MBeanFeatureInfo.writeObject. Serializes a `ModelMBeanOperationInfo` to an `ObjectOutputStream`.

private void writeObject(ObjectOutputStream out) throws IOException

Hides javax.management.MBeanFeatureInfo.writeObject.

Serializes a ModelMBeanOperationInfo to an ObjectOutputStream.

public Class ModelMBeanOperationInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail