javax.management
Class MBeanOperationInfo

java.lang.Object
  |
  +--javax.management.MBeanFeatureInfo
        |
        +--javax.management.MBeanOperationInfo

public class MBeanOperationInfo
extends MBeanFeatureInfo
implements java.io.Serializable

The MBeanOperationInfo object describes a management operation exposed by an MBean.

See Also:
Serialized Form

Field Summary
static int ACTION
          Indicates that the operation is a write-like in nature, and would modify the MBean in some way, typically by writing some value or changing a configuration.
static int ACTION_INFO
          Indicates that the operation is a read/write-like in nature.
static int INFO
          Indicates that the operation is a read-like in nature, it basically returns some information.
static int UNKNOWN
          Indicates that the operation has an "unknown" nature.
 
Fields inherited from class javax.management.MBeanFeatureInfo
description, name
 
Constructor Summary
MBeanOperationInfo(java.lang.String description, java.lang.reflect.Method method)
          Constructs a MBeanOperationInfo object.
MBeanOperationInfo(java.lang.String name, java.lang.String description, MBeanParameterInfo[] signature, java.lang.String type, int impact)
          Constructs a MBeanOperationInfo object.
 
Method Summary
 int getImpact()
          Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
 java.lang.String getReturnType()
          Returns the description of the method's return value.
 MBeanParameterInfo[] getSignature()
          Returns the signature of the method, that is, information on the operations arguments.
 
Methods inherited from class javax.management.MBeanFeatureInfo
getDescription, getName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INFO

public static final int INFO
Indicates that the operation is a read-like in nature, it basically returns some information.

ACTION

public static final int ACTION
Indicates that the operation is a write-like in nature, 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 a read/write-like in nature.

UNKNOWN

public static final int UNKNOWN
Indicates that the operation has an "unknown" nature.
Constructor Detail

MBeanOperationInfo

public MBeanOperationInfo(java.lang.String description,
                          java.lang.reflect.Method method)
Constructs a MBeanOperationInfo object.
Parameters:
method - The java.lang.reflect.Method object describing the MBean operation.
description - A human readable description of the operation.

MBeanOperationInfo

public MBeanOperationInfo(java.lang.String name,
                          java.lang.String description,
                          MBeanParameterInfo[] signature,
                          java.lang.String type,
                          int impact)
Constructs a 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.
type - The type of the method's return value.
impact - The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
Method Detail

getReturnType

public java.lang.String getReturnType()
Returns the description of the method's return value.

getSignature

public MBeanParameterInfo[] getSignature()
Returns the signature of the method, that is, information on the operations arguments.

getImpact

public int getImpact()
Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.