compact3

javax.management.modelmbean

Интерфейс ModelMBeanInfo

Все Известные Классы с реализацией:

ModelMBeanInfoSupport

public interface ModelMBeanInfo

Этот интерфейс реализуется ModelMBeanInfo для каждого ModelMBean. Реализация этого интерфейса должна быть поставлена с каждым Агентом JMX.

Ресурсы Java, желающие быть управляемыми, инстанцируют ModelMBean, используя createMBean метод MBeanServer. Ресурс тогда устанавливает ModelMBeanInfo и Дескрипторы для экземпляра ModelMBean. Атрибуты, операции, и уведомления, представленные через ModelMBeanInfo для ModelMBean, включают интерфейс управления и доступны от MBeans, соединителей/адаптеров как другой MBeans. Через Дескрипторы значения и методы в управляемом приложении могут быть определены и отображены на атрибуты и операции ModelMBean. Это отображение может быть определено во время разработки в файле или динамически и программно во времени выполнения.

Каждый ModelMBean, который инстанцируют в MBeanServer, становится управляемым: ее атрибуты, операции, и уведомления становятся удаленно доступными через соединители/адаптеры, соединенные с тем MBeanServer. Объект Java не может быть зарегистрирован в MBeanServer, если это не совместимый MBean JMX. Инстанцируя ModelMBean, ресурсам гарантируют это, MBean допустим. MBeanException и RuntimeOperationsException должны быть брошены в каждый открытый метод. Это учитывает переносящиеся исключения из распределенной связи (RMI, EJB, и т.д.)

С тех пор:

1.5

Сводка метода

Модификатор и Тип	Метод и Описание
Объект	clone() Создает и возвращает копию этого объекта.
ModelMBeanAttributeInfo	getAttribute(String inName) Возвращает ModelMBeanAttributeInfo, который требуют по имени.
MBeanAttributeInfo[]	getAttributes() Возвращает список атрибутов, представленных для управления.
Строка	getClassName() Возвращает имя Java class MBean, описанного этим MBeanInfo.
MBeanConstructorInfo[]	getConstructors() Возвращает список общедоступных конструкторов MBean.
Строка	getDescription() Возвращает удобочитаемое описание MBean.
Дескриптор	getDescriptor(String inDescriptorName, String inDescriptorType) Возвращает Дескриптор, который требуют по имени и descriptorType.
Дескриптор[]	getDescriptors(String inDescriptorType) Возвращает массив Дескриптора, состоящий из всех Дескрипторов для ModelMBeanInfo типа inDescriptorType.
Дескриптор	getMBeanDescriptor() Возвращает дескриптор ModelMBean, который содержит широкие политики MBean.
ModelMBeanNotificationInfo	getNotification(String inName) Возвращает ModelMBeanNotificationInfo, который требуют по имени.
MBeanNotificationInfo[]	getNotifications() Возвращает список уведомлений, испускаемых MBean.
ModelMBeanOperationInfo	getOperation(String inName) Возвращает ModelMBeanOperationInfo, который требуют по имени.
MBeanOperationInfo[]	getOperations() Возвращает список операций MBean.
void	setDescriptor(Descriptor inDescriptor, String inDescriptorType) Дескрипторы наборов в массиве информации типа inDescriptorType для ModelMBean.
void	setDescriptors(Descriptor[] inDescriptors) Добавляет или заменяет дескрипторы в ModelMBeanInfo.
void	setMBeanDescriptor(Descriptor inDescriptor) Устанавливает дескриптор ModelMBean.

Деталь метода

getDescriptors

Descriptor[] getDescriptors(String inDescriptorType)
                     throws MBeanException,
                            RuntimeOperationsException

Возвращает массив Дескриптора, состоящий из всех Дескрипторов для ModelMBeanInfo типа inDescriptorType.

Параметры:

inDescriptorType - значение descriptorType поля, которое должно быть установлено для дескриптора быть возвращенным. Должен быть "mbean", "атрибут", "работа", "конструктор" или "уведомление". Если это будет нуль или пустой тогда, то все типы будут возвращены.

Возвраты:

Массив дескриптора, содержащий все дескрипторы для ModelMBean, если тип inDescriptorType.

Броски:

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

RuntimeOperationsException - Обертывает IllegalArgumentException, когда descriptorType в параметре не является одним из: "mbean", "атрибут", "работа", "конструктор", "уведомление", пустое или нулевое.

См. Также:

setDescriptors(javax.management.Descriptor[])

setDescriptors

void setDescriptors(Descriptor[] inDescriptors)
             throws MBeanException,
                    RuntimeOperationsException

Добавляет или заменяет дескрипторы в ModelMBeanInfo.

Параметры:

