XMOJO 5 API Docs

javax.management.modelmbean
Class ModelMBeanOperationInfo

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

public class ModelMBeanOperationInfo
extends MBeanOperationInfo
implements DescriptorAccess

The ModelMBeanOperationInfo object describes a management operation of the ModelMBean. It is a subclass of MBeanOperationInfo with the addition of an associated Descriptor and an implementation of the DescriptorAccess interface.

 The fields in the descriptor are defined, but not limited to, the following:
	name           : operation name
	descriptorType : must be "operation"
	class          : class where method is defined (fully qualified)
	role           : getter, setter, operation, constructor
	targetObject   : object on which to execute this method
	targetType     : type of object reference for targetObject:

                ObjectReference|EJBHandle|IOR|RMIReference
	lastReturnedValue     : cached value for operation
	currencyTimeLimit     : how long cached value is valid
	lastReturnedTimeStamp : when cached value was set
	visibility            : 1-4 where 1: always visible 4: rarely visible
	presentationString    :  xml formatted string to describe how to present operation
 

The default descriptor will have name, descriptorType, and role fields set.

See Also:
Serialized Form

Fields inherited from class javax.management.MBeanOperationInfo
ACTION, ACTION_INFO, INFO, UNKNOWN
 
Fields inherited from class javax.management.MBeanFeatureInfo
description, name
 
Constructor Summary
ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)
          Creates a ModelMBeanOperationInfo with the specified ModelMBeanOperationInfo object.
ModelMBeanOperationInfo(java.lang.String description, java.lang.reflect.Method method)
          Constructs a new ModelMBeanOperationInfo object with default descriptor
ModelMBeanOperationInfo(java.lang.String description, java.lang.reflect.Method method, Descriptor descriptor)
          Constructs a new ModelMBeanOperationInfo object
ModelMBeanOperationInfo(java.lang.String name, java.lang.String description, MBeanParameterInfo[] signature, java.lang.String type, int impact)
          Constructs a ModelMBeanOperationInfo object with a default descriptor.
ModelMBeanOperationInfo(java.lang.String name, java.lang.String description, MBeanParameterInfo[] signature, java.lang.String type, int impact, Descriptor descriptor)
          Constructs a ModelMBeanOperationInfo object escriptorth with the specified Descriptor.
 
Method Summary
 java.lang.Object clone()
          Creates a duplicate object of ModelMBeanOperationInfo
 Descriptor getDescriptor()
          Gets the corresponding Descriptor of this ModelMBeanNotificationInfo
 void setDescriptor(Descriptor inDescriptor)
          Sets the specified Descriptor to this ModelMBeanNotificationInfo.If the value is null then default Descriptor will be taken.
 java.lang.String toString()
          Returns a human readable version of the ModelMBeanOperationInfo instance
 
Methods inherited from class javax.management.MBeanOperationInfo
getImpact, getReturnType, getSignature
 
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
 

Constructor Detail

ModelMBeanOperationInfo

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

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(java.lang.String description,
                               java.lang.reflect.Method method,
                               Descriptor descriptor)
Constructs a new ModelMBeanOperationInfo object
Parameters:
method - The java.lang.reflect.Method object describing the MBean operation.
description - A human readable description of the operation.
descriptor - Descriptor containing the appropriate metadata for this instance of the MBeanNotificationInfo.If it is null or invalid then a default desriptor will be created.

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(java.lang.String name,
                               java.lang.String description,
                               MBeanParameterInfo[] signature,
                               java.lang.String type,
                               int impact)
Constructs a ModelMBeanOperationInfo object with a default descriptor.
Parameters:
name - The method name
description - A human readable description of the operation.
signature - The array of MBeanParameterInfo contains the parameters or arguments of the method
type - The return type of the method
impact - The impact of the method, will be anyone of the following INFO, ACTION, ACTION_INFO, UNKNOWN.

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(java.lang.String name,
                               java.lang.String description,
                               MBeanParameterInfo[] signature,
                               java.lang.String type,
                               int impact,
                               Descriptor descriptor)
Constructs a ModelMBeanOperationInfo object escriptorth with the specified Descriptor.
Parameters:
name - The method name
description - A human readable description of the operation.
signature - The array of MBeanParameterInfo contains the parameters or arguments of the method
type - The return type of the method
impact - The impact of the method, will be anyone of the following INFO, ACTION, ACTION_INFO, UNKNOWN.
descriptor - Descriptor containing the appropriate metadata for this instance of the MBeanOperationInfo. If it is null or invalid then a default desriptor will be created.

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)
Creates a ModelMBeanOperationInfo with the specified ModelMBeanOperationInfo object.
Parameters:
inInfo - ModelMBeanOperationInfo object
Method Detail

clone

public java.lang.Object clone()
Creates a duplicate object of ModelMBeanOperationInfo
Overrides:
clone in class MBeanOperationInfo
Returns:
Create and return a duplicate object of ModelMBeanOperationInfo

getDescriptor

public Descriptor getDescriptor()
Gets the corresponding Descriptor of this ModelMBeanNotificationInfo
Specified by:
getDescriptor in interface DescriptorAccess
Returns:
This returns the Descriptor associated with this ModelMBeanNotificationInfo

setDescriptor

public void setDescriptor(Descriptor inDescriptor)
Sets the specified Descriptor to this ModelMBeanNotificationInfo.If the value is null then default Descriptor will be taken. The Descriptor is validated before it is assigned. If the new Descriptor is invalid, then an IllegalArgumentException is thrown.
Specified by:
setDescriptor in interface DescriptorAccess
Parameters:
inDescriptor - This replaces the Descriptor associated with the ModelMBeanNotification interface
Throws:
java.lang.IllegalArgumentException - If the new Descriptor is invalid, then it will be thrown.

toString

public java.lang.String toString()
Returns a human readable version of the ModelMBeanOperationInfo instance
Overrides:
toString in class MBeanOperationInfo
Returns:
This returns human readable version of the ModelMBeanOperationInfo instance

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.