Класс ModelMBeanOperationInfo

javax.management.modelmbean.ModelMBeanOperationInfo

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

public class ModelMBeanOperationInfo extends MBeanOperationInfo implements DescriptorAccess

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

Поля в описателе определены, но не ограничиваются следующими. Обратите внимание, что, когда Тип в этой таблице — Число, можно также использовать строку, которая является десятичным представлением 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()`	Возвращает копию связанного описателя (Descriptor) ModelMBeanOperationInfo.
`void`	`setDescriptor(Descriptor inDescriptor)`	Устанавливает связанный описатель (Descriptor) (полная замена) для 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 с дескриптором по умолчанию. Descriptor созданного объекта будет включать поля, внесённые аннотациями на объекте Method, содержащими мета-аннотацию DescriptorKey.

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

ModelMBeanOperationInfo

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

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

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

Возвращает:

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

См. также:

getDescriptor

public Descriptor getDescriptor()

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

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

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

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

getDescriptor в классе MBeanFeatureInfo

Возвращает:

Descriptor, связанный с объектом ModelMBeanOperationInfo.

См. также:

setDescriptor

public void setDescriptor(Descriptor inDescriptor)

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

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

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

Параметры:

inDescriptor - заменяет Descriptor, связанный с ModelMBeanOperation.

Исключения:

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

См. также:

toString

public String toString()

Возвращает строку, содержащую всё содержимое ModelMBeanOperationInfo в читабельном для человека формате.

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

© 1993, 2023, 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/21/docs/api/java.management/javax/management/modelmbean/ModelMBeanOperationInfo.html