Класс RequiredModelMBean

public RequiredModelMBean() throws MBeanException, RuntimeOperationsException

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

Свойства MBeanInfo и описатели RequiredModelMBean можно настроить с помощью метода setModelMBeanInfo(javax.management.modelmbean.ModelMBeanInfo). После настройки свойств MBeanInfo и описателей RequiredModelMBean можно зарегистрировать RequiredModelMBean в MBeanServer.

public RequiredModelMBean(ModelMBeanInfo mbi) throws MBeanException, RuntimeOperationsException

Создаёт объект RequiredModelMBean, используя переданный ModelMBeanInfo. Пока RequiredModelMBean не зарегистрирован в MBeanServer, свойства MBeanInfo и описатели RequiredModelMBean можно настроить с помощью метода setModelMBeanInfo(javax.management.modelmbean.ModelMBeanInfo). После настройки свойств MBeanInfo и описателей RequiredModelMBean можно зарегистрировать 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 предоставит свои собственные значения по умолчанию для этих отсутствующих уведомлений.

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

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

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" и сейчас > 'lastPersistTime' + 'persistPeriod'
• = "NoMoreOftenThan" и сейчас > 'lastPersistTime' + 'persistPeriod'

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

• = "never"
• = = "onTimer" && сейчас < 'lastPersistTime' + 'persistPeriod'
• = "onUnregister"
• = = "NoMoreOftenThan" и сейчас < 'lastPersistTime' + 'persistPeriod'

Модель ModelMBeanInfo объекта Model MBean сохраняется в файле.

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()

Возвращает хранилище Class Loader, используемое для загрузки классов. Подклассы могут переопределить этот метод, чтобы вернуть соответствующий 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.