Класс RequiredModelMBean

public RequiredModelMBean() throws MBeanException, RuntimeOperationsException

Создаёт RequiredModelMBean с пустым ModelMBeanInfo.

Информацию об MBean (MBeanInfo) и описатели (Descriptors) можно настроить, используя метод setModelMBeanInfo(javax.management.modelmbean.ModelMBeanInfo). После настройки информации об MBean и описателей, RequiredModelMBean можно зарегистрировать в MBeanServer.

public RequiredModelMBean(ModelMBeanInfo mbi) throws MBeanException, RuntimeOperationsException

Создаёт объект RequiredModelMBean, используя переданный ModelMBeanInfo. Пока RequiredModelMBean не зарегистрирован в MBeanServer, информацию об MBean (MBeanInfo) и описатели (Descriptors) можно настроить, используя метод setModelMBeanInfo(javax.management.modelmbean.ModelMBeanInfo). После настройки информации об MBean и описателей, RequiredModelMBean можно зарегистрировать в MBeanServer.

public void setModelMBeanInfo(ModelMBeanInfo mbi) throws MBeanException, RuntimeOperationsException

Инициализирует объект ModelMBean, используя переданный ModelMBeanInfo. Этот метод позволяет установить настроенный ModelMBeanInfo для ModelMBean, пока он не зарегистрирован в MBeanServer.
После того, как ModelMBeanInfo (с описателями) для ModelMBean будут настроены и установлены, ModelMBean можно зарегистрировать в MBeanServer.

Если ModelMBean в данный момент зарегистрирован, этот метод возбуждает RuntimeOperationsException, оборачивая IllegalStateException

Если переданный inModelMBeanInfo не содержит каких-либо ModelMBeanNotificationInfo для уведомлений GENERIC или ATTRIBUTE_CHANGE, то RequiredModelMBean предоставит собственные значения по умолчанию ModelMBeanNotificationInfo для этих пропущенных уведомлений.

public void setManagedResource(Object mr, String mr_type) throws MBeanException, RuntimeOperationsException, InstanceNotFoundException, InvalidTargetObjectTypeException

Устанавливает обработку объекта, к которому будут применяться все методы в этом интерфейсе управления ModelMBean (MBeanInfo и Descriptors).

public void load() throws MBeanException, RuntimeOperationsException, InstanceNotFoundException

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

Этот метод должен вызываться во время создания или инициализации этого экземпляра и до регистрации MBean в MBeanServer.

Если реализация этого класса не поддерживает постоянное хранилище, бросается MBeanException, оборачивающий ServiceNotFoundException.

public void store() throws MBeanException, RuntimeOperationsException, InstanceNotFoundException

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

Если реализация этого класса не поддерживает постоянное хранилище, бросается MBeanException, оборачивающий ServiceNotFoundException.

Политика сохранения из MBean и описателя атрибута используется для руководства выполнением этого метода. MBean должен быть сохранён, если поле 'persistPolicy' имеет значение:

 != "never"
   = "always"
   = "onTimer" and now > 'lastPersistTime' + 'persistPeriod'
   = "NoMoreOftenThan" and now > 'lastPersistTime' + 'persistPeriod'
   = "onUnregister"
 

Не сохраняйте MBean, если поле 'persistPolicy' имеет значение:

    = "never"
    = "onUpdate"
    = "onTimer" && now < 'lastPersistTime' + 'persistPeriod'
 

public MBeanInfo getMBeanInfo()

Возвращает атрибуты, операции, конструкторы и уведомления, которые этот RequiredModelMBean предоставляет для управления.

public Object invoke(String opName, Object[] opArgs, String[] sig) throws MBeanException, ReflectionException

Вызывает метод на или через RequiredModelMBean и возвращает результат выполнения метода.

Если заданный метод для вызова, вместе с предоставленной сигнатурой, соответствует одному из доступных методов RequiredModelMbean, этот метод будет вызван. В противном случае вызов заданного метода будет выполнен на управляемом ресурсе.

Последнее значение, возвращённое операцией, может быть кэшировано в описателе операции, который находится в описателе ModelMBeanOperationInfo. Действительное значение будет в поле 'value', если оно есть. Если поле 'currencyTimeLimit' в описателе:

