Класс ModelMBeanInfoSupport

java.lang.Object

javax.management.MBeanInfo

javax.management.modelmbean.ModelMBeanInfoSupport

Все реализуемые интерфейсы:: Serializable, Cloneable, DescriptorRead, ModelMBeanInfo

public class ModelMBeanInfoSupport extends MBeanInfo implements ModelMBeanInfo

Этот класс представляет метаданные для ModelMBean. Описатели были добавлены к метаданным объектов.

Java-ресурсы, желающие быть управляемыми, создают ModelMBean, используя метод createMBean сервера управления MBean. Ресурс затем задаёт ModelMBeanInfo и Описатели для экземпляра ModelMBean. Атрибуты и операции, доступные через ModelMBeanInfo для ModelMBean, доступны из MBeans, коннекторов/адаптеров, подобно другим MBeans. Через Описатели, значения и методы в управляемом приложении могут быть определены и сопоставлены с атрибутами и операциями ModelMBean. Это сопоставление может быть определено во время разработки в файле или динамически и программно во время выполнения.

Каждый ModelMBean, который создаётся на сервере управления MBean, становится управляемым: его атрибуты и операции становятся удалённо доступными через коннекторы/адаптеры, подключённые к этому серверу управления MBean. Java-объект не может быть зарегистрирован на сервере управления MBean, если он не является совместимым с JMX MBean. Создавая ModelMBean, ресурсы гарантируют, что MBean является корректным. MBeanException и RuntimeOperationsException должны быть выброшены при каждом публичном методе. Это позволяет обрабатывать исключения из распределённых коммуникаций (RMI, EJB и т. д.)

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

С момента:

1.5

См. также:

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

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

Конструктор	Описание
`ModelMBeanInfoSupport(String className, String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications)`	Создаёт ModelMBeanInfoSupport с предоставленной информацией, но описатель — по умолчанию.
`ModelMBeanInfoSupport(String className, String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications, Descriptor mbeandescriptor)`	Создаёт ModelMBeanInfoSupport с предоставленной информацией и описателем, указанным в параметре.
`ModelMBeanInfoSupport(ModelMBeanInfo mbi)`	Создаёт ModelMBeanInfoSupport, являющийся копией данного ModelMBeanInfo.

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

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Возвращает неглубокую копию этого экземпляра.
`ModelMBeanAttributeInfo`	`getAttribute(String inName)`	Возвращает ModelMBeanAttributeInfo, запрошенный по имени.
`ModelMBeanConstructorInfo`	`getConstructor(String inName)`	Возвращает ModelMBeanConstructorInfo, запрошенный по имени.
`Descriptor`	`getDescriptor()`	Получить описатель этого MBeanInfo.
`Descriptor`	`getDescriptor(String inDescriptorName)`	Возвращает описатель, запрошенный по имени.
`Descriptor`	`getDescriptor(String inDescriptorName, String inDescriptorType)`	Возвращает описатель, запрошенный по имени и типу описателя.
`Descriptor[]`	`getDescriptors(String inDescriptorType)`	Возвращает массив описателей, состоящий из всех описателей для ModelMBeanInfo заданного типа inDescriptorType.
`Descriptor`	`getMBeanDescriptor()`	Возвращает описатель ModelMBean, содержащий политики уровня MBean.
`ModelMBeanNotificationInfo`	`getNotification(String inName)`	Возвращает ModelMBeanNotificationInfo, запрошенный по имени.
`ModelMBeanOperationInfo`	`getOperation(String inName)`	Возвращает ModelMBeanOperationInfo, запрошенный по имени.
`void`	`setDescriptor(Descriptor inDescriptor, String inDescriptorType)`	Устанавливает описатели в массив info заданного типа inDescriptorType для ModelMBean.
`void`	`setDescriptors(Descriptor[] inDescriptors)`	Добавляет или заменяет описатели в ModelMBeanInfo.
`void`	`setMBeanDescriptor(Descriptor inMBeanDescriptor)`	Устанавливает описатель ModelMBean.

Методы, унаследованные от класса javax.management.MBeanInfo

equals, getAttributes, getClassName, getConstructors, getDescription, getNotifications, getOperations

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

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

Методы, унаследованные от интерфейса javax.management.modelmbean.ModelMBeanInfo

getAttributes, getClassName, getConstructors, getDescription, getNotifications, getOperations

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

ModelMBeanInfoSupport

public ModelMBeanInfoSupport(ModelMBeanInfo mbi)

Создаёт ModelMBeanInfoSupport, являющийся дубликатом заданного ModelMBeanInfo. Возвращаемый объект — это поверхностная копия заданного объекта. Ни Descriptor, ни содержащие массивы (ModelMBeanAttributeInfo[] и т.д.) не клонируются. Данный метод преимущественно интересен для изменения Descriptor возвращаемого экземпляра с помощью setDescriptor без влияния на Descriptor исходного объекта.

