Класс 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 или атрибуты в параметре равны 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 или атрибуты в параметре равны 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 — атрибут, уведомления attributeChangeNotification об изменениях которого прослушиватель больше не хочет получать. Если значение равно null, прослушиватель будет удалён для всех уведомлений attributeChangeNotification.

Исключения:

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, если параметр имени в одном из методов 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