• <0 Тогда значение не кэшируется и никогда не является действительным. Метод операции вызывается. Поля 'value' и 'lastUpdatedTimeStamp' очищаются.
• =0 Тогда значение всегда кэшируется и всегда действительное. Возвращается поле 'value'. Если поля 'value' нет, то метод операции вызывается для атрибута. Поля 'lastUpdatedTimeStamp' и 'value' устанавливаются в значение возврата операции и текущей метке времени.
• >0 Представляет количество секунд, в течение которого поле 'value' является действительным. Поле 'value' больше не является действительным, когда 'lastUpdatedTimeStamp' + 'currencyTimeLimit' > Текущее время.
  • Если 'value' действителен, возвращается 'value'.
  • Если 'value' больше не действителен, то вызывается метод операции. Поля 'lastUpdatedTimeStamp' и `value` обновляются.

Примечание: из-за несоответствий в предыдущих версиях этого спецификации рекомендуется не использовать отрицательные или нулевые значения для currencyTimeLimit. Чтобы указать, что кэшированное значение никогда не является действительным, опустите поле currencyTimeLimit. Чтобы указать, что оно всегда действительное, используйте очень большое число для этого поля.

public Object getAttribute(String attrName) throws AttributeNotFoundException, MBeanException, ReflectionException

Возвращает значение определённого атрибута для этого ModelMBean. Последнее возвращенное значение атрибута может быть кэшировано в описателе атрибута. Действительное значение будет в поле 'value', если оно есть. Если поле 'currencyTimeLimit' в описателе:

• <0 Тогда значение не кэшируется и никогда не является действительным. Метод-получатель вызывается для атрибута. Поля 'value' и 'lastUpdatedTimeStamp' очищаются.
• =0 Тогда значение всегда кэшируется и всегда действительное. Возвращается поле 'value'. Если поля 'value' нет, то метод-получатель вызывается для атрибута. Поля 'lastUpdatedTimeStamp' и `value` устанавливаются в значение атрибута и текущей метке времени.
• >0 Представляет количество секунд, в течение которого поле 'value' является действительным. Поле 'value' больше не является действительным, когда 'lastUpdatedTimeStamp' + 'currencyTimeLimit' > Текущее время.
  • Если 'value' действителен, возвращается 'value'.
  • Если 'value' больше не действителен, то метод-получатель вызывается для атрибута. Поля 'lastUpdatedTimeStamp' и `value` обновляются.

Примечание: из-за несоответствий в предыдущих версиях этого спецификации рекомендуется не использовать отрицательные или нулевые значения для currencyTimeLimit. Чтобы указать, что кэшированное значение никогда не является действительным, опустите поле currencyTimeLimit. Чтобы указать, что оно всегда действительное, используйте очень большое число для этого поля.

Если поле 'getMethod' содержит имя действительного описателя операции, то выполняется метод, описанный в описателе операции. Ответ от метода возвращается как значение атрибута. Если операция завершается ошибкой или возвращаемое значение несовместимо с объявленным типом атрибута, будет выброшено исключение.

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

Объявленный тип атрибута - это строка, возвращаемая MBeanAttributeInfo.getType(). Значение совместимо с этим типом, если выполняется одно из следующих условий:

• значение равно null;
• объявленное имя - это имя примитивного типа (например, "int"), а значение - это экземпляр соответствующего типа обертки (например, java.lang.Integer);
• имя класса значения идентично объявленному имени;
• объявленное имя может быть загружено загрузчиком классов значения и создаёт класс, которому может быть назначено значение.

В этой реализации, в каждом случае, когда необходимо вызвать getMethod, так как метод вызывается через стандартный метод "invoke" и, таким образом, требует operationInfo, операция должна быть указана для этого getMethod, чтобы вызов работал корректно.

public AttributeList getAttributes(String[] attrNames)

Возвращает значения нескольких атрибутов в ModelMBean. Выполняет getAttribute для каждого имени атрибута в массиве attrNames, переданном в параметре.

public void setAttribute(Attribute attribute) throws AttributeNotFoundException, InvalidAttributeValueException, MBeanException, ReflectionException

Устанавливает значение определённого атрибута именованного объекта ModelMBean. Если поле 'setMethod' в описателе атрибута содержит имя допустимого описателя операции, то выполняется метод, описываемый этим описателем операции. В этой реализации описатель операции должен быть правильно указан и назначен в modelMBeanInfo, чтобы 'setMethod' работал корректно. Ответ от метода устанавливается в качестве значения атрибута в описателе.