Параметры:: mbi - экземпляр ModelMBeanInfo, по которому инициализируется создаваемый ModelMBeanInfo.

ModelMBeanInfoSupport

public ModelMBeanInfoSupport(String className, String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications)

Создаёт ModelMBeanInfoSupport с предоставленной информацией, но descriptor по умолчанию. По умолчанию descriptor: name=className, descriptorType="mbean", displayName=className, persistPolicy="never", log="F", visibility="1"

Параметры:: className - имя класса MBean; description - удобочитаемое описание ModelMBean; attributes - массив объектов ModelMBeanAttributeInfo, которые имеют descriptor; constructors - массив объектов ModelMBeanConstructorInfo, которые имеют descriptor; operations - массив объектов ModelMBeanOperationInfo, которые имеют descriptor; notifications - массив объектов ModelMBeanNotificationInfo, которые имеют descriptor

ModelMBeanInfoSupport

public ModelMBeanInfoSupport(String className, String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications, Descriptor mbeandescriptor)

Создаёт ModelMBeanInfoSupport с предоставленной информацией и descriptor, переданным в параметре.

Параметры:: className - имя класса MBean; description - удобочитаемое описание ModelMBean; attributes - массив объектов ModelMBeanAttributeInfo, которые имеют descriptor; constructors - массив объектов ModelMBeanConstructorInfo, которые имеют descriptor; operations - массив объектов ModelMBeanOperationInfo, которые имеют descriptor; notifications - массив объектов ModelMBeanNotificationInfo, которые имеют descriptor; mbeandescriptor - descriptor, который будет использоваться в качестве MBeanDescriptor, содержащего политику MBean. Если descriptor равен null, будет создан descriptor по умолчанию. По умолчанию descriptor: name=className, descriptorType="mbean", displayName=className, persistPolicy="never", log="F", visibility="1". Если descriptor не содержит все эти поля, отсутствующие поля добавляются с этими значениями по умолчанию.
Исключения:: RuntimeOperationsException - Оборачивает исключение IllegalArgumentException для некорректного descriptor, переданного в параметре. (См. getMBeanDescriptor для определения допустимого descriptor MBean.)

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

clone

public Object clone()

Возвращает поверхностную копию этого экземпляра. Ни Descriptor, ни содержащие массивы (ModelMBeanAttributeInfo[] и т.д.) не клонируются. Данный метод преимущественно интересен для изменения Descriptor копии с помощью setDescriptor без влияния на Descriptor исходного объекта.

Определяется в:

clone в интерфейсе ModelMBeanInfo

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

clone в классе MBeanInfo

Возвращает:

поверхностную копию этого экземпляра.

См. также:

Cloneable

getDescriptors

public Descriptor[] getDescriptors(String inDescriptorType) throws MBeanException, RuntimeOperationsException

Описание скопировано из интерфейса: ModelMBeanInfo

Возвращает массив Descriptor, состоящий из всех Descriptors для ModelMBeanInfo типа inDescriptorType.

Определяется в:

getDescriptors в интерфейсе ModelMBeanInfo

Параметры:

inDescriptorType - значение поля descriptorType, которое должно быть установлено для возвращаемого descriptor. Должно быть "mbean", "attribute", "operation", "constructor" или "notification". Если оно равно null или пустое, будут возвращены все типы.

Возвращает:

массив Descriptor, содержащий все descriptors для ModelMBean типа inDescriptorType.

Исключения:

MBeanException - Оборачивает исключение распределённой коммуникации.

RuntimeOperationsException - Оборачивает исключение IllegalArgumentException, когда descriptorType в параметре не является одним из: "mbean", "attribute", "operation", "constructor", "notification", пустым или null.

См. также:

ModelMBeanInfo.setDescriptors(javax.management.Descriptor[])

setDescriptors

public void setDescriptors(Descriptor[] inDescriptors) throws MBeanException, RuntimeOperationsException

Описание скопировано из интерфейса: ModelMBeanInfo

Добавляет или заменяет descriptors в ModelMBeanInfo.

Определяется в:

setDescriptors в интерфейсе ModelMBeanInfo

Параметры:

inDescriptors - descriptors, которые нужно установить в ModelMBeanInfo. Нулевые элементы списка будут проигнорированы. Все descriptors должны иметь поля name и descriptorType.

Исключения:

MBeanException - Оборачивает исключение распределённой коммуникации.

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

См. также:

ModelMBeanInfo.getDescriptors(java.lang.String)

