Класс RequiredModelMBean

public RequiredModelMBean() throws MBeanException, RuntimeOperationsException

Возникает:

MBeanException - Обёртка исключения распределённой коммуникации.

RuntimeOperationsException - Обёртка RuntimeException во время создания объекта.

public RequiredModelMBean(ModelMBeanInfo mbi) throws MBeanException, RuntimeOperationsException

Параметры:

mbi - Объект ModelMBeanInfo, который будет использоваться RequiredModelMBean. Переданный ModelMBeanInfo клонируется и изменяется в соответствии с setModelMBeanInfo(javax.management.modelmbean.ModelMBeanInfo)

Возникает:

MBeanException - Обёртка исключения распределённой коммуникации.

RuntimeOperationsException - Обёртка IllegalArgumentException: Переданный в качестве параметра MBeanInfo равен null.

public void setModelMBeanInfo(ModelMBeanInfo mbi) throws MBeanException, RuntimeOperationsException

Задано:

setModelMBeanInfo в интерфейсе ModelMBean

Параметры:

mbi - Объект ModelMBeanInfo, который будет использоваться ModelMBean.

Возникает:

MBeanException - Обёртка исключения распределённой коммуникации.

RuntimeOperationsException -

• Обёртка IllegalArgumentException, если переданный MBeanInfo равен null.
• Обёртка IllegalStateException, если ModelMBean в настоящее время зарегистрирован в MBeanServer.

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

Задано:

setManagedResource в интерфейсе ModelMBean

Параметры:

mr - Объект управляемого ресурса

mr_type - Тип ссылки на управляемый ресурс.
Может быть: "ObjectReference", "Handle", "IOR", "EJBHandle" или "RMIReference".
В этой реализации поддерживается только "ObjectReference".

Возникает:

MBeanException - Инициализатор объекта выбросил исключение.

InstanceNotFoundException - Объект управляемого ресурса не найден

InvalidTargetObjectTypeException - Тип управляемого ресурса должен быть "ObjectReference".

RuntimeOperationsException - Обёртка RuntimeException при установке ресурса.

public void load() throws MBeanException, RuntimeOperationsException, InstanceNotFoundException

Задано:

load в интерфейсе PersistentMBean

Возникает:

MBeanException - Обёртка другого исключения или персистентность не поддерживается

RuntimeOperationsException - Обёртка исключений из механизма персистентности

InstanceNotFoundException - Этот MBean не найден или не загружен из постоянного хранилища

public void store() throws MBeanException, RuntimeOperationsException, InstanceNotFoundException

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

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

Задано:

store в интерфейсе PersistentMBean

Возникает:

MBeanException - Обёртка другого исключения или персистентность не поддерживается

RuntimeOperationsException - Обёртка исключений из механизма персистентности

InstanceNotFoundException - Невозможно найти/доступ к постоянному хранилищу

public MBeanInfo getMBeanInfo()

Задано:

getMBeanInfo в интерфейсе DynamicMBean

Возвращает:

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

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

Определено в:

invoke в интерфейсе DynamicMBean

Параметры:

opName - Имя вызываемого метода. Имя может быть полным квалифицированным именем метода, включая имя класса, или только именем метода, если имя класса определено в поле 'class' описателя операции.

opArgs - Массив, содержащий параметры, которые должны быть установлены при вызове операции

sig - Массив, содержащий сигнатуру операции. Объекты классов будут загружены с помощью того же загрузчика классов, что и тот, который использовался для загрузки MBean, на котором была вызвана операция.

Возвращает:

Объект, возвращённый методом, который представляет собой результат вызова метода на указанном управляемом ресурсе.

Имеет дело с:

MBeanException - Обёртка одного из следующих исключений:

• Исключение, выброшенное вызываемым методом управляемого объекта.
• ServiceNotFoundException: Нет ModelMBeanOperationInfo или нет описателя, определённого для указанной операции, или управляемый ресурс равен null.
• InvalidTargetObjectTypeException: Значение поля 'targetType' не равно 'objectReference'.

ReflectionException - Обёртка Exception, выброшенного во время попытки вызвать метод.

RuntimeOperationsException - Обёртка IllegalArgumentException: Имя метода равно null.

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

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

Определено в:

getAttributes в интерфейсе DynamicMBean

Параметры:

attrNames - Массив строк с именами атрибутов, которые нужно получить.

Возвращает:

Массив полученных атрибутов.

Имеет дело с:

RuntimeOperationsException - Обёртка IllegalArgumentException: Имя объекта в параметре равно null или атрибуты в параметре равны null.

См. также:

• setAttributes(javax.management.AttributeList)

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

Specified by:

setAttribute в интерфейсе DynamicMBean

Parameters:

attribute - Экземпляр атрибута, содержащий имя атрибута, который нужно установить, и значение, на которое нужно установить.

Throws:

AttributeNotFoundException - Указанный атрибут недоступен в объекте MBean.
Следующие случаи могут привести к исключению AttributeNotFoundException:

• Не найден ModelMBeanAttributeInfo для указанного атрибута.
• Метод isWritable объекта ModelMBeanAttributeInfo возвращает 'false'.

InvalidAttributeValueException - Для указанного атрибута не определён описатель.

MBeanException - Оборачивает одно из следующих исключений:

• Исключение, брошенное установщиком управляемого объекта.
• ServiceNotFoundException, если в описателе для атрибута определено поле setMethod, а управляемый ресурс равен null; или если поле setMethod не определено и кэширование для атрибута не включено. Обратите внимание, что если поле getMethod также отсутствует, то кэширование автоматически включается.
• InvalidTargetObjectTypeException Значение поля 'targetType' не равно 'objectReference'.
• Исключение, брошенное получателем управляемого объекта.

ReflectionException - Оборачивает исключение Exception, произошедшее при попытке вызвать установщик.

RuntimeOperationsException - Оборачивает исключение IllegalArgumentException: Атрибут в параметре равен null.

See Also:

• getAttribute(java.lang.String)

public AttributeList setAttributes(AttributeList attributes)

Specified by:

setAttributes в интерфейсе DynamicMBean

Parameters:

attributes - Список атрибутов: идентификация атрибутов, которые нужно установить, и значения, на которые нужно установить.

Returns:

Массив атрибутов, которые были установлены, с их новыми значениями в экземплярах атрибутов.

Throws:

RuntimeOperationsException - Оборачивает исключение IllegalArgumentException: Имя объекта в параметре равно null или атрибуты в параметре равны null.

See Also:

• getAttributes(java.lang.String[])

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

Specified by:

addNotificationListener в интерфейсе NotificationBroadcaster

Parameters:

listener - Объект слушателя, который будет обрабатывать уведомления, испускаемые зарегистрированным объектом MBean.

filter - Объект фильтра. Если null, никакое фильтрование не будет выполнено перед обработкой уведомлений.

handback - Контекст, который будет передан слушателю с уведомлением при отправке уведомления.

Throws:

IllegalArgumentException - Слушатель не может быть null.

See Also:

• removeNotificationListener(javax.management.NotificationListener)

public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException

Specified by:

removeNotificationListener в интерфейсе NotificationBroadcaster

Parameters:

listener - Имя слушателя, который обрабатывал уведомления, испускаемые зарегистрированным объектом MBean. Этот метод удалит всю информацию, связанную с этим слушателем.

Throws:

ListenerNotFoundException - Слушатель не зарегистрирован в объекте MBean или равен null.

See Also:

• addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)

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

Specified by:

removeNotificationListener в интерфейсе NotificationEmitter

Parameters:

listener - Слушатель, который был ранее добавлен в этот объект MBean.

filter - Фильтр, который был указан при добавлении слушателя.

handback - Обратная ссылка, которая была указана при добавлении слушателя.

Throws:

ListenerNotFoundException - Слушатель не зарегистрирован в объекте MBean или не зарегистрирован с заданным фильтром и обратной ссылкой.

public void sendNotification(Notification ntfyObj) throws MBeanException, RuntimeOperationsException

Specified by:

sendNotification в интерфейсе ModelMBeanNotificationBroadcaster

Parameters:

ntfyObj - Уведомление, которое должно быть передано методу 'handleNotification' объекта-слушателя.

Throws:

MBeanException - Оборачивает исключение распределённой коммуникации.

RuntimeOperationsException - Оборачивает исключение IllegalArgumentException: Объект уведомления, переданный в параметре, равен null.

public void sendNotification(String ntfyText) throws MBeanException, RuntimeOperationsException

Specified by:

sendNotification в интерфейсе ModelMBeanNotificationBroadcaster

Parameters:

ntfyText - Текст, который должен быть передан в уведомлении методу 'handleNotification' объекта-слушателя. Создаваемое уведомление будет: тип "jmx.modelmbean.generic", источник экземпляр данного объекта ModelMBean, последовательность 1

Throws:

MBeanException - Оборачивает исключение распределённой коммуникации.

RuntimeOperationsException - Оборачивает исключение IllegalArgumentException: Строка текста уведомления, переданная в параметре, равна null.

public MBeanNotificationInfo[] getNotificationInfo()

