javax.management.modelmbean

接口
异常
java.lang.Object
  继承者 javax.management.MBeanFeatureInfo
      继承者 javax.management.MBeanOperationInfo
          继承者 javax.management.modelmbean.ModelMBeanOperationInfo
所有已实现的接口:
Serializable, Cloneable, DescriptorAccess, DescriptorRead

public class ModelMBeanOperationInfo
     
extends MBeanOperationInfo
implements DescriptorAccess

ModelMBeanOperationInfo 对象描述了 ModelMBean 的管理操作。它是 MBeanOperationInfo 的一个子类,添加了关联的 Descriptor 和 DescriptorAccess 接口实现。

描述符中的字段定义如下,但不限于此: 
 name           : 操作的名称 
 descriptorType : 必须为 "operation"  
 class          : 其中定义了方法(完全限定)的类
 role           : 必须为 "operation"、"getter" 或 "setter"
 targetObject   : 将在其上执行此方法的对象
 targetType     : targetObject 的对象引用类型可以为:ObjectReference | Handle | EJBHandle | IOR | MIReference。
 value          : 操作的缓存值
 currencyTimeLimit : 缓存值的有效时间
 lastUpdatedTimeStamp : 当设置缓存值时
 visibility            : 1-4,其中 1 表示总是可见;4 表示几乎不可见
 presentationString : 用于描述如何呈现操作的 xml 格式的字符串
 
默认的描述符包含 name、descriptorType、displayName 和 role 字段。

注:由于与此规范的以前版本不一致,因此对于 currencyTimeLimit,建议不要使用负值或零。要指示某个缓存的值永远无效,请忽略 currencyTimeLimit 字段。要指示它总是有效,请为此字段使用一个非常大的值。

此类的 serialVersionUID6532732096650090465L

从以下版本开始:
1.5
另请参见:
序列化表格

字段摘要
 
从类 javax.management.MBeanOperationInfo 继承的字段
ACTION, ACTION_INFO, INFO, UNKNOWN
 
从类 javax.management.MBeanFeatureInfo 继承的字段
description, name
 
构造方法摘要
ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)
          根据此 ModelMBeanOperation Object 构造新的 ModelMBeanOperationInfo 对象。
ModelMBeanOperationInfo(String description, Method operationMethod)
          构造带有默认描述符的 ModelMBeanOperationInfo 对象。
ModelMBeanOperationInfo(String description, Method operationMethod, Descriptor descriptor)
          构造 ModelMBeanOperationInfo 对象。
ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact)
          构造带有默认描述符的 ModelMBeanOperationInfo 对象。
ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)
          构造 ModelMBeanOperationInfo 对象。
 
方法摘要
 Object clone()
          创建并返回新的 ModelMBeanOperationInfo,它是此 ModelMBeanOperationInfo 的副本。
 Descriptor getDescriptor()
          返回 ModelMBeanOperationInfo 的关联 Descriptor 的副本。
 void setDescriptor(Descriptor inDescriptor)
          设置 ModelMBeanOperationInfo 的关联 Descriptor(完全取代)。
 String toString()
          以可读形式返回包含 ModelMBeanOperationInfo 全部内容的字符串。
 
从类 javax.management.MBeanOperationInfo 继承的方法
equals, getImpact, getReturnType, getSignature, hashCode
 
从类 javax.management.MBeanFeatureInfo 继承的方法
getDescription, getName
 
从类 java.lang.Object 继承的方法
finalize, getClass, notify, notifyAll, wait, wait, wait
 

构造方法详细信息

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(String description,
                               Method operationMethod)
构造带有默认描述符的 ModelMBeanOperationInfo 对象。已构造对象的 Descriptor 包括 Method 对象(包含 DescriptorKey 元注释)生成的字段。

参数:
operationMethod - 描述 MBean 操作的 java.lang.reflect.Method 对象。
description - 操作的可读描述。

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(String description,
                               Method operationMethod,
                               Descriptor descriptor)