Если currencyTimeLimit > 0, то новое значение атрибута кэшируется в поле 'value' описателя атрибута, а поле 'lastUpdatedTimeStamp' устанавливается в текущую отметку времени.

Если поле persist в описателе атрибута не равно null, то для хранения атрибута используется политика сохранения из описателя атрибута.
Сохранять объект MBean, если поле 'persistPolicy' имеет значение:

• != "never"
• = "always"
• = "onUpdate"
• = "onTimer" и now > 'lastPersistTime' + 'persistPeriod'
• = "NoMoreOftenThan" и now > 'lastPersistTime' + 'persistPeriod'

Не сохранять объект MBean, если поле 'persistPolicy' имеет значение:

• = "never"
• = = "onTimer" && now < 'lastPersistTime' + 'persistPeriod'
• = "onUnregister"
• = = "NoMoreOftenThan" и now < 'lastPersistTime' + 'persistPeriod'

Модель ModelMBeanInfo хранится в файле.

public AttributeList setAttributes(AttributeList attributes)

Устанавливает значения массива атрибутов этого объекта ModelMBean. Выполняет метод setAttribute() для каждого атрибута в списке.

public void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) throws IllegalArgumentException

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

public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException

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

public void removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) throws ListenerNotFoundException

Удаляет слушателя из этого объекта MBean. Объект MBean должен иметь слушателя, который точно соответствует предоставленным listener, filter, и handback параметрам. Если таких слушателей более одного, удаляется только один.

Параметры filter и handback могут быть равны null, только если они равны null у удаляемого слушателя.

public void sendNotification(Notification ntfyObj) throws MBeanException, RuntimeOperationsException

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

public void sendNotification(String ntfyText) throws MBeanException, RuntimeOperationsException

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

public MBeanNotificationInfo[] getNotificationInfo()

Возвращает массив уведомлений, всегда генерируемых объектом RequiredModelMBean.

RequiredModelMBean может также всегда отправлять два дополнительных уведомления:

• Одно с описателем "name=GENERIC,descriptorType=notification,log=T,severity=6,displayName=jmx.modelmbean.generic"
• Второе — стандартное уведомление об изменении атрибута с описателем "name=ATTRIBUTE_CHANGE,descriptorType=notification,log=T,severity=6,displayName=jmx.attribute.change"

Таким образом, эти два уведомления всегда добавляются к тем, которые указаны приложением.

public void addAttributeChangeNotificationListener(NotificationListener inlistener, String inAttributeName, Object inhandback) throws MBeanException, RuntimeOperationsException, IllegalArgumentException

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

public void removeAttributeChangeNotificationListener(NotificationListener inlistener, String inAttributeName) throws MBeanException, RuntimeOperationsException, ListenerNotFoundException

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

public void sendAttributeChangeNotification(AttributeChangeNotification ntfyObj) throws MBeanException, RuntimeOperationsException

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

public void sendAttributeChangeNotification(Attribute inOldVal, Attribute inNewVal) throws MBeanException, RuntimeOperationsException

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

protected ClassLoaderRepository getClassLoaderRepository()

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

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

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

Для обеспечения правильной семантики выполнения RequireModelMBean, любой подкласс RequiredModelMBean, переопределяющий или перегружающий этот метод, должен вызвать super.preRegister(server, name) в своей собственной реализации preRegister.

public void postRegister(Boolean registrationDone)

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

Для обеспечения правильной семантики выполнения RequireModelMBean, любой подкласс RequiredModelMBean, переопределяющий или перегружающий этот метод, должен вызвать super.postRegister(registrationDone) в своей собственной реализации postRegister.

public void preDeregister() throws Exception

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

Для обеспечения правильной семантики выполнения RequireModelMBean, любой подкласс RequiredModelMBean, переопределяющий или перегружающий этот метод, должен вызвать super.preDeregister() в своей собственной реализации preDeregister.

public void postDeregister()

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

Для обеспечения правильной семантики выполнения RequireModelMBean, любой подкласс RequiredModelMBean, переопределяющий или перегружающий этот метод, должен вызвать super.postDeregister() в своей собственной реализации postDeregister.