Module java.management

Class ModelMBeanOperationInfo

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的子类,增加了一个关联的描述符和DescriptorAccess接口的实现。

描述符中的字段被定义,但不限于以下内容。请注意,当此表中的类型为Number时,也可以使用Long的十进制表示形式的字符串。

ModelMBeanOperationInfo字段
名称 类型 含义
name String 操作名称。
descriptorType String 必须是"operation"。
class String 定义方法的类(完全限定)。
role String 必须是"operation"、"getter"或"setter"。
targetObject Object 要执行此方法的对象。
targetType String targetObject的对象引用类型。可以是:ObjectReference | Handle | EJBHandle | IOR | RMIReference。
value Object 操作的缓存值。
displayName String 操作的人类可读显示名称。
currencyTimeLimit Number 缓存值有效的时间长度。
lastUpdatedTimeStamp Number 设置缓存值的时间戳。
visibility Number 1-4,其中1:始终可见,4:很少可见。
presentationString String 描述如何呈现操作的XML格式化字符串

默认描述符将设置名称、descriptorType、displayName和role字段。名称和displayName字段的默认值是操作名称。

注意:由于此规范先前版本中的不一致性,建议不要对currencyTimeLimit使用负值或零值。要表示缓存值永远无效,请省略currencyTimeLimit字段。要表示它始终有效,请为此字段使用一个非常大的数字。

此类的serialVersionUID6532732096650090465L

自:
1.5
参见:
  • Constructor Details

    • ModelMBeanOperationInfo

      public ModelMBeanOperationInfo(String description, Method operationMethod)
      构造具有默认描述符的ModelMBeanOperationInfo对象。构造对象的Descriptor将包括包含DescriptorKey元注释的Method对象上的字段。
      参数:
      description - 操作的人类可读描述。
      operationMethod - 描述MBean操作的java.lang.reflect.Method对象。
    • ModelMBeanOperationInfo

      public ModelMBeanOperationInfo(String description, Method operationMethod, Descriptor descriptor)
      构造ModelMBeanOperationInfo对象。构造对象的Descriptor将包括包含DescriptorKey元注释的Method对象上的字段。
      参数:
      description - 操作的人类可读描述。
      operationMethod - 描述MBean操作的java.lang.reflect.Method对象。
      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对象构造一个新的ModelMBeanOperationInfo对象。
      参数:
      inInfo - 要复制的ModelMBeanOperationInfo
  • Method Details

    • clone

      public Object clone()
      创建并返回一个此ModelMBeanOperationInfo的副本的新ModelMBeanOperationInfo。
      覆盖:
      clone 在类 MBeanOperationInfo
      返回:
      此实例的克隆。
      参见:
    • getDescriptor

      public Descriptor getDescriptor()
      返回ModelMBeanOperationInfo的关联描述符的副本。
      指定者:
      getDescriptor 在接口 DescriptorRead
      覆盖:
      getDescriptor 在类 MBeanFeatureInfo
      返回:
      与ModelMBeanOperationInfo对象关联的描述符。
      参见:
    • setDescriptor

      public void setDescriptor(Descriptor inDescriptor)
      为ModelMBeanOperationInfo设置关联描述符(完全替换)。如果新的描述符为null,则关联描述符将恢复为默认描述符。在分配描述符之前,将对其进行验证。如果新的描述符无效,则会抛出一个封装了IllegalArgumentException的RuntimeOperationsException。
      指定者:
      setDescriptor 在接口 DescriptorAccess
      参数:
      inDescriptor - 替换与ModelMBeanOperation关联的描述符。
      抛出:
      RuntimeOperationsException - 封装了IllegalArgumentException,用于无效的描述符。
      参见:
    • toString

      public String toString()
      返回一个包含ModelMBeanOperationInfo整个内容的字符串,以人类可读的形式呈现。
      覆盖:
      toString 在类 Object
      返回:
      对象的字符串表示形式。