XMOJO 5 API Docs

javax.management
Class MBeanOperationInfo

java.lang.Object
  |
  +--javax.management.MBeanFeatureInfo
        |
        +--javax.management.MBeanOperationInfo
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
ModelMBeanOperationInfo

public class MBeanOperationInfo
extends MBeanFeatureInfo
implements java.io.Serializable, java.lang.Cloneable

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 an MBeanOperationInfo object.
MBeanOperationInfo(java.lang.String name, java.lang.String description, MBeanParameterInfo[] signature, java.lang.String type, int impact)
          Constructs an MBeanOperationInfo object.
 
Method Summary
 java.lang.Object clone()
          Creates and returns a copy of this object.
 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.
 java.lang.String toString()
          Returns a human readable version of the MBeanOperationInfo instance
 
Methods inherited from class javax.management.MBeanFeatureInfo
getDescription, getName
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

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.

INFO

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

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 an MBeanOperationInfo object.
Parameters:
description - A human readable description of the operation.
method - The java.lang.reflect.Method object describing the MBean operation.

MBeanOperationInfo

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

getImpact

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

getSignature

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

getReturnType

public java.lang.String getReturnType()
Returns the description of the method's return value.
Returns:
The return type of the method is returned as a String

clone

public java.lang.Object clone()
Creates and returns a copy of this object.
Overrides:
clone in class java.lang.Object
Returns:
A duplicate copy of this object is created

toString

public java.lang.String toString()
Returns a human readable version of the MBeanOperationInfo instance
Overrides:
toString in class MBeanFeatureInfo
Returns:
Human readable version of the MBeanOperationInfo instance is returned

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.