Класс ModelMBeanOperationInfo

javax.management.modelmbean.ModelMBeanOperationInfo

Все реализованные интерфейсы:: Serializable, Cloneable, DescriptorAccess, DescriptorRead

public class ModelMBeanOperationInfo extends MBeanOperationInfo implements DescriptorAccess

Объект ModelMBeanOperationInfo описывает операцию управления ModelMBean. Он является подклассом MBeanOperationInfo с добавлением связанного дескриптора и реализацией интерфейса DescriptorAccess.

Поля в дескрипторе определены, но не ограничены следующими. Обратите внимание, что когда Тип в этой таблице - Number, можно также использовать строку, представляющую десятичное представление Long.

ModelMBeanOperationInfo Fields
Имя	Тип	Значение
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-строка для описания отображения операции.

По умолчанию дескриптор будет содержать поля name, descriptorType, displayName и role. По умолчанию значения name и displayName равны имени операции.

Примечание: из-за несоответствий в предыдущих версиях спецификации рекомендуется не использовать отрицательные или нулевые значения для currencyTimeLimit. Чтобы указать, что кэшированное значение никогда не действует, опустите поле currencyTimeLimit. Чтобы указать, что оно всегда действует, используйте очень большое число для этого поля.

serialVersionUID этого класса равен 6532732096650090465L.

Since:

1.5

См. также:

Сериализованная форма

Краткое описание полей

Поля, объявленные в классе javax.management.MBeanOperationInfo

ACTION, ACTION_INFO, INFO, UNKNOWN

Поля, объявленные в классе javax.management.MBeanFeatureInfo

description, name

Краткое описание конструкторов

Конструктор	Описание
`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.
`ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)`	Создаёт новый объект ModelMBeanOperationInfo из объекта ModelMBeanOperation.

Краткое описание методов

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Создаёт и возвращает новый ModelMBeanOperationInfo, который является дубликатом данного ModelMBeanOperationInfo.
`Descriptor`	`getDescriptor()`	Возвращает копию связанного дескриптора ModelMBeanOperationInfo.
`void`	`setDescriptor(Descriptor inDescriptor)`	Устанавливает связанный дескриптор (полная замена) для ModelMBeanOperationInfo. Если новый дескриптор равен null, то связанный дескриптор восстанавливается по умолчанию.
`String`	`toString()`	Возвращает строку, содержащую всё содержимое ModelMBeanOperationInfo в удобочитаемой форме.

Методы, объявленные в классе javax.management.MBeanOperationInfo

equals, getImpact, getReturnType, getSignature

Методы, объявленные в классе javax.management.MBeanFeatureInfo

getDescription, getName

Методы, объявленные в классе java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробное описание конструкторов

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(String description, Method operationMethod)

Создаёт объект ModelMBeanOperationInfo с описателем по умолчанию. Описатель созданного объекта будет включать поля, внесённые любыми аннотациями на объекте Method, содержащем мета-аннотацию DescriptorKey.

Параметры:: operationMethod - Объект java.lang.reflect.Method, описывающий операцию MBean.; description - Читабельное описание операции.

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(String description, Method operationMethod, Descriptor descriptor)

Создаёт объект ModelMBeanOperationInfo. Описатель созданного объекта будет включать поля, внесённые любыми аннотациями на объекте Method, содержащем мета-аннотацию DescriptorKey.

Параметры:: operationMethod - Объект java.lang.reflect.Method, описывающий операцию MBean.; description - Читабельное описание операции.; descriptor - Экземпляр Descriptor, содержащий соответствующие метаданные для данного экземпляра ModelMBeanOperationInfo. Если он 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 - Экземпляр Descriptor, содержащий соответствующие метаданные для данного экземпляра MBeanOperationInfo. Если он null, будет создан описатель по умолчанию. Если описатель не содержит поля "displayName" или "role", отсутствующие поля будут добавлены со значениями по умолчанию.
Исключения:: RuntimeOperationsException - Оборачивает IllegalArgumentException. Описатель некорректен; или поле описателя "name" не равно имени операции; или поле описателя "DescriptorType" не равно "operation"; или необязательное поле описателя "role" присутствует, но не равно "operation", "getter" или "setter".

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)

Создаёт новый объект ModelMBeanOperationInfo из объекта ModelMBeanOperation.

Параметры:: inInfo - дублируемый ModelMBeanOperationInfo

Подробное описание методов

clone

public Object clone()

Создаёт и возвращает новый ModelMBeanOperationInfo, являющийся дубликатом этого ModelMBeanOperationInfo.

Переопределяет:

clone в классе MBeanOperationInfo

Возвращает:

клон данного экземпляра.

См. также:

Cloneable

getDescriptor

public Descriptor getDescriptor()

Возвращает копию связанного описателя Descriptor для ModelMBeanOperationInfo.

Определено в:

getDescriptor в интерфейсе DescriptorRead

Переопределяет:

getDescriptor в классе MBeanFeatureInfo

Возвращает:

Описатель Descriptor, связанный с объектом ModelMBeanOperationInfo.

См. также:

setDescriptor(javax.management.Descriptor)

setDescriptor

public void setDescriptor(Descriptor inDescriptor)

Устанавливает связанный описатель Descriptor (полная замена) для ModelMBeanOperationInfo. Если новый описатель null, то связанный описатель возвращается к описателю по умолчанию. Описатель проверяется перед присваиванием. Если новый описатель некорректен, вызывается RuntimeOperationsException, оборачивающий IllegalArgumentException.

Определено в:

setDescriptor в интерфейсе DescriptorAccess

Параметры:

inDescriptor - заменяет описатель, связанный с ModelMBeanOperation.

Исключения:

RuntimeOperationsException - Оборачивает IllegalArgumentException для некорректного описателя.

См. также:

getDescriptor()

toString

public String toString()

Возвращает строку, содержащую полное содержимое ModelMBeanOperationInfo в читаемом виде.

Переопределяет:: toString в классе Object
Возвращает:: строковое представление объекта.

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.management/javax/management/modelmbean/ModelMBeanOperationInfo.html