ModelMBeanOperationInfo JDK 1.6)

Description

public class ModelMBeanOperationInfo

The ModelMBeanOperationInfo object describes a management operation of the ModelMBean.

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.

See also:

Constructors

public ModelMBeanOperationInfo (ModelMBeanOperationInfo inInfo)

Constructs a new ModelMBeanOperationInfo object from this ModelMBeanOperation Object.

public ModelMBeanOperationInfo (String description, Method operationMethod)

Constructs a ModelMBeanOperationInfo object with a default descriptor.

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.

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

Constructs a ModelMBeanOperationInfo object.

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

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

Constructs a ModelMBeanOperationInfo object.

Methods

Hide/Show inherited methods

public Object clone () [Overrides MBeanOperationInfo]

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

public boolean equals (Object o) [Inherited From MBeanOperationInfo]

Compare this MBeanOperationInfo to another.

Compare this MBeanOperationInfo to another.
Returns: true if and only if o is an MBeanOperationInfo such that its {@link #getName()}, {@link #getReturnType()}, {@link #getDescription()}, {@link #getImpact()}, {@link #getDescriptor()} and {@link #getSignature()} values are equal (not necessarily identical) to those of this MBeanConstructorInfo. Two signature arrays are equal if their elements are pairwise equal.
Parameters:
- o - the object to compare to.

public String getDescription () [Inherited From MBeanFeatureInfo]

Returns the human-readable description of the feature.

public Descriptor getDescriptor () [Overrides MBeanFeatureInfo]

Returns a copy of the associated Descriptor of the ModelMBeanOperationInfo.

public int getImpact () [Inherited From MBeanOperationInfo]

Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.

Returns the impact of the method, one of
INFO, ACTION, ACTION_INFO, UNKNOWN.
Returns: the impact code.

public String getName () [Inherited From MBeanFeatureInfo]

Returns the name of the feature.

public String getReturnType () [Inherited From MBeanOperationInfo]

Returns the type of the method's return value.

public MBeanParameterInfo getSignature () [Inherited From MBeanOperationInfo]

Returns the list of parameters for this operation.

Returns the list of parameters for this operation. Each parameter is described by an MBeanParameterInfo object.

The returned array is a shallow copy of the internal array, which means that it is a copy of the internal array of references to the MBeanParameterInfo objects but that each referenced MBeanParameterInfo object is not copied.

Returns: An array of MBeanParameterInfo objects.

public int hashCode () [Inherited From MBeanOperationInfo]

public void setDescriptor (Descriptor inDescriptor) [Specified in DescriptorAccess]

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 MBeanOperationInfo]

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

Fields

Hide/Show inherited fields

publicfinalstatic int ACTION = "1" [Inherited From MBeanOperationInfo]

Indicates that the operation is a write-like, and would modify the MBean in some way, typically by writing some value or changing a configuration.

publicfinalstatic int ACTION_INFO = "2" [Inherited From MBeanOperationInfo]

Indicates that the operation is both read-like and write-like.

protected String description [Inherited From MBeanFeatureInfo]

The human-readable description of the feature.

publicfinalstatic int INFO = "0" [Inherited From MBeanOperationInfo]

Indicates that the operation is read-like, it basically returns information.

protected String name [Inherited From MBeanFeatureInfo]

The name of the feature.

publicfinalstatic int UNKNOWN = "3" [Inherited From MBeanOperationInfo]

Indicates that the operation has an "unknown" nature.