getDescriptor

public Descriptor getDescriptor(String inDescriptorName) throws MBeanException, RuntimeOperationsException

Возвращает descriptor, запрошенный по имени.

Параметры:

inDescriptorName - Имя descriptor.

Возвращает:

Descriptor, содержащий descriptor для ModelMBean с тем же именем. Если descriptor не найден, возвращается null.

Исключения:

MBeanException - Оборачивает исключение распределённой коммуникации.

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

См. также:

setDescriptor(javax.management.Descriptor, java.lang.String)

getDescriptor

public Descriptor getDescriptor(String inDescriptorName, String inDescriptorType) throws MBeanException, RuntimeOperationsException

Описание скопировано из интерфейса: ModelMBeanInfo

Возвращает descriptor, запрошенный по имени и типу descriptor.

Определяется в:

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

Параметры:

inDescriptorName - Имя descriptor.

inDescriptorType - Тип запрашиваемого descriptor. Если null или пустое, ищутся все типы. Допустимые типы — 'mbean', 'attribute', 'constructor' 'operation' и 'notification'. Это значение будет равно полю 'descriptorType' в возвращаемом descriptor.

Возвращает:

Descriptor, содержащий descriptor для ModelMBean с тем же именем и типом descriptor. Если descriptor не найден, возвращается null.

Исключения:

MBeanException - Оборачивает исключение распределённой коммуникации.

RuntimeOperationsException - Оборачивает исключение IllegalArgumentException для null имени descriptor или null или некорректного типа. Тип должен быть "mbean", "attribute", "constructor", "operation" или "notification".

См. также:

ModelMBeanInfo.setDescriptor(javax.management.Descriptor, java.lang.String)

setDescriptor

public void setDescriptor(Descriptor inDescriptor, String inDescriptorType) throws MBeanException, RuntimeOperationsException

Описание скопировано из интерфейса: ModelMBeanInfo

Устанавливает descriptors в массив info типа inDescriptorType для ModelMBean. Метод setDescriptor соответствующего ModelMBean*Info будет вызван для установки указанного descriptor.

Определяется в:

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

Параметры:

inDescriptor - descriptor, который нужно установить в ModelMBean. Он НЕ должен быть null. Все descriptors должны иметь поля name и descriptorType.

inDescriptorType - Тип устанавливаемого descriptor. Если null, используется поле descriptorType в descriptor. Если указано, это значение должно быть установлено в поле descriptorType в descriptor. Должно быть "mbean", "attribute", "constructor", "operation" или "notification".

Исключения:

MBeanException - Оборачивает исключение распределённой коммуникации.

RuntimeOperationsException - Оборачивает исключение IllegalArgumentException для некорректных или null аргументов или если поле name descriptor не найдено в соответствующих MBeanAttributeInfo или MBeanConstructorInfo или MBeanNotificationInfo или MBeanOperationInfo.

См. также:

ModelMBeanInfo.getDescriptor(java.lang.String, java.lang.String)

getAttribute

public ModelMBeanAttributeInfo getAttribute(String inName) throws MBeanException, RuntimeOperationsException

Описание скопировано из интерфейса: ModelMBeanInfo

Возвращает ModelMBeanAttributeInfo, запрошенный по имени.

Указано:: getAttribute в интерфейсе ModelMBeanInfo
Параметры:: inName - Имя ModelMBeanAttributeInfo для получения. Если ModelMBeanAttributeInfo с таким именем не существует, возвращается null.
Возвращает:: информацию об атрибуте с указанным именем или null, если таковой отсутствует.
Использует:: MBeanException - Оборачивает исключение распределённой коммуникации.; RuntimeOperationsException - Оборачивает IllegalArgumentException для null имени атрибута.

getOperation

public ModelMBeanOperationInfo getOperation(String inName) throws MBeanException, RuntimeOperationsException

Описание скопировано из интерфейса: ModelMBeanInfo

Возвращает ModelMBeanOperationInfo, запрошенный по имени.

Указано:: getOperation в интерфейсе ModelMBeanInfo
Параметры:: inName - Имя ModelMBeanOperationInfo для получения. Если ModelMBeanOperationInfo с таким именем не существует, возвращается null.
Возвращает:: информацию об операции с указанным именем или null, если таковой отсутствует.
Использует:: MBeanException - Оборачивает исключение распределённой коммуникации.; RuntimeOperationsException - Оборачивает IllegalArgumentException для null имени операции.

getConstructor

public ModelMBeanConstructorInfo getConstructor(String inName) throws MBeanException, RuntimeOperationsException

Возвращает ModelMBeanConstructorInfo, запрошенный по имени. Если ModelMBeanConstructorInfo с таким именем не существует, возвращается null.

