javax.management.modelmbean

Класс ModelMBeanInfoSupport

java.lang. Объект

javax.management. MBeanInfo

javax.management.modelmbean.ModelMBeanInfoSupport

Все Реализованные Интерфейсы:

Сериализуемый, Cloneable, DescriptorRead, ModelMBeanInfo

public class ModelMBeanInfoSupport
extends MBeanInfo
implements ModelMBeanInfo

Этот класс представляет метаданные для ModelMBeans. Дескрипторы были добавлены на объектах метаданных.

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

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

serialVersionUID этого класса -1935722590756516193L.

С тех пор:

1.5

См. Также:

Сериализированная Форма

Сводка конструктора

Конструкторы

Конструктор и Описание
ModelMBeanInfoSupport(ModelMBeanInfo mbi) Создает ModelMBeanInfoSupport, который является копией данного ModelMBeanInfo.
ModelMBeanInfoSupport(String className, String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications) Создает ModelMBeanInfoSupport с предоставленной информацией, но дескриптор является значением по умолчанию.
ModelMBeanInfoSupport(String className, String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications, Descriptor mbeandescriptor) Создает ModelMBeanInfoSupport с предоставленной информацией и дескриптором, данным в параметре.

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

Методы

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

Методы javax.management унаследованный от класса. MBeanInfo

equals, getAttributes, getClassName, getConstructors, getDescription, getNotifications, getOperations, hashCode, toString

Методы java.lang унаследованный от класса. Объект

finalize, getClass, notify, notifyAll, wait, wait, wait

Методы, наследованные от интерфейса javax.management.modelmbean.ModelMBeanInfo

getAttributes, getClassName, getConstructors, getDescription, getNotifications, getOperations

Деталь конструктора

ModelMBeanInfoSupport

public ModelMBeanInfoSupport(ModelMBeanInfo mbi)

Создает ModelMBeanInfoSupport, который является копией данного ModelMBeanInfo. Возвращенный объект является мелкой копией данного объекта. Ни Дескриптор, ни содержавшие массивы (ModelMBeanAttributeInfo[] и т.д.), клонируются. Этот метод имеет в основном интерес изменить Дескриптор возвращенного экземпляра через setDescriptor не влияя на Дескриптор исходного объекта.

Параметры:

mbi - экземпляр ModelMBeanInfo, от которого инициализируется создаваемый ModelMBeanInfo.

ModelMBeanInfoSupport

public ModelMBeanInfoSupport(String className,
                     String description,
                     ModelMBeanAttributeInfo[] attributes,
                     ModelMBeanConstructorInfo[] constructors,
                     ModelMBeanOperationInfo[] operations,
                     ModelMBeanNotificationInfo[] notifications)

Создает ModelMBeanInfoSupport с предоставленной информацией, но дескриптор является значением по умолчанию. Дескриптор по умолчанию: name=className, descriptorType = "mbean", displayName=className, persistPolicy = "никогда", не регистрируют = "F", видимость = "1"

Параметры:

className - имя класса MBean

description - удобочитаемое описание ModelMBean

attributes - массив объектов ModelMBeanAttributeInfo, у которых есть дескрипторы

constructors - массив объектов ModelMBeanConstructorInfo, у которых есть дескрипторы

operations - массив объектов ModelMBeanOperationInfo, у которых есть дескрипторы

notifications - массив объектов ModelMBeanNotificationInfo, у которых есть дескрипторы

ModelMBeanInfoSupport

public ModelMBeanInfoSupport(String className,
                     String description,
                     ModelMBeanAttributeInfo[] attributes,
                     ModelMBeanConstructorInfo[] constructors,
                     ModelMBeanOperationInfo[] operations,
                     ModelMBeanNotificationInfo[] notifications,
                     Descriptor mbeandescriptor)

Создает ModelMBeanInfoSupport с предоставленной информацией и дескриптором, данным в параметре.

Параметры:

className - имя класса MBean

description - удобочитаемое описание ModelMBean

attributes - массив объектов ModelMBeanAttributeInfo, у которых есть дескрипторы

constructors - массив объектов ModelMBeanConstructorInfo, у которых есть дескриптор

operations - массив объектов ModelMBeanOperationInfo, у которых есть дескриптор

notifications - массив объектов ModelMBeanNotificationInfo, у которых есть дескриптор

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

Броски:

RuntimeOperationsException - Обертывает IllegalArgumentException для недопустимого дескриптора, который передают в параметре. (см. getMBeanDescriptor для определения допустимого дескриптора MBean.)

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

