Spec-Zone.ru › OpenJDK 17

Интерфейс NotificationBroadcaster

Все известные подинтерфейсы:
ModelMBean, ModelMBeanNotificationBroadcaster, NotificationEmitter
Все известные реализующие классы:
CounterMonitor, GaugeMonitor, JMXConnectorServer, MBeanServerDelegate, Monitor, NotificationBroadcasterSupport, RelationService, RequiredModelMBean, RMIConnectorServer, StandardEmitterMBean, StringMonitor, Timer
public interface NotificationBroadcaster

Интерфейс, реализуемый MBean, который генерирует уведомления. Он позволяет зарегистрировать слушателя в качестве слушателя уведомлений MBean.

Распространение уведомлений

Когда MBean генерирует уведомление, он учитывает каждого слушателя, который был добавлен с помощью addNotificationListener и не был удален позднее с помощью removeNotificationListener. Если для данного слушателя был указан фильтр и метод фильтра isNotificationEnabled возвращает false, то слушатель игнорируется. В противном случае, вызывается метод слушателя handleNotification с уведомлением и объектом возврата, который был предоставлен addNotificationListener.

Если один и тот же слушатель добавляется более одного раза, он учитывается столько раз, сколько раз он был добавлен. Часто бывает полезно добавить одного и того же слушателя с разными фильтрами или объектами возврата.

Реализации этого интерфейса могут отличаться по потоку, в котором вызываются методы фильтров и слушателей.

Если вызов метода фильтра или слушателя генерирует Exception, то это исключение не должно препятствовать вызову других слушателей. Однако, если вызов метода генерирует Error, рекомендуется остановить обработку уведомления на этом этапе, и если возможно, передать Error отправителю уведомления, это следует сделать.

Новый код должен использовать интерфейс NotificationEmitter вместо этого.

Реализации этого интерфейса и NotificationEmitter должны быть внимательны к синхронизации. В частности, нежелательно, чтобы реализация удерживала какие-либо блокировки во время вызова слушателя. Для решения проблемы возможного изменения списка слушателей во время распространения уведомления, хорошая стратегия - использовать CopyOnWriteArrayList для этого списка.

Since:
1.5

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

Модификатор и тип Метод Описание
void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)
Добавляет слушателя к этому MBean.
MBeanNotificationInfo[] getNotificationInfo()
Возвращает массив, указывающий для каждого уведомления, которое может отправить этот MBean, имя класса Java уведомления и тип уведомления.
void removeNotificationListener(NotificationListener listener)
Удаляет слушателя из этого MBean.

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

addNotificationListener

void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) throws IllegalArgumentException
Добавляет слушателя к этому MBean.
Параметры:
listener - Объект слушателя, который будет обрабатывать уведомления, отправляемые распределителем уведомлений.
filter - Объект фильтра. Если filter равен null, фильтрация перед обработкой уведомлений не будет выполняться.
handback - Непрозрачный объект, который будет возвращен слушателю при отправке уведомления. Этот объект не может использоваться объектом распределителя уведомлений. Он должен быть передан неизменным вместе с уведомлением слушателю.
Исключения:
IllegalArgumentException - Параметр Listener равен null.
См. также:
  • removeNotificationListener(javax.management.NotificationListener)

removeNotificationListener

void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException
Удаляет слушателя из этого MBean. Если слушатель был зарегистрирован с различными объектами возврата или фильтрами уведомлений, все записи, соответствующие слушателю, будут удалены.
Параметры:
listener - Слушатель, который ранее был добавлен к этому MBean.
Исключения:
ListenerNotFoundException - Слушатель не зарегистрирован в MBean.
См. также:
  • addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
  • NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)

getNotificationInfo

MBeanNotificationInfo[] getNotificationInfo()

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

Не является ошибкой, если MBean отправляет уведомления, не описанные в этом массиве. Тем не менее, некоторые клиенты сервера MBean могут полагаться на то, что массив является полным для их корректной работы.

Возвращает:
массив возможных уведомлений.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API