Module  java.management

Class ModelMBeanOperationInfo

  • All Implemented Interfaces:
    SerializableCloneableDescriptorAccessDescriptorRead


    public class ModelMBeanOperationInfo
    extends MBeanOperationInfo
    implements DescriptorAccess

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

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

    ModelMBeanOperationInfo Fields Name Type Meaning name String Operation name. descriptorType String Must be "operation". class String Class where method is defined (fully qualified). role String Must be "operation", "getter", or "setter". targetObject Object Object on which to execute this method. targetType String type of object reference for targetObject. Can be: ObjectReference | Handle | EJBHandle | IOR | RMIReference. value Object Cached value for operation. displayName String Human readable display name of the operation. currencyTimeLimit Number How long cached value is valid. lastUpdatedTimeStamp Number When cached value was set. visibility Number 1-4 where 1: always visible 4: rarely visible. presentationString String XML formatted string to describe how to present operation

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

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

    该类的serialVersionUID6532732096650090465L

    从以下版本开始:
    1.5
    另请参见:
    Serialized Form
    • 构造方法详细信息

      • ModelMBeanOperationInfo

        public ModelMBeanOperationInfo​(String description,
                                       方法 operationMethod)
        使用默认描述符构造一个ModelMBeanOperationInfo对象。 构造对象的Descriptor将包含由包含DescriptorKey元注释的方法对象上的任何注释贡献的字段。
        参数
        operationMethod - 描述MBean操作的java.lang.reflect.Method对象。
        description - 操作的可读描述。
      • ModelMBeanOperationInfo

        public ModelMBeanOperationInfo​(String description,
                                       方法 operationMethod,
                                       Descriptor descriptor)
        构造一个ModelMBeanOperationInfo对象。 构造对象的Descriptor将包含由包含DescriptorKey元注释的方法对象上的任何注释贡献的字段。
        参数
        operationMethod - 描述MBean操作的java.lang.reflect.Method对象。
        description - 操作的人类可读描述。
        descriptor - 描述符的一个实例,其中包含ModelMBeanOperationInfo的此实例的适当元数据。 如果为空,则将创建默认描述符。 如果描述符不包含字段“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 - 描述符的实例,其中包含该descriptor实例的适当元数据。 如果为空,则将创建默认描述符。 如果描述符不包含字段“displayName”或“role”,则缺少的字段将添加其默认值。
        异常
        RuntimeOperationsException - 包裹一个IllegalArgumentException。 描述符无效; 或描述符字段“name”不等于操作名称; 或描述符字段“DescriptorType”不等于“operation”; 或描述符可选字段“role”存在但不等于“operation”,“getter”或“setter”。
      • ModelMBeanOperationInfo

        public ModelMBeanOperationInfo​(ModelMBeanOperationInfo inInfo)
        从此ModelMBeanOperation对象构造一个新的ModelMBeanOperationInfo对象。
        参数
        inInfo - 要复制的ModelMBeanOperationInfo
    • 方法详细信息

      • clone

        public Object clone​()
        创建并返回一个与此ModelMBeanOperationInfo重复的新ModelMBeanOperationInfo。
        重写:
        cloneMBeanOperationInfo
        结果
        这个实例的一个克隆。
        另请参见:
        Cloneable
      • setDescriptor

        public void setDescriptor​(Descriptor inDescriptor)
        为ModelMBeanOperationInfo设置关联的描述符(完全替换)如果新的描述符为空,则相关的描述符将恢复为默认描述符。 描述符在分配之前验证。 如果新的Descriptor无效,则抛出一个包含IllegalArgumentException的RuntimeOperationsException。
        Specified by:
        setDescriptor在接口 DescriptorAccess
        参数
        inDescriptor - 替换与ModelMBeanOperation关联的描述符。
        异常
        RuntimeOperationsException - 为无效描述符包装一个IllegalArgumentException。
        另请参见:
        getDescriptor()
      • toString

        public String toString​()
        返回一个包含以可读的形式显示的ModelMBeanOperationInfo的全部内容的字符串。
        重写:
        toStringMBeanOperationInfo
        结果
        对象的字符串表示形式。