клон

public Object clone()

Возвращает мелкого клона этого экземпляра. Ни Дескриптор, ни содержавшие массивы (ModelMBeanAttributeInfo[] и т.д.), клонируются. Этот метод имеет в основном интерес изменить Дескриптор клона через setDescriptor не влияя на Дескриптор исходного объекта.

Определенный:

clone в интерфейсе ModelMBeanInfo

Переопределения:

clone в классе MBeanInfo

Возвраты:

мелкий клон этого экземпляра.

См. Также:

Cloneable

getDescriptors

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

Описание скопировало с интерфейса: ModelMBeanInfo

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

Определенный:

getDescriptors в интерфейсе ModelMBeanInfo

Параметры:

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

Возвраты:

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

Броски:

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

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

См. Также:

ModelMBeanInfo.setDescriptors(javax.management.Descriptor[])

setDescriptors

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

Описание скопировало с интерфейса: ModelMBeanInfo

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

Определенный:

setDescriptors в интерфейсе ModelMBeanInfo

Параметры:

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

Броски:

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

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

См. Также:

ModelMBeanInfo.getDescriptors(java.lang.String)

getDescriptor

public Descriptor getDescriptor(String inDescriptorName)
                         throws MBeanException,
                                RuntimeOperationsException

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

Параметры:

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

Возвраты:

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

Броски:

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

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

См. Также:

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

getDescriptor

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

Описание скопировало с интерфейса: ModelMBeanInfo

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

Определенный:

getDescriptor в интерфейсе ModelMBeanInfo

Параметры:

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

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

Возвраты:

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

Броски:

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

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

См. Также:

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

setDescriptor

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

Описание скопировало с интерфейса: ModelMBeanInfo

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

Определенный:

setDescriptor в интерфейсе ModelMBeanInfo

Параметры:

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

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

Броски:

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

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

См. Также:

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

getAttribute

public ModelMBeanAttributeInfo getAttribute(String inName)
                                     throws MBeanException,
                                            RuntimeOperationsException

Описание скопировало с интерфейса: ModelMBeanInfo

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

Определенный:

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

Параметры:

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

Возвраты:

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

Броски:

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

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

getOperation

public ModelMBeanOperationInfo getOperation(String inName)
                                     throws MBeanException,
                                            RuntimeOperationsException

Описание скопировало с интерфейса: ModelMBeanInfo

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

Определенный:

getOperation в интерфейсе ModelMBeanInfo

Параметры:

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

Возвраты:

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

Броски:

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

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

getConstructor

public ModelMBeanConstructorInfo getConstructor(String inName)
                                         throws MBeanException,
                                                RuntimeOperationsException

Возвращает ModelMBeanConstructorInfo, который требуют по имени. Если никакой ModelMBeanConstructorInfo не существует для этого нуля имени, возвращается.

Параметры:

inName - имя конструктора.

Возвраты:

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

Броски:

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

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

getNotification

public ModelMBeanNotificationInfo getNotification(String inName)
                                           throws MBeanException,
                                                  RuntimeOperationsException

Описание скопировало с интерфейса: ModelMBeanInfo

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

Определенный:

getNotification в интерфейсе ModelMBeanInfo

Параметры:

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

Возвраты:

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

Броски:

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

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

getDescriptor

public Descriptor getDescriptor()

Описание скопировало с класса: MBeanInfo

Получите дескриптор этого MBeanInfo. Изменение возвращенного значения будет иметь, не влияют на исходном дескрипторе.

Определенный:

getDescriptor в интерфейсе DescriptorRead

Переопределения:

getDescriptor в классе MBeanInfo

Возвраты:

дескриптор, который является или неизменным или копия оригинала.

С тех пор:

1.6

getMBeanDescriptor

public Descriptor getMBeanDescriptor()
                              throws MBeanException

Описание скопировало с интерфейса: ModelMBeanInfo

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

Определенный:

getMBeanDescriptor в интерфейсе ModelMBeanInfo

Возвраты:

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

Броски:

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

См. Также:

ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor)

setMBeanDescriptor

public void setMBeanDescriptor(Descriptor inMBeanDescriptor)
                        throws MBeanException,
                               RuntimeOperationsException

Описание скопировало с интерфейса: ModelMBeanInfo

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

Определенный:

setMBeanDescriptor в интерфейсе ModelMBeanInfo

Параметры:

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

Броски:

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

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

См. Также:

ModelMBeanInfo.getMBeanDescriptor()