Класс RequiredModelMBean

public RequiredModelMBean() throws MBeanException, RuntimeOperationsException

Исключения:

MBeanException — оборачивает исключение распределенной связи.

RuntimeOperationsException — оборачивает RuntimeException при создании объекта.

public RequiredModelMBean(ModelMBeanInfo mbi) throws MBeanException, RuntimeOperationsException

Параметры:

mbi — объект ModelMBeanInfo, который будет использоваться RequiredModelMBean. Переданный ModelMBeanInfo клонируется и изменяется, как указано в setModelMBeanInfo(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

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

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

Параметры:

attrName — строка, задающая имя извлекаемого атрибута. Оно должно совпадать с именем ModelMBeanAttributeInfo.

Возвращает:

Значение извлеченного атрибута из поля 'value' дескриптора или в результате вызова операции, указанной в поле 'getMethod' дескриптора.

Исключения:

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

• Для Model MBean не найден ModelMBeanInfo.
• Для указанного имени атрибута не найден ModelMBeanAttributeInfo.
• Метод isReadable объекта ModelMBeanAttributeInfo возвращает 'false'.

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

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

ReflectionException — оборачивает Exception, выброшенное при попытке вызвать метод получения.

RuntimeOperationsException — оборачивает IllegalArgumentException: имя атрибута в параметре равно null.

См. также:

• setAttribute(javax.management.Attribute)

public AttributeList getAttributes(String[] attrNames)

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

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

Параметры:

attrNames — массив строк с именами извлекаемых атрибутов.

Возвращает:

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

Исключения:

RuntimeOperationsException — оборачивает IllegalArgumentException: имя объекта в параметре или атрибуты в параметре равны null.

См. также:

• setAttributes(javax.management.AttributeList)

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

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

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

Параметры:

attribute — экземпляр Attribute, содержащий имя атрибута, которому задается значение, и само значение.

Исключения:

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

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

InvalidAttributeValueException — для указанного атрибута не определен дескриптор.

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

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

ReflectionException — оборачивает Exception, выброшенное при попытке вызвать метод установки.

RuntimeOperationsException — оборачивает IllegalArgumentException: атрибут в параметре равен null.

См. также:

• getAttribute(java.lang.String)

public AttributeList setAttributes(AttributeList attributes)

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

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

Параметры:

attributes — список атрибутов: идентификаторы атрибутов, которым задаются значения, и сами значения.

Возвращает:

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

Исключения:

RuntimeOperationsException — оборачивает IllegalArgumentException: имя объекта в параметре или атрибуты в параметре равны null.

См. также:

• getAttributes(String[])

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

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

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

Параметры:

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

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

handback — контекст, отправляемый слушателю вместе с уведомлением при его выдаче.

Исключения:

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

См. также:

• removeNotificationListener(NotificationListener)

public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException

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

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

Параметры:

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

Исключения:

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

См. также:

• addNotificationListener(NotificationListener, NotificationFilter, Object)

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

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

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

Параметры:

listener — слушатель, ранее добавленный в этот MBean.

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

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

Исключения:

ListenerNotFoundException — слушатель не зарегистрирован в MBean либо не зарегистрирован с указанными фильтром и handback.

public void sendNotification(Notification ntfyObj) throws MBeanException, RuntimeOperationsException

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

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

Параметры:

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

Исключения:

MBeanException — оборачивает исключение распределенной связи.

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

public void sendNotification(String ntfyText) throws MBeanException, RuntimeOperationsException

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

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

Параметры:

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

Исключения:

MBeanException — оборачивает исключение распределенной связи.

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

public MBeanNotificationInfo[] getNotificationInfo()

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

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

Возвращает:

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(NotificationListener, 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(NotificationListener, String, 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. В этом случае данный метод должен вернуть ненулевой 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