Spec-Zone.ru › OpenJDK 8

Класс Monitor

  • java.lang.Object
    • javax.management.NotificationBroadcasterSupport
      • javax.management.monitor.Monitor
Все реализованные интерфейсы:
MBeanRegistration, MonitorMBean, NotificationBroadcaster, NotificationEmitter
Прямые известные подклассы:
CounterMonitor, GaugeMonitor, StringMonitor

public abstract class Monitor
extends NotificationBroadcasterSupport
implements MonitorMBean, MBeanRegistration

Определяет общую часть для всех MBean мониторов. MBean монитор отслеживает значения атрибута, общего для набора наблюдаемых MBean. Наблюдаемый атрибут отслеживается через интервалы, заданные периодом дискретизации. Значение шкалы (производная шкала) выводится из значений наблюдаемого атрибута.

С:
1.5

Поля

Модификатор и тип Поле и описание
protected int alreadyNotified

Устарело.

эквивалентно alreadyNotifieds[0].

protected int[] alreadyNotifieds

Выбранные ошибки монитора, о которых уже было сообщено.

protected static int capacityIncrement

Размер, на который автоматически увеличивается емкость массивов монитора, когда их размер становится больше емкости.

protected String dbgTag

Устарело.

Замены нет.

protected int elementCount

Количество допустимых компонентов в векторе наблюдаемых объектов.

protected static int OBSERVED_ATTRIBUTE_ERROR_NOTIFIED

Флаг, обозначающий, что уведомление произошло после изменения наблюдаемого атрибута.

protected static int OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED

Флаг, обозначающий, что уведомление произошло после изменения наблюдаемого объекта или наблюдаемого атрибута.

protected static int OBSERVED_OBJECT_ERROR_NOTIFIED

Флаг, обозначающий, что уведомление произошло после изменения наблюдаемого объекта.

protected static int RESET_FLAGS_ALREADY_NOTIFIED

Этот флаг используется для сброса атрибута монитора alreadyNotifieds.

protected static int RUNTIME_ERROR_NOTIFIED

Флаг, обозначающий, что уведомление произошло после изменения наблюдаемого объекта или наблюдаемого атрибута.

protected MBeanServer server

Ссылка на сервер MBean.

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

Конструктор и описание
Monitor()

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

Модификатор и тип Метод и описание
void addObservedObject(ObjectName object)

Добавляет указанный объект в набор наблюдаемых MBean, если этот объект ещё не присутствует.

boolean containsObservedObject(ObjectName object)

Проверяет, присутствует ли указанный объект в наборе наблюдаемых MBean.

long getGranularityPeriod()

Получает период дискретизации (в миллисекундах).

String getObservedAttribute()

Получает наблюдаемый атрибут.

ObjectName getObservedObject()

Устарело.

Начиная с JMX 1.2, заменено на getObservedObjects()

ObjectName[] getObservedObjects()

Возвращает массив, содержащий наблюдаемые объекты.

boolean isActive()

Проверяет, активен ли монитор MBean.

void postDeregister()

Позволяет монитору MBean выполнить необходимые операции после того, как он был дерегистрирован сервером MBean.

void postRegister(Boolean registrationDone)

Позволяет монитору MBean выполнить необходимые операции после того, как он был зарегистрирован в сервере MBean или после того, как регистрация не удалась.

void preDeregister()

Позволяет монитору MBean выполнить необходимые операции перед дерегистрацией сервером MBean.

ObjectName preRegister(MBeanServer server, ObjectName name)

Позволяет монитору MBean выполнить необходимые операции перед регистрацией на сервере MBean.

void removeObservedObject(ObjectName object)

Удаляет указанный объект из набора наблюдаемых MBean.

void setGranularityPeriod(long period)

Устанавливает период дискретизации (в миллисекундах).

void setObservedAttribute(String attribute)

Устанавливает атрибут для наблюдения.

void setObservedObject(ObjectName object)

Устарело.

Начиная с JMX 1.2, заменено на addObservedObject(javax.management.ObjectName)

abstract void start()

Запускает монитор.

abstract void stop()

Останавливает монитор.

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

addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

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

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

Поля

capacityIncrement

protected static final int capacityIncrement

Количество, на которое автоматически увеличивается емкость массивов монитора, когда их размер становится больше их емкости.

