当前页面: 在线文档首页 > JBoss 4.0.1 sp1 jmx API Documentation 英文版文档

MBeanOperationInfo (JBoss/JMX API) - JBoss 4.0.1 sp1 jmx API Documentation 英文版文档

Overview  Package   Class  Use  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.management
Class MBeanOperationInfo

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

All Implemented Interfaces:

Cloneable, Serializable

Direct Known Subclasses:

ModelMBeanOperationInfo, OpenMBeanOperationInfoSupport

---

public class MBeanOperationInfo

extends MBeanFeatureInfo

implements Serializable, Cloneable

Describes an operation exposed by an MBean This implementation protects its immutability by taking shallow clones of all arrays supplied in constructors and by returning shallow array clones in getXXX() methods.

Version:

$Revision: 1.15 $

Author:

Juha Lindfors., Trevor Squires., Adrian Brock, Thomas Diesler.

See Also:

Serialized Form

---

Field Summary
static int	ACTION           Management operation impact: ACTION.
static int	ACTION_INFO           Management operation impact: ACTION_INFO.
static int	INFO           Management operation impact: INFO.
static int	UNKNOWN           Management operation impact: UNKNOWN.

 

Fields inherited from class javax.management.MBeanFeatureInfo

description, name

 

Constructor Summary

MBeanOperationInfo(String description, Method method)           Constructs management operation metadata from a given Method object and description.

MBeanOperationInfo(String name, String description, MBeanParameterInfo[] inSignature, String returnType, int impact)           Constructs a management operation metadata.

 

Method Summary
Object	clone()           Creates a copy of this object.
boolean	equals(Object object)
int	getImpact()           Returns the impact of this operation.
String	getReturnType()           Returns a fully qualified class name of the return type of this operation.
MBeanParameterInfo[]	getSignature()           Returns the signature of this operation.
int	hashCode()
String	toString()

 

Methods inherited from class javax.management.MBeanFeatureInfo

getDescription, getName

 

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

INFO

public static final int INFO

Management operation impact: INFO. The operation should not alter the state of the MBean component (read operation).

See Also:

Constant Field Values

---

ACTION

public static final int ACTION

Management operation impact: ACTION. The operation changes the state of the MBean component (write operation).

See Also:

Constant Field Values

---

ACTION_INFO

public static final int ACTION_INFO

Management operation impact: ACTION_INFO. Operation behaves like a read/write operation.

See Also:

Constant Field Values

---

UNKNOWN

public static final int UNKNOWN

Management operation impact: UNKNOWN. Reserved for Standard MBeans.

See Also:

Constant Field Values

Constructor Detail

MBeanOperationInfo

public MBeanOperationInfo(String description,
                          Method method)
                   throws IllegalArgumentException

Constructs management operation metadata from a given Method object and description.

Parameters:

description - human readable description of this operation

method - used for build the metadata for the management operation

---

MBeanOperationInfo

public MBeanOperationInfo(String name,
                          String description,
                          MBeanParameterInfo[] inSignature,
                          String returnType,
                          int impact)
                   throws IllegalArgumentException

Constructs a management operation metadata.

Parameters:

name - name of the management operation

description - human readable description string of the operation

inSignature - inSignature of the operation

returnType - return type of the operation as a fully qualified class name

impact - impact of this operation: ACTION, INFO, ACTION_INFO or UNKNOWN

Throws:

IllegalArgumentException - if the name or return type is not a valid java identifier or it is a reserved word or the impact is invalid

Method Detail

getReturnType

public String getReturnType()

Returns a fully qualified class name of the return type of this operation.

Returns:

fully qualified class name

---

getSignature

public MBeanParameterInfo[] getSignature()

Returns the signature of this operation. Note: an operation with a void signature returns a zero-length array, not a null reference.

Returns:

operation's signature

---

getImpact

public int getImpact()

Returns the impact of this operation. The impact is one of the following values: ACTION, INFO, ACTION_INFO or UNKNOWN (reserved for Standard MBeans).

Returns:

operation's impact

---

equals

public boolean equals(Object object)

Overrides:

equals in class MBeanFeatureInfo

---

hashCode

public int hashCode()

Overrides:

hashCode in class MBeanFeatureInfo

---

toString

public String toString()

Overrides:

toString in class MBeanFeatureInfo

Returns:

a human readable string

---

clone

public Object clone()

Creates a copy of this object. This is a deep copy; the MBeanParameterInfo objects forming the operation's signature are also cloned.

Returns:

a clone of this object

---

Overview  Package   Class  Use  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Copyright © 2002 JBoss Group, LLC. All Rights Reserved.