inDescriptors - Дескрипторы, которые будут установлены в ModelMBeanInfo. Будут проигнорированы нулевые элементы списка. У всех дескрипторов должны быть имя и descriptorType поля.

Броски:

RuntimeOperationsException - Обертывает IllegalArgumentException для нулевого или недопустимого дескриптора.

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

См. Также:

getDescriptors(java.lang.String)

getDescriptor

Descriptor getDescriptor(String inDescriptorName,
                         String inDescriptorType)
                  throws MBeanException,
                         RuntimeOperationsException

Возвращает Дескриптор, который требуют по имени и descriptorType.

Параметры:

inDescriptorName - Имя дескриптора.

inDescriptorType - Тип дескриптора, который требуют. Если это - нуль или пустой тогда, все типы ищутся. Допустимые типы являются 'mbean', 'атрибутом', 'конструктор' 'работа', и 'уведомление'. Это значение будет равно 'descriptorType' полю в дескрипторе, который возвращается.

Возвраты:

Дескриптор, содержащий дескриптор для ModelMBean с тем же самым именем и descriptorType. Если никакой дескриптор не находится, нуль возвращается.

Броски:

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

RuntimeOperationsException - Обертывает IllegalArgumentException для нулевого имени дескриптора или нулевого или недопустимого типа. Тип должен быть "mbean", "атрибутом", "конструктором", "работой", или "уведомлением".

См. Также:

setDescriptor(javax.management.Descriptor, java.lang.String)

setDescriptor

void setDescriptor(Descriptor inDescriptor,
                   String inDescriptorType)
            throws MBeanException,
                   RuntimeOperationsException

Дескрипторы наборов в массиве информации типа inDescriptorType для ModelMBean. setDescriptor метод соответствующего ModelMBean*Info вызовут, чтобы установить указанный дескриптор.

Параметры:

inDescriptor - Дескриптор, который будет установлен в ModelMBean. Это не должен быть нуль. У всех дескрипторов должны быть имя и descriptorType поля.

inDescriptorType - Тип устанавливаемого дескриптора. Если это - нуль тогда, descriptorType поле в дескрипторе используется. Если определено это значение должно быть установлено в descriptorType поле в дескрипторе. Должен быть "mbean", "атрибут", "конструктор", "работа", или "уведомление".

Броски:

RuntimeOperationsException - Обертывает IllegalArgumentException для недопустимых или нулевых параметров или если поле имени дескриптора не находится в соответствующем MBeanAttributeInfo или MBeanConstructorInfo или MBeanNotificationInfo или MBeanOperationInfo.

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

См. Также:

getDescriptor(java.lang.String, java.lang.String)

getMBeanDescriptor

Descriptor getMBeanDescriptor()
                       throws MBeanException,
                              RuntimeOperationsException

Возвращает дескриптор ModelMBean, который содержит широкие политики MBean. Этот дескриптор содержит метаданные о MBean и политиках значения по умолчанию для персистентности и кэширования.

Поля в дескрипторе определяются, но не ограничиваются, следующий. Отметьте, что, когда Типом в этой таблице является Число, Строка, которая является десятичным представлением Лонга, может также использоваться.

Имя	Ввести	Значение
имя	Строка	Имя MBean.
descriptorType	Строка	Должен быть "mbean".
displayName	Строка	Имя MBean, который будет использоваться в дисплеях.
persistPolicy	Строка	Один из: OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never. См. раздел "Поля Дескриптора MBean" в документе спецификации JMX.
persistLocation	Строка	Полностью определенное имя каталога, где MBean должен быть сохранен (если соответствующий).
persistFile	Строка	Имя файла, в которое должен быть сохранен MBean.
persistPeriod	Число	Частота сохраняет цикл в секундах для OnTime и NoMoreOftenThan PersistPolicy
currencyTimeLimit	Число	Сколько времени кэшируемое значение допустимо: <0 никогда, =0 всегда,> 0 секунд.
журнал	Строка	t: зарегистрируйте все уведомления, f: не зарегистрируйте уведомления.
файл журнала	Строка	Полностью определенное имя файла, чтобы зарегистрировать события к.
видимость	Число	1-4, где 1: всегда видимые 4: редко видимый.
экспорт	Строка	Имя, которое будет использоваться, чтобы экспортировать/представить этот MBean так, чтобы это был findable другими Агентами JMX.
presentationString	Строка	XML отформатированная строка, чтобы позволить представлению данных, которые будет связываться с MBean.

Дескриптор значения по умолчанию: name=className, descriptorType = "mbean", displayName=className, persistPolicy = "никогда", не регистрируют = "F", видимость = "1", Если дескриптор не будет содержать все эти поля, то они будут добавлены с этими значениями по умолчанию.

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