Параметры:: inName - имя конструктора.
Возвращает:: информацию о конструкторе с указанным именем или null, если таковой отсутствует.
Использует:: MBeanException - Оборачивает исключение распределённой коммуникации.; RuntimeOperationsException - Оборачивает IllegalArgumentException для null имени конструктора.

getNotification

public ModelMBeanNotificationInfo getNotification(String inName) throws MBeanException, RuntimeOperationsException

Описание скопировано из интерфейса: ModelMBeanInfo

Возвращает ModelMBeanNotificationInfo, запрошенный по имени.

Указано:: getNotification в интерфейсе ModelMBeanInfo
Параметры:: inName - Имя ModelMBeanNotificationInfo для получения. Если ModelMBeanNotificationInfo с таким именем не существует, возвращается null.
Возвращает:: информацию об уведомлении с указанным именем или null, если таковой отсутствует.
Использует:: MBeanException - Оборачивает исключение распределённой коммуникации.; RuntimeOperationsException - Оборачивает IllegalArgumentException для null имени уведомления.

getDescriptor

public Descriptor getDescriptor()

Описание скопировано из класса: MBeanInfo

Получить дескриптор данного MBeanInfo. Изменение возвращаемого значения не повлияет на исходный дескриптор.

Указано:: getDescriptor в интерфейсе DescriptorRead
Переопределяет:: getDescriptor в классе MBeanInfo
Возвращает:: дескриптор, который является неизменяемым или копией оригинального.
С:: 1.6

getMBeanDescriptor

public Descriptor getMBeanDescriptor() throws MBeanException

Описание скопировано из интерфейса: ModelMBeanInfo

Возвращает дескриптор ModelMBean, содержащий политики на уровне MBean. Этот дескриптор содержит метаданные о MBean и политики по умолчанию для сохранения и кэширования.

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

Поля ModelMBean
Имя	Тип	Значение
name	String	Имя MBean.
descriptorType	String	Должно быть "mbean".
displayName	String	Имя MBean, используемое в отображениях.
persistPolicy	String	Одно из: OnUpdate\|OnTimer\|NoMoreOftenThan\|OnUnregister\|Always\|Never. См. раздел «Поля дескриптора MBean» в документе спецификации JMX.
persistLocation	String	Полное квалифицированное имя каталога, в котором должен быть сохранён MBean (если применимо).
persistFile	String	Имя файла, в который должен быть сохранён MBean.
persistPeriod	Number	Частота цикла сохранения в секундах для политики сохранения OnTime и NoMoreOftenThan.
currencyTimeLimit	Number	Сколько времени действительна кэшированная информация: <0 никогда, =0 всегда, >0 секунды.
log	String	t: логировать все уведомления, f: не логировать уведомления.
logfile	String	Полное квалифицированное имя файла для логирования событий.
visibility	Number	1-4, где 1: всегда видимый, 4: редко видимый.
export	String	Имя, используемое для экспорта/экспонирования этого MBean, чтобы его можно было найти другим агентами JMX.
presentationString	String	XML-форматированная строка для отображения данных, связанных с MBean.

По умолчанию дескриптор: name=className,descriptorType="mbean", displayName=className, persistPolicy="never",log="F",visibility="1" Если дескриптор не содержит все эти поля, они будут добавлены со значениями по умолчанию.

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

Указано:

getMBeanDescriptor в интерфейсе ModelMBeanInfo

Возвращает:

дескриптор MBean.

Использует:

MBeanException - Оборачивает исключение распределённой коммуникации.

См. также:

ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor)

setMBeanDescriptor

public void setMBeanDescriptor(Descriptor inMBeanDescriptor) throws MBeanException, RuntimeOperationsException

Описание скопировано из интерфейса: ModelMBeanInfo

Устанавливает дескриптор ModelMBean. Этот дескриптор содержит метаданные на уровне MBean, а также политики по умолчанию для сохранения и кэширования. Данная операция полностью заменяет дескриптор, слияния не производится. Если устанавливаемый дескриптор null, будет создан дескриптор по умолчанию. Дескриптор по умолчанию: name=className,descriptorType="mbean", displayName=className, persistPolicy="never",log="F",visibility="1". Если дескриптор не содержит все эти поля, они будут добавлены со значениями по умолчанию. См. getMBeanDescriptor для описания допустимых имён полей.

Указано:

setMBeanDescriptor в интерфейсе ModelMBeanInfo

Параметры:

inMBeanDescriptor - дескриптор для установки.

Использует:

MBeanException - Оборачивает исключение распределённой коммуникации.

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

См. также:

ModelMBeanInfo.getMBeanDescriptor()

© 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/ModelMBeanInfoSupport.html