Класс ModelMBeanOperationInfo

public class ModelMBeanOperationInfo
extends MBeanOperationInfo
implements DescriptorAccess

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

Поля в описателе определены, но не ограничиваются следующими. Обратите внимание, что когда тип в этой таблице - Number, можно также использовать строку, которая является десятичным представлением 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.

Конструкторы

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

Возвращает:

Дескриптор, связанный с объектом 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 в классе MBeanOperationInfo

Возвращает:

строковое представление объекта.