构造 ModelMBeanOperationInfo 对象。已构造对象的 Descriptor 包括 Method 对象(包含 DescriptorKey 元注释)生成的字段。

参数:
operationMethod - 描述 MBean 操作的 java.lang.reflect.Method 对象。
description - 操作的可读描述。
descriptor - 包含此 ModelMBeanOperationInfo 实例的适当元数据的 Descriptor 的一个实例。如果该参数为 null,则将创建默认描述符。如果描述符不包含 "displayName" 或 "role" 字段,则以默认值将这些字段添加到描述符中。
抛出:
RuntimeOperationsException - 包装一个 IllegalArgumentException。描述符无效;描述符 "name" 字段不等于操作名称;描述符 "DescriptorType" 字段不等于 "operation";描述符 "role" 字段不等于 "operation"、"getter" 或 "setter"。

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(String name,
                               String description,
                               MBeanParameterInfo[] signature,
                               String type,
                               int impact)
构造带有默认描述符的 ModelMBeanOperationInfo 对象。

参数:
name - 方法名称。
description - 操作的可读描述。
signature - 描述方法的参数的 MBeanParameterInfo 对象。
type - 方法返回值的类型。
impact - 方法的影响,为 INFO、ACTION、ACTION_INFO、UNKNOWN 之一。

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(String name,
                               String description,
                               MBeanParameterInfo[] signature,
                               String type,
                               int impact,
                               Descriptor descriptor)
构造 ModelMBeanOperationInfo 对象。

参数:
name - 方法名称。
description - 操作的可读描述。
signature - 描述方法的参数的 MBeanParameterInfo 对象。
type - 方法返回值的类型。
impact - 方法的影响,为 INFO、ACTION、ACTION_INFO、UNKNOWN 之一。
descriptor - 包含此 MBeanOperationInfo 实例的适当元数据的 Descriptor 的实例。如果该参数为 null,是将创建默认描述符。如果描述符不包含 "displayName" 或 "role" 字段,则以默认值将这些字段添加到描述符中。
抛出:
RuntimeOperationsException - 包装一个 IllegalArgumentException。描述符无效;描述符 "name" 字段不等于操作名称;描述符 "DescriptorType" 字段不等于 "operation";描述符 "role" 字段不等于 "operation"、"getter" 或 "setter"。

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)
根据此 ModelMBeanOperation Object 构造新的 ModelMBeanOperationInfo 对象。

参数:
inInfo - 要复制的 ModelMBeanOperationInfo
方法详细信息

clone

public Object clone()
创建并返回新的 ModelMBeanOperationInfo,它是此 ModelMBeanOperationInfo 的副本。

覆盖:
MBeanOperationInfo 中的 clone
返回:
此实例的一个副本。
另请参见:
Cloneable

getDescriptor

public Descriptor getDescriptor()
返回 ModelMBeanOperationInfo 的关联 Descriptor 的副本。

指定者:
接口 DescriptorRead 中的 getDescriptor
覆盖:
MBeanFeatureInfo 中的 getDescriptor
返回:
与 ModelMBeanOperationInfo 对象关联的 Descriptor。
另请参见:
setDescriptor(javax.management.Descriptor)

setDescriptor

public void setDescriptor(Descriptor inDescriptor)
设置 ModelMBeanOperationInfo 的关联 Descriptor(完全取代)。如果新 Descriptor 为 null,则该关联 Descriptor 恢复为默认描述符。在分配 Descriptor 之前先验证它。如果新 Descriptor 无效,则抛出包装 IllegalArgumentException 的 RuntimeOperationsException。

指定者:
接口 DescriptorAccess 中的 setDescriptor
参数:
inDescriptor - 替换与 ModelMBeanOperation 关联的 Descriptor。
抛出:
RuntimeOperationsException - 包装一个无效 Descriptor 的 IllegalArgumentException。
另请参见:
getDescriptor()

toString

public String toString()
以可读形式返回包含 ModelMBeanOperationInfo 全部内容的字符串。

覆盖:
MBeanOperationInfo 中的 toString
返回:
该对象的字符串表示形式。