Класс MBeanInfo

java.lang.Object

javax.management.MBeanInfo

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

Непосредственные подклассы:: ModelMBeanInfoSupport, OpenMBeanInfoSupport

public class MBeanInfo extends Object implements Cloneable, Serializable, DescriptorRead

Описывает интерфейс управления, предоставляемый объектом MBean; то есть набор атрибутов и операций, доступных для операций управления. Экземпляры этого класса неизменяемы. Подклассы могут быть изменяемыми, но это не рекомендуется.

Обычно информация MBean для любого данного MBean не изменяется на протяжении всего срока службы этого MBean. Динамические MBeans могут изменять свою информацию, и в этом случае рекомендуется отправлять уведомление Notification с типом "jmx.mbean.info.changed" и метаданными userData, которые представляют собой новую информацию. Это необязательно, но обеспечивает стандартный способ для клиентов MBean обнаружить изменения. См. также поля immutableInfo и infoTimeout в описателе MBeanInfo Descriptor.

Содержимое MBeanInfo для динамического MBean определяется его методом getMBeanInfo(). Это включает Open MBeans и Model MBeans, которые являются типами динамических MBeans.

Содержимое MBeanInfo для стандартного MBean определяется сервером MBean следующим образом:

getClassName() возвращает имя Java-класса объекта MBean;
getConstructors() возвращает список всех публичных конструкторов в этом объекте;
getAttributes() возвращает список всех атрибутов, существование которых выводится из наличия в интерфейсе MBean метода getName, isName, или setName, соответствующего соглашениям для стандартных MBeans;
getOperations() возвращает список всех методов в интерфейсе MBean, которые не представляют атрибуты;
getNotifications() возвращает пустой массив, если MBean не реализует интерфейс NotificationBroadcaster, в противном случае результат вызова NotificationBroadcaster.getNotificationInfo() на нём;
getDescriptor() возвращает описание, содержащее содержимое любых аннотаций описателя в интерфейсе MBean (см. @DescriptorKey).

Описание, возвращаемое getDescription(), и описания содержащихся атрибутов и операций не определены.

Остальные детали MBeanInfo для стандартного MBean не определены. Это включает описание любых содержащихся конструкторов и уведомлений; имена параметров конструкторов и операций; и описания параметров конструкторов.

Since:

1.5

See Also:

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

Конструктор	Описание
`MBeanInfo(String className, String description, MBeanAttributeInfo[] attributes, MBeanConstructorInfo[] constructors, MBeanOperationInfo[] operations, MBeanNotificationInfo[] notifications)`	Создаёт `MBeanInfo`.
`MBeanInfo(String className, String description, MBeanAttributeInfo[] attributes, MBeanConstructorInfo[] constructors, MBeanOperationInfo[] operations, MBeanNotificationInfo[] notifications, Descriptor descriptor)`	Создаёт `MBeanInfo`.

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

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Возвращает неглубокую копию этого экземпляра.
`boolean`	`equals(Object o)`	Сравнивает этот MBeanInfo с другим.
`MBeanAttributeInfo[]`	`getAttributes()`	Возвращает список атрибутов, доступных для управления.
`String`	`getClassName()`	Возвращает имя Java-класса объекта MBean, описанного этим `MBeanInfo`.
`MBeanConstructorInfo[]`	`getConstructors()`	Возвращает список публичных конструкторов объекта MBean.
`String`	`getDescription()`	Возвращает удобочитаемое описание MBean.
`Descriptor`	`getDescriptor()`	Получает описание этого MBeanInfo.
`MBeanNotificationInfo[]`	`getNotifications()`	Возвращает список уведомлений, отправляемых MBean.
`MBeanOperationInfo[]`	`getOperations()`	Возвращает список операций объекта MBean.

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

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

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

MBeanInfo

public MBeanInfo(String className, String description, MBeanAttributeInfo[] attributes, MBeanConstructorInfo[] constructors, MBeanOperationInfo[] operations, MBeanNotificationInfo[] notifications) throws IllegalArgumentException

Создаёт MBeanInfo.

Параметры:: className - Имя Java-класса управляемого объекта (MBean), описываемого этим MBeanInfo. Это значение может быть любым синтаксически корректным именем Java-класса. Оно не обязательно должно быть известным серверу MBean или ClassLoader MBean. Если это Java-класс, известный ClassLoader MBean, рекомендуется, но не обязательно, чтобы публичные методы класса включали те, которые отображались бы в Standard MBean, реализующем атрибуты и операции в этом MBeanInfo.; description - Читабельное описание управляемого объекта (необязательно).; attributes - Список открытых атрибутов управляемого объекта. Может быть null, что эквивалентно массиву нулевой длины.; constructors - Список публичных конструкторов управляемого объекта. Может быть null, что эквивалентно массиву нулевой длины.; operations - Список операций управляемого объекта. Может быть null, что эквивалентно массиву нулевой длины.; notifications - Список издаваемых уведомлений. Может быть null, что эквивалентно массиву нулевой длины.
Исключения:: IllegalArgumentException

MBeanInfo

