Пакет javax.management

Предоставляет основные классы для Java Management Extensions.

API Java Management Extensions (JMX™) — это стандартный API для управления и мониторинга. Типичные применения включают:

• консультацию и изменение конфигурации приложения
• собирание статистики о поведении приложения и её предоставление
• уведомление об изменениях состояния и ошибочных ситуациях.

API JMX также может использоваться как часть решения для управления системами, сетями и т. д.

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

MBean

Фундаментальное понятие API JMX — это MBean. MBean — это именованный управляемый объект, представляющий ресурс. У него есть интерфейс управления, который должен быть публичным и состоять из:

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

Например, MBean, представляющий конфигурацию приложения, может иметь атрибуты, представляющие различные элементы конфигурации. Чтение атрибута CacheSize вернёт текущее значение этого элемента. Запись в него обновит элемент, потенциально изменив поведение работающего приложения. Такая операция, как save, может сохранить текущую конфигурацию постоянно. Уведомление, такое как ConfigurationChangedNotification, может отправляться каждый раз при изменении конфигурации.

В стандартном использовании API JMX MBean реализуются как объекты Java. Однако, как описано ниже, к этим объектам обычно нет прямого доступа.

Стандартные MBean

Для упрощения реализации MBean API JMX включает понятие стандартных MBean. Стандартный MBean — это MBean, чьи атрибуты и операции выводятся из Java-интерфейса с использованием определённых схем именования, аналогичных тем, что используются в JavaBeans™. Например, рассмотрим такой интерфейс:

public interface ConfigurationMBean {
         public int getCacheSize();
         public void setCacheSize(int size);
         public long getLastChangedTime();
         public void save();
    }

Методы getCacheSize и setCacheSize определяют атрибут чтения/записи типа int под названием CacheSize (с заглавной буквы, в отличие от соглашений JavaBeans).

Метод getLastChangedTime определяет атрибут типа long под названием LastChangedTime. Это атрибут только для чтения, так как нет метода setLastChangedTime.

Метод save определяет операцию под названием save. Это не атрибут, так как его имя не начинается с get, set или is.

Точные схемы именования для стандартных MBean подробно описаны в Спецификации JMX.

Существует два способа создания объекта Java, являющегося MBean с этим интерфейсом управления. Один — создать объект класса, имеющего точно такое же имя, как Java-интерфейс, но без суффикса MBean. Таким образом, в примере объектом будет класс Configuration, в том же пакете Java, что и ConfigurationMBean. Второй способ — использовать класс StandardMBean.

MXBean

MXBean — это вариант стандартного MBean, где сложные типы отображаются на стандартный набор типов, определённых в пакете javax.management.openmbean. MXBean подходит, если вам нужно сослаться на классы, специфичные для приложения, в вашем интерфейсе MBean. Они подробно описаны в спецификации MXBean.

Динамические MBean

Динамический MBean — это MBean, который определяет свой интерфейс управления во время выполнения. Например, MBean конфигурации может определить имена и типы атрибутов, которые он предоставляет, анализируя XML-файл.

Любой объект Java класса, реализующего интерфейс DynamicMBean, является динамическим MBean.

Открытые MBean

Открытый MBean — это вид динамического MBean, где типы атрибутов и параметров и значений возвращаемых операций строятся с использованием небольшого набора предопределённых Java-классов. Открытые MBean облегчают работу с программами удалённого управления, которые, возможно, не имеют доступа к классам, специфичным для приложения, включая программы, не написанные на Java. Открытые MBean определяются пакетом javax.management.openmbean.

Модельные MBean

Модельный MBean — это вид динамического MBean, который служит мостом между интерфейсом управления и базовым управляемым ресурсом. Как интерфейс управления, так и управляемый ресурс задаются как объекты Java. Одну и ту же реализацию Модельного MBean можно многократно использовать с различными интерфейсами управления и управляемыми ресурсами, и она может предоставлять общую функциональность, такую как сохранение и кэширование. Модельные MBean определяются пакетом javax.management.modelmbean.

Сервер MBean

Для полезности MBean должен быть зарегистрирован в сервере MBean. Сервер MBean — это хранилище MBean. Обычно единственный доступ к MBean осуществляется через сервер MBean. Другими словами, код больше не обращается напрямую к объекту Java, реализующему MBean, а вместо этого обращается к MBean по имени через сервер MBean. Каждый MBean имеет уникальное имя в сервере MBean, определяемое классом ObjectName.

