Класс ModelMBeanOperationInfo

Все реализуемые интерфейсы:
Serializable, Cloneable, DescriptorAccess, DescriptorRead
public class ModelMBeanOperationInfo
extends MBeanOperationInfo
implements DescriptorAccess

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

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

Имя Тип Значение
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.

С:
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 мета-аннотацию.

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

ModelMBeanOperationInfo

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

Создаёт объект ModelMBeanOperationInfo. Descriptor созданного объекта будет включать поля, внесённые аннотациями на объект 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, 2020, 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/11/docs/api/java.management/javax/management/modelmbean/ModelMBeanOperationInfo.html

Spec-Zone .ru
спецификации, руководства, описания, API