javax.management
class MBeanOperationInfo

java.lang.Object javax.management.MBeanFeatureInfo javax.management.MBeanOperationInfo

All Implemented Interfaces:

Serializable, Cloneable, DescriptorRead

Direct Known Subclasses:

ModelMBeanOperationInfo, OpenMBeanOperationInfoSupport

Most common way to construct:

MBeanInfo info = …;

MBeanOperationInfo attInfo[] = info.getOperations();

Based on 6 examples

public class MBeanOperationInfo
extends MBeanFeatureInfo
implements Cloneable

Describes a management operation exposed by an MBean. Instances of this class are immutable. Subclasses may be mutable but this is not recommended.

ACTION

public static final int ACTION

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.

ACTION_INFO

public static final int ACTION_INFO

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

INFO

public static final int INFO

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

UNKNOWN

public static final int UNKNOWN

Indicates that the operation has an "unknown" nature.

MBeanOperationInfo

public MBeanOperationInfo(String description,
                          Method method)

Constructs an MBeanOperationInfo object. The {@link Descriptor} of the constructed object will include fields contributed by any annotations on the {@code Method} object that contain the {@link DescriptorKey} meta-annotation.

Parameters:

description - A human readable description of the operation.

method - The java.lang.reflect.Method object describing the MBean operation.

MBeanOperationInfo

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

Constructs an MBeanOperationInfo 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. This may be null with the same effect as a zero-length array.

type - The type of the method's return value.

impact - The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.

MBeanOperationInfo

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

Constructs an MBeanOperationInfo 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. This may be null with the same effect as a zero-length array.

type - The type of the method's return value.

impact - The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.

descriptor - The descriptor for the operation. This may be null which is equivalent to an empty descriptor.

clone

public Object clone()

Returns a shallow clone of this instance. The clone is obtained by simply calling super.clone(), thus calling the default native shallow cloning mechanism implemented by Object.clone(). No deeper cloning of any internal field is made.

Since this class is immutable, cloning is chiefly of interest to subclasses.

Overrides:

clone in class Object

equals

public boolean equals(Object o)

Compare this MBeanOperationInfo to another.

Overrides:

equals in class MBeanFeatureInfo

Parameters:

o - the object to compare to.

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.

getImpact

public int getImpact()

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

Returns:

the impact code.

getReturnType

public String getReturnType()

Returns the type of the method's return value.

Returns:

the return type.

getSignature

public MBeanParameterInfo[] getSignature()

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.

hashCode

public int hashCode()

Overrides:

hashCode in class MBeanFeatureInfo

toString

public String toString()

Overrides:

toString in class Object