Возвраты:

дескриптор MBean.

Броски:

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

RuntimeOperationsException - a RuntimeException произошедший, получая дескриптор.

См. Также:

setMBeanDescriptor(javax.management.Descriptor)

setMBeanDescriptor

void setMBeanDescriptor(Descriptor inDescriptor)
                 throws MBeanException,
                        RuntimeOperationsException

Устанавливает дескриптор ModelMBean. Этот дескриптор содержит значение по умолчанию, MBean широкие метаданные о MBean и политиках значения по умолчанию для персистентности и кэширования. Эта работа делает полную замену дескриптора, никакое слияние не делается. Если дескриптор, чтобы установить в будет нулем тогда, то дескриптор значения по умолчанию будет создаваться. Дескриптор значения по умолчанию: name=className, descriptorType = "mbean", displayName=className, persistPolicy = "никогда", не регистрируют = "F", видимость = "1", Если дескриптор не будет содержать все эти поля, то они будут добавлены с этими значениями по умолчанию. См. getMBeanDescriptor метод javadoc для описания допустимых имен полей.

Параметры:

inDescriptor - дескриптор, чтобы установить.

Броски:

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

RuntimeOperationsException - Обертывает IllegalArgumentException для недопустимого дескриптора.

См. Также:

getMBeanDescriptor()

getAttribute

ModelMBeanAttributeInfo getAttribute(String inName)
                              throws MBeanException,
                                     RuntimeOperationsException

Возвращает ModelMBeanAttributeInfo, который требуют по имени.

Параметры:

inName - Имя ModelMBeanAttributeInfo, чтобы добраться. Если никакой ModelMBeanAttributeInfo не существует для этого нуля имени, возвращается.

Возвраты:

информация атрибута для именованного атрибута, или нуль, если нет ни одного.

Броски:

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

RuntimeOperationsException - Обертывает IllegalArgumentException для имени неопределенного атрибута.

getOperation

ModelMBeanOperationInfo getOperation(String inName)
                              throws MBeanException,
                                     RuntimeOperationsException

Возвращает ModelMBeanOperationInfo, который требуют по имени.

Параметры:

inName - Имя ModelMBeanOperationInfo, чтобы добраться. Если никакой ModelMBeanOperationInfo не существует для этого нуля имени, возвращается.

Возвраты:

информация работы для именованной работы, или нуль, если нет ни одного.

Броски:

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

RuntimeOperationsException - Обертывает IllegalArgumentException для нулевого имени работы.

getNotification

ModelMBeanNotificationInfo getNotification(String inName)
                                    throws MBeanException,
                                           RuntimeOperationsException

Возвращает ModelMBeanNotificationInfo, который требуют по имени.

Параметры:

inName - Имя ModelMBeanNotificationInfo, чтобы добраться. Если никакой ModelMBeanNotificationInfo не существует для этого нуля имени, возвращается.

Возвраты:

информация для именованного уведомления, или нуль, если нет ни одного.

Броски:

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

RuntimeOperationsException - Обертывает IllegalArgumentException для нулевого имени уведомления.

клон

Object clone()

Создает и возвращает копию этого объекта.

getAttributes

MBeanAttributeInfo[] getAttributes()

Возвращает список атрибутов, представленных для управления. Каждый атрибут описывается MBeanAttributeInfo объект.

Возвраты:

Массив MBeanAttributeInfo объекты.

getClassName

String getClassName()

Возвращает имя Java class MBean, описанного этим MBeanInfo.

Возвраты:

Java имя class.

getConstructors

MBeanConstructorInfo[] getConstructors()

Возвращает список общедоступных конструкторов MBean. Каждый конструктор описывается MBeanConstructorInfo объект.

Возвраты:

Массив MBeanConstructorInfo объекты.

getDescription

String getDescription()

Возвращает удобочитаемое описание MBean.

Возвраты:

описание.

getNotifications

MBeanNotificationInfo[] getNotifications()

Возвращает список уведомлений, испускаемых MBean. Каждое уведомление описывается MBeanNotificationInfo объект.

В дополнение к любому уведомлению, определенному приложением, ModelMBean может всегда отправлять также два дополнительных уведомления:

• Один с дескриптором называют "УНИВЕРСАЛЬНЫМ" и displayName "jmx.modelmbean.generic"
• Второй стандартное уведомление об изменении атрибута с "ATTRIBUTE_CHANGE" имени дескриптора и displayName "jmx.attribute.change"

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

Возвраты:

Массив MBeanNotificationInfo объекты.

getOperations

MBeanOperationInfo[] getOperations()

Возвращает список операций MBean. Каждая работа описывается MBeanOperationInfo объект.

Возвраты:

Массив MBeanOperationInfo объекты.