javax.management
Class MBeanOperationInfo

java.lang.Objec
  |
  +--javax.management.MBeanFeatureInfo
        |
        +--

javax.management.MBeanOperationInfo

Direct Known Subclasses:

ModelMBeanOperationInfo


public class

MBeanOperationInfo

extends MBeanFeatureInfo
implements java.io.Serializable, java.lang.Cloneable

Describes a management operation exposed by an MBean.

Version:

1.17

Author:

Cosimo Vampo, Massimiliano Parlione, Kenneth Barron

See Also:

Serialized Form


Field Summary

static 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 config.
static int ACTION_INFO
Indicates that the operation is a read/write-like.
static int INFO
Indicates that the operation is read-like, it basically returns information.
static int UNKNOWN
Indicates that the operation has an "unknown" nature.
 MBeanFeatureInfo">

Fields inherited from class javax.management.MBeanFeatureInfo

description, name
 

Constructor Summary

java.lang.String, java.lang.reflect.Method)">MBeanOperationInfo(java.lang.String description, java.lang.reflect.Method method)
Constructs an MBeanOperationInfo object.
java.lang.String, java.lang.String, javax.management.MBeanParameterInfo[], java.lang.String, int)">MBeanOperationInfo(java.lang.String name, java.lang.String description, MBeanParameterInfo[] signature, java.lang.String returnType, 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 operation's arguments.
 MBeanFeatureInfo">

Methods inherited from class javax.management.MBeanFeatureInfo

getDescription, getName
 

Methods inherited from class java.lang.Object

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

Field Detail

 

UNKNOWN

public static final int 

UNKNOWN

Indicates that the operation has an "unknown" nature.


 

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 config.


 

INFO

public static final int 

INFO

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


 

ACTION_INFO

public static final int 

ACTION_INFO

Indicates that the operation is a read/write-like.

Constructor Detail

java.lang.String, java.lang.String, javax.management.MBeanParameterInfo[], java.lang.String, int)">

 

MBeanOperationInfo

public 

MBeanOperationInfo

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


java.lang.String, java.lang.reflect.Method)">

 

MBeanOperationInfo

public 

MBeanOperationInfo

(java.lang.String description, java.lang.reflect.Method method)
Constructs an MBeanOperationInfo object.

Parameters:

method - The java.lang.reflect.Method object describing the MBean operation.
description - A human readable description of the operation.

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 operation's arguments.


 

getImpact

public int 

getImpact

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


 

clone

public java.lang.Object 

clone

()
Creates and returns a copy of this object.

Overrides:

clone in class java.lang.Object