Сервер MBean — это объект, реализующий интерфейс MBeanServer. Наиболее удобным сервером MBean является платформенный сервер MBean. Это единственный сервер MBean, который может использоваться разными управляемыми компонентами, работающими в одной и той же виртуальной машине Java. Доступ к платформаному серверу MBean осуществляется с помощью метода ManagementFactory.getPlatformMBeanServer().

Код приложения также может создать новый сервер MBean или получить доступ к уже созданным серверам MBean с помощью класса MBeanServerFactory.

Создание MBean в сервере MBean

Существует два способа создания MBean. Один — создать объект Java, который будет MBean, а затем использовать метод registerMBean для его регистрации в сервере MBean. Другой — создать и зарегистрировать MBean в одной операции с помощью одного из методов createMBean.

Метод registerMBean проще для локального использования, но не может быть использован удалённо. Метод createMBean может быть использован удалённо, но иногда требует внимания к проблемам загрузки классов.

MBean может выполнять действия при регистрации или аннулировании регистрации в сервере MBean, если он реализует интерфейс MBeanRegistration.

Доступ к MBean в сервере MBean

Учитывая ObjectName name и MBeanServer mbs, вы можете получить доступ к атрибутам и операциям, как в этом примере:

int cacheSize = mbs.getAttribute(name, "CacheSize");
    Attribute newCacheSize =
         new Attribute("CacheSize", new Integer(2000));
    mbs.setAttribute(name, newCacheSize);
    mbs.invoke(name, "save", new Object[0], new Class[0]);

В качестве альтернативы, если у вас есть Java-интерфейс, соответствующий интерфейсу управления для MBean, вы можете использовать прокси MBean так:

ConfigurationMBean conf =
        JMX.newMBeanProxy(mbs, name, ConfigurationMBean.class);
    int cacheSize = conf.getCacheSize();
    conf.setCacheSize(2000);
    conf.save();

Использование прокси MBean — это просто удобство. Второй пример в конечном итоге вызывает те же MBeanServer операции, что и первый.

Сервер MBean может быть запрошен на MBean, чьи имена соответствуют определённым шаблонам и/или чьи атрибуты удовлетворяют определённым ограничениям. Шаблоны имён строятся с помощью класса ObjectName, а ограничения — с помощью класса Query. Методы queryNames и queryMBeans выполняют запрос.

Жизненный цикл MBean

MBean может реализовывать интерфейс MBeanRegistration, чтобы получать уведомления о регистрации и аннулировании регистрации в сервере MBean. Кроме того, метод preRegister позволяет MBean получить ссылку на объект MBeanServer и получить его ObjectName в сервере MBean.

Уведомления

Уведомление — это экземпляр класса Notification или подкласса. Помимо своего класса Java, он имеет строку типа, которая может отличить его от других уведомлений того же класса.

MBean, который будет испускать уведомления, должен реализовать интерфейс NotificationBroadcaster или NotificationEmitter. Обычно это делается путём наследования от NotificationBroadcasterSupport или делегирования экземпляру этого класса. Вот пример:

public class Configuration extends NotificationBroadcasterSupport
            implements ConfigurationMBean {
        ...
        private void updated() {
            Notification n = new Notification(...);
            sendNotification(n);
        }
    }

Уведомления могут получать слушатели, которые являются объектами, реализующими интерфейс NotificationListener. Вы можете добавить слушателя к MBean с помощью метода MBeanServer.addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object). Вы можете по желанию передать фильтр в этот метод, чтобы выбрать только уведомления, представляющие интерес. Фильтр — это объект, реализующий интерфейс NotificationFilter.

MBean может быть слушателем уведомлений, испускаемых другими MBean в одном сервере MBean. В этом случае он реализует NotificationListener, и используется метод MBeanServer.addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object) для прослушивания.

Удалённый доступ к MBean

Сервер MBean может быть доступен удалённо через коннектор. Коннектор позволяет удалённому приложению Java получить доступ к серверу MBean по существу так же, как и локальному. Пакет javax.management.remote определяет коннекторы.

Спецификация JMX также определяет понятие адаптера. Адаптер переводит запросы в таком протоколе, как SNMP или HTML, в доступ к серверу MBean. Таким образом, например, операция SNMP GET может привести к getAttribute на сервере MBean.

Взаимодействие между версиями спецификации JMX