См. также:
Значения постоянных полей

elementCount

protected int elementCount

Количество допустимых компонентов в векторе наблюдаемых объектов.

alreadyNotified

@Deprecated
protected int alreadyNotified

Устаревшее. эквивалентно alreadyNotifieds[0].

Ошибки монитора, о которых уже было сообщено.

alreadyNotifieds

protected int[] alreadyNotifieds

Выбранные ошибки монитора, о которых уже было сообщено.

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

server

protected MBeanServer server

Ссылка на сервер MBean. Эта ссылка равна null, когда MBean монитора не зарегистрирован на сервере MBean. Эта ссылка инициализируется до регистрации MBean монитора на сервере MBean.

См. также:
preRegister(MBeanServer server, ObjectName name)

RESET_FLAGS_ALREADY_NOTIFIED

protected static final int RESET_FLAGS_ALREADY_NOTIFIED

Этот флаг используется для сброса атрибута монитора alreadyNotifieds.

См. также:
Значения постоянных полей

OBSERVED_OBJECT_ERROR_NOTIFIED

protected static final int OBSERVED_OBJECT_ERROR_NOTIFIED

Флаг, обозначающий, что уведомление произошло после изменения наблюдаемого объекта. Этот флаг используется для проверки того, что новый наблюдаемый объект зарегистрирован на сервере MBean в момент первого уведомления.

См. также:
Значения постоянных полей

OBSERVED_ATTRIBUTE_ERROR_NOTIFIED

protected static final int OBSERVED_ATTRIBUTE_ERROR_NOTIFIED

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

См. также:
Значения постоянных полей

OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED

protected static final int OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED

Флаг, обозначающий, что уведомление произошло после изменения наблюдаемого объекта или наблюдаемого атрибута. Этот флаг используется для проверки того, что тип наблюдаемого атрибута корректен (в зависимости от используемого монитора) в момент первого уведомления.

См. также:
Значения постоянных полей

RUNTIME_ERROR_NOTIFIED

protected static final int RUNTIME_ERROR_NOTIFIED

Флаг, обозначающий, что уведомление произошло после изменения наблюдаемого объекта или наблюдаемого атрибута. Этот флаг используется для уведомления об любой исключительной ситуации (кроме случаев, описанных выше), при попытке получения значения наблюдаемого атрибута в момент первого уведомления.

См. также:
Значения постоянных полей

dbgTag

@Deprecated
protected String dbgTag

Устаревшее. Замены нет.

Это поле сохраняется для совместимости, но к нему не следует обращаться.

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

Monitor

public Monitor()

Методы

preRegister

public ObjectName preRegister(MBeanServer server,
                              ObjectName name)
                       throws Exception

Позволяет MBean монитора выполнять любые необходимые операции перед регистрацией на сервере MBean.

Инициализирует ссылку на сервер MBean.

Определено в:
preRegister в интерфейсе MBeanRegistration
Параметры:
server - Сервер MBean, на котором будет зарегистрирован MBean монитора.
name - Имя объекта MBean монитора.
Возвращает:
Имя зарегистрированного MBean монитора.
Выбрасывает:
Exception

postRegister

public void postRegister(Boolean registrationDone)

Позволяет MBean монитора выполнять любые необходимые операции после регистрации на сервере MBean или после неудачной регистрации.

В данном контексте не используется.

Определено в:
postRegister в интерфейсе MBeanRegistration
Параметры:
registrationDone - Указывает, была ли MBean успешно зарегистрирована на сервере MBean. Значение false означает, что фаза регистрации завершилась неудачно.

preDeregister

public void preDeregister()
                   throws Exception

Позволяет MBean монитора выполнять любые необходимые операции перед откреплением от сервера MBean.

Останавливает монитор.

Определено в:
preDeregister в интерфейсе MBeanRegistration
Выбрасывает:
Exception

postDeregister

public void postDeregister()

Позволяет MBean монитора выполнять любые необходимые операции после открепления от сервера MBean.

В данном контексте не используется.

Определено в:
postDeregister в интерфейсе MBeanRegistration

start

public abstract void start()

Запускает монитор.

Определено в:
start в интерфейсе MonitorMBean

stop

public abstract void stop()

Останавливает монитор.