Specified by:

getNotificationInfo в интерфейсе NotificationBroadcaster

Returns:

MBeanNotificationInfo[]

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

Указано в:

addAttributeChangeNotificationListener в интерфейсе ModelMBeanNotificationBroadcaster

Параметры:

inlistener - Объект прослушивателя, который будет обрабатывать уведомления, отправляемые зарегистрированным MBean.

inAttributeName - Имя атрибута ModelMBean, для которого необходимо получать уведомления об изменениях. Если null, то все изменения атрибутов приведут к отправке attributeChangeNotification.

inhandback - Контекст, который будет отправлен прослушивателю вместе с уведомлением при его отправке.

Исключения:

MBeanException - Оборачивает исключение распределенного общения.

RuntimeOperationsException - Оборачивает IllegalArgumentException. Имя атрибута, переданное в параметре, не существует.

IllegalArgumentException - Прослушиватель не может быть null.

См. также:

• ModelMBeanNotificationBroadcaster.removeAttributeChangeNotificationListener(javax.management.NotificationListener, java.lang.String)

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

Указано в:

removeAttributeChangeNotificationListener в интерфейсе ModelMBeanNotificationBroadcaster

Параметры:

inlistener - Имя прослушивателя, который обрабатывал уведомления, отправляемые зарегистрированным MBean. Этот метод удалит всю информацию, связанную с этим прослушивателем.

inAttributeName - Атрибут, для которого прослушиватель больше не хочет получать attributeChangeNotifications. Если null, прослушиватель будет удален для всех attributeChangeNotifications.

Исключения:

MBeanException - Оборачивает исключение распределенного общения.

RuntimeOperationsException - Оборачивает IllegalArgumentException, если параметр inAttributeName не соответствует имени атрибута.

ListenerNotFoundException - Прослушиватель не зарегистрирован в MBean или равен null.

См. также:

• ModelMBeanNotificationBroadcaster.addAttributeChangeNotificationListener(javax.management.NotificationListener, java.lang.String, java.lang.Object)

public void sendAttributeChangeNotification(AttributeChangeNotification ntfyObj) throws MBeanException, RuntimeOperationsException

Указано в:

sendAttributeChangeNotification в интерфейсе ModelMBeanNotificationBroadcaster

Параметры:

ntfyObj - Уведомление, которое должно быть передано методу 'handleNotification' объекта прослушивателя.

Исключения:

MBeanException - Оборачивает исключение распределенного общения.

RuntimeOperationsException - Оборачивает IllegalArgumentException: Объект AttributeChangeNotification, переданный в параметре, равен null.

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

Указано в:

sendAttributeChangeNotification в интерфейсе ModelMBeanNotificationBroadcaster

Параметры:

inOldVal - Исходное значение для атрибута

inNewVal - Текущее значение для атрибута

 The constructed attributeChangeNotification will be:
   type        "jmx.attribute.change"
   source      this ModelMBean instance
   sequence    1
   attributeName oldValue.getName()
   attributeType oldValue's class
   attributeOldValue oldValue.getValue()
   attributeNewValue newValue.getValue()
 

Исключения:

MBeanException - Оборачивает исключение распределенного общения.

RuntimeOperationsException - Оборачивает IllegalArgumentException: Объект Attribute, переданный в параметре, равен null, или имена двух объектов Attribute в параметре не совпадают.

protected ClassLoaderRepository getClassLoaderRepository()

Возвращает:

репозиторий загрузчика классов.

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

Указано в:

preRegister в интерфейсе MBeanRegistration

Параметры:

server - Сервер MBean, в котором будет зарегистрирован MBean.

name - Имя объекта MBean. Это имя равно null, если параметр name одного из методов createMBean или registerMBean в интерфейсе MBeanServer равен null. В этом случае этот метод должен вернуть не null ObjectName для нового MBean.

Возвращает:

Имя, под которым должен быть зарегистрирован MBean. Это значение не должно быть null. Если параметр name не равен null, это обычно, но не обязательно, будет возвращаемым значением.

Исключения:

Exception - Это исключение будет перехвачено сервером MBean и повторно выброшено как MBeanRegistrationException.

public void postRegister(Boolean registrationDone)

Указано в:

postRegister в интерфейсе MBeanRegistration

Параметры:

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

public void preDeregister() throws Exception

Указано в:

preDeregister в интерфейсе MBeanRegistration

Исключения:

Exception - Это исключение будет перехвачено сервером MBean и повторно выброшено как MBeanRegistrationException.

public void postDeregister()

Указано в:

postDeregister в интерфейсе MBeanRegistration