Class MBeanOperationInfo

java.lang.Object

javax.management.MBeanFeatureInfo

javax.management.MBeanOperationInfo

All Implemented Interfaces:

Serializable, Cloneable, DescriptorRead

Direct Known Subclasses:

ModelMBeanOperationInfo, OpenMBeanOperationInfoSupport

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.

Since:

1.5

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACTION	Indicates that the operation is write-like: it has an effect but does not return any information from the MBean.
static final int	ACTION_INFO	Indicates that the operation is both read-like and write-like: it has an effect, and it also returns information from the MBean.
static final int	INFO	Indicates that the operation is read-like: it returns information but does not change any state.
static final int	UNKNOWN	Indicates that the impact of the operation is unknown or cannot be expressed using one of the other values.

Fields declared in class MBeanFeatureInfo

description, name

Modifier and Type	Field	Description
protected String	description	The human-readable description of the feature.
protected String	name	The name of the feature.

Constructor Summary

Constructors

Constructor	Description
MBeanOperationInfo(String description, Method method)	Constructs an MBeanOperationInfo object.
MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact)	Constructs an MBeanOperationInfo object.
MBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)	Constructs an MBeanOperationInfo object.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Returns a shallow clone of this instance.
boolean	equals(Object o)	Compare this MBeanOperationInfo to another.
int	getImpact()	Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
String	getReturnType()	Returns the type of the method's return value.
MBeanParameterInfo[]	getSignature()	Returns the list of parameters for this operation.

Methods declared in class MBeanFeatureInfo

getDescription, getDescriptor, getName

Modifier and Type	Method	Description
String	getDescription()	Returns the human-readable description of the feature.
Descriptor	getDescriptor()	Returns the descriptor for the feature.
String	getName()	Returns the name of the feature.

Methods declared in class Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Field Details

INFO

public static final int INFO

Indicates that the operation is read-like: it returns information but does not change any state.

See Also:

• Constant Field Values

ACTION

public static final int ACTION

Indicates that the operation is write-like: it has an effect but does not return any information from the MBean.

See Also:

• Constant Field Values

ACTION_INFO

public static final int ACTION_INFO

Indicates that the operation is both read-like and write-like: it has an effect, and it also returns information from the MBean.

See Also:

• Constant Field Values

UNKNOWN

public static final int UNKNOWN

Indicates that the impact of the operation is unknown or cannot be expressed using one of the other values.

See Also:

• Constant Field Values

Constructor Details

MBeanOperationInfo

public MBeanOperationInfo(String description,
 Method method)

Constructs an MBeanOperationInfo 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 - 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.

Throws:

IllegalArgumentException - if impact is not one of ACTION, ACTION_INFO, INFO or UNKNOWN.

Since:

1.6

Method Details

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

Returns:

Object a shallow copy of this object.

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.

getImpact

public int getImpact()

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

Returns:

the impact code.

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 MBeanFeatureInfo.getName(), getReturnType(), MBeanFeatureInfo.getDescription(), getImpact(), MBeanFeatureInfo.getDescriptor() and getSignature() values are equal (not necessarily identical) to those of this MBeanConstructorInfo. Two signature arrays are equal if their elements are pairwise equal.

See Also:

• Object.hashCode()