public MBeanInfo(String className, String description, MBeanAttributeInfo[] attributes, MBeanConstructorInfo[] constructors, MBeanOperationInfo[] operations, MBeanNotificationInfo[] notifications, Descriptor descriptor) throws IllegalArgumentException

Создаёт MBeanInfo.

Параметры:: className - Имя Java-класса управляемого объекта (MBean), описываемого этим MBeanInfo. Это значение может быть любым синтаксически корректным именем Java-класса. Оно не обязательно должно быть известно серверу MBean или ClassLoader MBean. Если это Java-класс, известный ClassLoader MBean, рекомендуется, но не обязательно, чтобы публичные методы класса включали те, которые отображались бы в Standard MBean, реализующем атрибуты и операции в этом MBeanInfo.; description - Читабельное описание управляемого объекта (необязательно).; attributes - Список открытых атрибутов управляемого объекта. Может быть null, что эквивалентно массиву нулевой длины.; constructors - Список публичных конструкторов управляемого объекта. Может быть null, что эквивалентно массиву нулевой длины.; operations - Список операций управляемого объекта. Может быть null, что эквивалентно массиву нулевой длины.; notifications - Список издаваемых уведомлений. Может быть null, что эквивалентно массиву нулевой длины.; descriptor - Дескриптор для управляемого объекта. Может быть null, что эквивалентно пустому дескриптору.
Исключения:: IllegalArgumentException
С версии:: 1.6

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

clone

public Object clone()

Возвращает неглубокую копию этого экземпляра. Копия получается простым вызовом super.clone(), тем самым вызывая механизм неглубокого клонирования по умолчанию, реализованный в Object.clone(). Не производится глубокое клонирование каких-либо внутренних полей.

Поскольку этот класс неизменяемый, метод clone в основном интересен для подклассов.

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

clone в классе Object

Возвращает:

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

См. также:

getClassName

public String getClassName()

Возвращает имя Java-класса управляемого объекта (MBean), описываемого этим MBeanInfo.

Возвращает:: имя класса.

getDescription

public String getDescription()

Возвращает удобочитаемое описание управляемого объекта.

Возвращает:: описание.

getAttributes

public MBeanAttributeInfo[] getAttributes()

Возвращает список атрибутов, доступных для управления. Каждый атрибут описывается объектом MBeanAttributeInfo. Возвращаемый массив является неглубокой копией внутреннего массива, что означает, что это копия внутреннего массива ссылок на объекты MBeanAttributeInfo но каждый ссылающийся объект MBeanAttributeInfo не копируется.

Возвращает:: массив объектов MBeanAttributeInfo.

getOperations

public MBeanOperationInfo[] getOperations()

Возвращает список операций управляемого объекта. Каждая операция описывается объектом MBeanOperationInfo. Возвращаемый массив является неглубокой копией внутреннего массива, что означает, что это копия внутреннего массива ссылок на объекты MBeanOperationInfo но каждый ссылающийся объект MBeanOperationInfo не копируется.

Возвращает:: массив объектов MBeanOperationInfo.

getConstructors

public MBeanConstructorInfo[] getConstructors()

Возвращает список публичных конструкторов управляемого объекта. Каждый конструктор описывается объектом MBeanConstructorInfo.

Возвращаемый массив является неглубокой копией внутреннего массива, что означает, что это копия внутреннего массива ссылок на объекты MBeanConstructorInfo но каждый ссылающийся объект MBeanConstructorInfo не копируется.

Возвращаемый список необязательно является исчерпывающим. То есть, управляемый объект может иметь публичный конструктор, который не входит в список. В этом случае сервер MBean может создать другой экземпляр класса этого управляемого объекта, используя этот конструктор, даже если он здесь не указан.

Возвращает:: массив объектов MBeanConstructorInfo.

getNotifications

public MBeanNotificationInfo[] getNotifications()

Возвращает список уведомлений, издаваемых управляемым объектом. Каждое уведомление описывается объектом MBeanNotificationInfo. Возвращаемый массив является неглубокой копией внутреннего массива, что означает, что это копия внутреннего массива ссылок на объекты MBeanNotificationInfo но каждый ссылающийся объект MBeanNotificationInfo не копируется.

Возвращает:: массив объектов MBeanNotificationInfo.

getDescriptor

public Descriptor getDescriptor()

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

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

equals

public boolean equals(Object o)

Сравнивает этот MBeanInfo с другим. Два объекта MBeanInfo равны тогда и только тогда, когда они возвращают равные значения для getClassName(), для getDescription() и для getDescriptor(), и массивы, возвращаемые двумя объектами для getAttributes(), getOperations(), getConstructors() и getNotifications(), парно равны. Здесь "равенство" означает Object.equals(Object), а не тождество.

Если два объекта MBeanInfo возвращают одинаковые значения в одном из своих массивов, но в другом порядке, то они не равны.

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

equals в классе Object

Параметры:

o - объект для сравнения.

Возвращает:

true тогда и только тогда, когда o — это MBeanInfo, равный этому по вышеуказанным правилам.

См. также:

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