Интерфейс ModelMBeanNotificationBroadcaster

Все суперинтерфейсы:: NotificationBroadcaster

Все известные подинтерфейсы:: ModelMBean

Все известные реализующие классы:: RequiredModelMBean

public interface ModelMBeanNotificationBroadcaster extends NotificationBroadcaster

Этот интерфейс должен быть реализован ModelMBean. Реализация этого интерфейса должна поставляться с каждым JMX Agent.

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

Каждый ModelMBean, который инициализирован в сервере MBean, становится управляемым: его атрибуты и операции становятся удалённо доступными через коннекторы/адаптеры, подключённые к этому серверу MBean. Объект Java не может быть зарегистрирован в сервере MBean, если он не является совместимым с JMX MBean. Инициализация ModelMBean гарантирует, что MBean является валидным.

MBeanException и RuntimeOperationsException должны выбрасываться для каждого публичного метода. Это позволяет обрабатывать исключения распределённых коммуникаций (RMI, EJB и т.д.). Эти исключения не обязательно должны выбрасываться реализацией, за исключением случаев, описанных в спецификации и javadoc.

С:: 1.5

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

Модификатор и тип	Метод	Описание
`void`	`addAttributeChangeNotificationListener(NotificationListener listener, String attributeName, Object handback)`	Регистрирует объект, реализующий интерфейс NotificationListener, в качестве слушателя.
`void`	`removeAttributeChangeNotificationListener(NotificationListener listener, String attributeName)`	Удаляет слушателя уведомлений об изменениях атрибутов из RequiredModelMBean.
`void`	`sendAttributeChangeNotification(AttributeChangeNotification notification)`	Отправляет уведомление об изменении атрибута, переданное зарегистрированным слушателям уведомлений об изменениях атрибутов на ModelMBean.
`void`	`sendAttributeChangeNotification(Attribute oldValue, Attribute newValue)`	Отправляет уведомление об изменении атрибута, содержащее старое и новое значения атрибута, зарегистрированным слушателям уведомлений об изменениях атрибутов на ModelMBean.
`void`	`sendNotification(String ntfyText)`	Отправляет уведомление, содержащее текстовую строку, переданную зарегистрированным слушателям уведомлений на ModelMBean.
`void`	`sendNotification(Notification ntfyObj)`	Отправляет уведомление, переданное зарегистрированным слушателям уведомлений на ModelMBean в качестве уведомления jmx.modelmbean.generic.

Методы, объявленные в интерфейсе javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

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

sendNotification

void sendNotification(Notification ntfyObj) throws MBeanException, RuntimeOperationsException

Отправляет уведомление, переданное зарегистрированным слушателям уведомлений на ModelMBean в качестве уведомления jmx.modelmbean.generic.

Параметры:: ntfyObj - Уведомление, которое должно быть передано методу 'handleNotification' объекта-слушателя.
Исключения:: MBeanException - Обёртка исключения распределённой коммуникации.; RuntimeOperationsException - Обёртка IllegalArgumentException: Объект Notification, переданный в параметре, равен null.

sendNotification

void sendNotification(String ntfyText) throws MBeanException, RuntimeOperationsException

Отправляет уведомление, содержащее текстовую строку, переданную зарегистрированным слушателям уведомлений на ModelMBean.

Параметры:: ntfyText - Текст, который должен быть передан в уведомление методу 'handleNotification' объекта-слушателя. Конструируемое уведомление будет иметь тип "jmx.modelmbean.generic", источник - экземпляр ModelMBean и последовательность 1.
Исключения:: MBeanException - Обёртка исключения распределённой коммуникации.; RuntimeOperationsException - Обёртка IllegalArgumentException: Текстовая строка уведомления, переданная в параметре, равна null.

sendAttributeChangeNotification

void sendAttributeChangeNotification(AttributeChangeNotification notification) throws MBeanException, RuntimeOperationsException

Отправляет уведомление об изменении атрибута, переданное зарегистрированным слушателям уведомлений об изменениях атрибутов на ModelMBean.

Параметры:: notification - Уведомление, которое должно быть передано методу 'handleNotification' объекта-слушателя.
Исключения:: MBeanException - Обёртка исключения распределённой коммуникации.; RuntimeOperationsException - Обёртка IllegalArgumentException: Объект AttributeChangeNotification, переданный в параметре, равен null.

sendAttributeChangeNotification

void sendAttributeChangeNotification(Attribute oldValue, Attribute newValue) throws MBeanException, RuntimeOperationsException

Отправляет уведомление об изменении атрибута, содержащее старое и новое значения атрибута, зарегистрированным слушателям уведомлений об изменениях атрибутов на ModelMBean.

Параметры:

oldValue - Исходное значение атрибута.

newValue - Текущее значение атрибута

 The constructed attributeChangeNotification will be:
   type        "jmx.attribute.change"
   source      this ModelMBean instance
   sequence    1
   attributeName oldValue.getName()
   attributeType oldValue's class
   attributeOldValue oldValue.getValue()
   attributeNewValue newValue.getValue()

Исключения:

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

RuntimeOperationsException - Обёртка IllegalArgumentException: Объект атрибута, переданный в параметре, равен null или имена двух объектов атрибута в параметре не совпадают.

addAttributeChangeNotificationListener

void addAttributeChangeNotificationListener(NotificationListener listener, String attributeName, Object handback) throws MBeanException, RuntimeOperationsException, IllegalArgumentException

Регистрирует объект, реализующий интерфейс NotificationListener, в качестве слушателя. Метод 'handleNotification()' этого объекта будет вызываться при каждом уведомлении об изменении атрибута, отправляемом или получаемом ModelMBean. Это не относится к другим уведомлениям. Их необходимо регистрировать отдельно. Уведомление AttributeChangeNotification будет сгенерировано для этого имени атрибута.

Параметры:

listener - Объект-слушатель, который будет обрабатывать уведомления, отправляемые зарегистрированным MBean.

attributeName - Имя атрибута ModelMBean, для которого нужно получать уведомления об изменениях. Если null, то все изменения атрибутов будут вызывать уведомление attributeChangeNotification.

handback - Контекст, который будет передан слушателю с уведомлением при отправке уведомления.

Исключения:

IllegalArgumentException - Слушатель не может быть null.

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

RuntimeOperationsException - Обёртка IllegalArgumentException: Имя атрибута, переданное в параметре, не существует.

См. также:

removeAttributeChangeNotificationListener

void removeAttributeChangeNotificationListener(NotificationListener listener, String attributeName) throws MBeanException, RuntimeOperationsException, ListenerNotFoundException

Удаляет слушателя уведомлений об изменениях атрибутов из RequiredModelMBean.

Параметры:

listener - Имя слушателя, который обрабатывал уведомления, отправляемые зарегистрированным MBean. Этот метод удалит всю информацию, связанную с этим слушателем.

attributeName - Атрибут, для которого слушатель больше не хочет получать уведомления об изменениях атрибутов. Если null, слушатель будет удалён для всех уведомлений об изменениях атрибутов.

Исключения:

ListenerNotFoundException - Слушатель не зарегистрирован в MBean или равен null.

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

RuntimeOperationsException - Обёртка IllegalArgumentException: Если параметр inAttributeName не соответствует имени атрибута.

См. также:

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