Определено в:
stop в интерфейсе MonitorMBean

getObservedObject

@Deprecated
public ObjectName getObservedObject()

Устаревшее. С JMX 1.2 заменено на getObservedObjects()

Возвращает имя объекта первого объекта в наборе наблюдаемых MBean или null, если такого объекта нет.

Определено в:
getObservedObject в интерфейсе MonitorMBean
Возвращает:
Наблюдаемый объект.
См. также:
setObservedObject(ObjectName)

setObservedObject

@Deprecated
public void setObservedObject(ObjectName object)
                                   throws IllegalArgumentException

Устаревшее. С JMX 1.2 заменено на addObservedObject(javax.management.ObjectName)

Удаляет все объекты из набора наблюдаемых объектов, а затем добавляет указанный объект.

Определено в:
setObservedObject в интерфейсе MonitorMBean
Параметры:
object - Объект для наблюдения.
Выбрасывает:
IllegalArgumentException - Указанный объект равен null.
См. также:
getObservedObject()

addObservedObject

public void addObservedObject(ObjectName object)
                       throws IllegalArgumentException

Добавляет указанный объект в набор наблюдаемых MBean, если этот объект ещё не присутствует.

Определено в:
addObservedObject в интерфейсе MonitorMBean
Параметры:
object - Объект для наблюдения.
Выбрасывает:
IllegalArgumentException - Указанный объект равен null.

removeObservedObject

public void removeObservedObject(ObjectName object)

Удаляет указанный объект из набора наблюдаемых MBean.

Определено в:
removeObservedObject в интерфейсе MonitorMBean
Параметры:
object - Объект для удаления.

containsObservedObject

public boolean containsObservedObject(ObjectName object)

Проверяет, присутствует ли указанный объект в наборе наблюдаемых MBean.

Определено в:
containsObservedObject в интерфейсе MonitorMBean
Параметры:
object - Объект для проверки.
Возвращает:
true если указанный объект присутствует, false в противном случае.

getObservedObjects

public ObjectName[] getObservedObjects()

Возвращает массив, содержащий наблюдаемые объекты.

Определено в:
getObservedObjects в интерфейсе MonitorMBean
Возвращает:
Наблюдаемые объекты.

getObservedAttribute

public String getObservedAttribute()

Получает наблюдаемый атрибут.
Наблюдаемый атрибут по умолчанию не инициализирован (равен null).

Определено в:
getObservedAttribute в интерфейсе MonitorMBean
Возвращает:
Наблюдаемый атрибут.
См. также:
setObservedAttribute(java.lang.String)

setObservedAttribute

public void setObservedAttribute(String attribute)
                          throws IllegalArgumentException

Устанавливает атрибут для наблюдения.
Наблюдаемый атрибут по умолчанию не инициализирован (равен null).

Определено в:
setObservedAttribute в интерфейсе MonitorMBean
Параметры:
attribute - Атрибут для наблюдения.
Выбрасывает:
IllegalArgumentException - Указанный атрибут равен null.
См. также:
getObservedAttribute()

getGranularityPeriod

public long getGranularityPeriod()

Получает период дискретизации (в миллисекундах).
Значение периода дискретизации по умолчанию равно 10 секундам.

Определено в:
getGranularityPeriod в интерфейсе MonitorMBean
Возвращает:
Значение периода дискретизации.
См. также:
setGranularityPeriod(long)

setGranularityPeriod

public void setGranularityPeriod(long period)
                          throws IllegalArgumentException

Устанавливает период дискретизации (в миллисекундах).
Значение периода дискретизации по умолчанию равно 10 секундам.

Определено:
setGranularityPeriod в интерфейсе MonitorMBean
Параметры:
period - Значение периода гранулярности.
Исключения:
IllegalArgumentException - Период гранулярности меньше или равен нулю.
См. также:
getGranularityPeriod()

isActive

public boolean isActive()

Проверяет, является ли управляемый ресурс монитора MBean активным. Управляемый ресурс монитора MBean отмечается как активный при вызове метода start. Он становится неактивным при вызове метода stop.

Определено:
isActive в интерфейсе MonitorMBean
Возвращает:
true если управляемый ресурс монитора MBean активен, false в противном случае.

© 1993, 2020, 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.

Spec-Zone.ru

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