compact3

javax.management.modelmbean

Interface ModelMBeanInfo

所有已知实现类：

ModelMBeanInfoSupport

public interface ModelMBeanInfo

此接口由每ModelMBean ModelMBeanInfo实现的。此接口的实现必须随每个JMX代理。

java资源希望能够实例化ModelMBean MBeanServer creatembean方法的使用。资源建立了ModelMBeanInfo和描述符为ModelMBean实例。属性，操作，和通知通过为ModelMBean暴露了ModelMBeanInfo包括管理界面，可以从MBean，连接器/适配器像其他MBeans。通过描述，在托管的应用价值和方法可以被定义和映射到的ModelMBean属性和操作。这个映射可以定义在一个文件或程序在运行时动态的发展过程中。

这是每个ModelMBean MBeanServer实例化成为可控的：其属性，操作，和通知成为远程访问连接，通过MBeanServer连接器/适配器。一个java对象不能注册MBeanServer除非是JMX兼容MBean。通过实例化一个ModelMBean，资源保证MBean是有效的。mbeanexception和runtimeoperationsexception必须扔在每个公共方法。这使得包装从分布式通信异常（RMI、EJB、等）

从以下版本开始：

一点五

方法摘要

Modifier and Type	Method and Description
Object	clone() 创建并返回此对象的副本。
ModelMBeanAttributeInfo	getAttribute(String inName) 返回请求的名称modelmbeanattributeinfo。
MBeanAttributeInfo[]	getAttributes() 返回用于管理的属性列表。
String	getClassName() 返回的MBean所描述的这 MBeanInfo java类的名称。
MBeanConstructorInfo[]	getConstructors() 返回的MBean的公共构造函数列表。
String	getDescription() 返回一个人类的MBean可读的描述。
Descriptor	getDescriptor(String inDescriptorName, String inDescriptorType) 返回的名称和descriptortype请求描述符。
Descriptor[]	getDescriptors(String inDescriptorType) 返回一个描述符阵列组成的所有描述符的类型indescriptortype ModelMBeanInfo。
Descriptor	getMBeanDescriptor() 返回的描述符包含MBean ModelMBean宽政策。
ModelMBeanNotificationInfo	getNotification(String inName) 返回请求的名称modelmbeannotificationinfo。
MBeanNotificationInfo[]	getNotifications() 返回由MBean发出的通知列表。
ModelMBeanOperationInfo	getOperation(String inName) 返回请求的名称modelmbeanoperationinfo。
MBeanOperationInfo[]	getOperations() 返回的MBean操作列表。
void	setDescriptor(Descriptor inDescriptor, String inDescriptorType) 集描述为ModelMBean型indescriptortype信息阵。
void	setDescriptors(Descriptor[] inDescriptors) 添加或更换在ModelMBeanInfo描述符。
void	setMBeanDescriptor(Descriptor inDescriptor) 集ModelMBean的描述符。

方法详细信息

getDescriptors

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

返回一个描述符阵列组成的所有描述符的类型indescriptortype ModelMBeanInfo。

参数

inDescriptorType值descriptortype场必须设置为描述符被退回。必须“MBean”、“属性”、“操作”、“构造函数”或“通知”。如果它是空的或空的，那么所有类型将被返回。

结果

描述符数组包含的所有描述符如果型indescriptortype ModelMBean。

异常

MBeanException套分布式通信异常。

RuntimeOperationsException -包装时在参数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”字段。

结果

包含具有相同的名称和descriptortype ModelMBean描述符的描述符。如果没有找到描述符，则返回。

异常

MBeanException套分布式通信异常。

RuntimeOperationsException包为空描述符名称或空的或无效的类型时。类型必须是“管理”、“属性”、“建设者”、“操作”，或“通知”。

另请参见：

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

setDescriptor

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

集描述为ModelMBean型indescriptortype信息阵。相应的信息setdescriptor ModelMBean *的方法来设置指定的描述符。

参数

inDescriptor的描述符被设置在ModelMBean。它不能为空。所有的描述符的名称必须和descriptortype领域。

inDescriptorType的描述符被设置的类型。如果这是零那么描述符中的descriptortype场用。如果指定此值必须在描述中descriptortype字段集。必须“MBean”、“属性”、“建设者”、“操作”，或“通知”。

异常

RuntimeOperationsException包非法或空参数或者广义的名称字段不在相应的mbeanattributeinfo或mbeanconstructorinfo或mbeannotificationinfo或mbeanoperationinfo发现时。

MBeanException套分布式通信异常。

另请参见：

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

getMBeanDescriptor

Descriptor getMBeanDescriptor()
                       throws MBeanException,
                              RuntimeOperationsException

返回的描述符包含MBean ModelMBean宽政策。这个描述符包含关于持久MBean和默认策略和缓存元数据。

描述符中的字段被定义，但不限于以下几个字段。请注意，当此表中的类型是数字时，也可以使用一个长的十进制表示形式的字符串。

Name	Type	Meaning
name	String	MBean name.
descriptorType	String	Must be "mbean".
displayName	String	Name of MBean to be used in displays.
persistPolicy	String	One of: OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never. See the section "MBean Descriptor Fields" in the JMX specification document.
persistLocation	String	The fully qualified directory name where the MBean should be persisted (if appropriate).
persistFile	String	File name into which the MBean should be persisted.
persistPeriod	Number	Frequency of persist cycle in seconds, for OnTime and NoMoreOftenThan PersistPolicy
currencyTimeLimit	Number	How long cached value is valid: <0 never, =0 always, >0 seconds.
log	String	t: log all notifications, f: log no notifications.
logfile	String	Fully qualified filename to log events to.
visibility	Number	1-4 where 1: always visible 4: rarely visible.
export	String	Name to be used to export/expose this MBean so that it is findable by other JMX Agents.
presentationString	String	XML formatted string to allow presentation of data to be associated with the MBean.

默认的描述是：名称= className，descriptortype =“MBean，DisplayName = className，persistpolicy =“从不”，日志=“F”，可视为“1”如果描述不包含所有的这些领域，他们将加入这些默认值。

注：由于在本规范的早期版本不一致，建议不要使用负数或零值currencyTimeLimit。显示缓存的值是永远有效，省略currencyTimeLimit场。为了表示它始终是有效的，为这个字段使用一个非常大的数字。

结果

MBean描述符。

异常

MBeanException套分布式通信异常。

RuntimeOperationsException - RuntimeException发生在获取描述符。

另请参见：

setMBeanDescriptor(javax.management.Descriptor)

setMBeanDescriptor

void setMBeanDescriptor(Descriptor inDescriptor)
                 throws MBeanException,
                        RuntimeOperationsException

集ModelMBean的描述符。这个描述符包含默认，MBean元数据广泛持久MBean和默认策略和缓存。此操作完成了描述符的完整替换，没有完成合并。如果要设置为是为空的描述符，则将创建默认的描述符。默认的描述是：名称= className，descriptortype =“MBean，DisplayName = className，persistpolicy =“从不”，日志=“F”，可视为“1”如果描述不包含所有的这些领域，他们将加入这些默认值。看到有效的字段名称描述方法 getMBeanDescriptor javadoc。

参数

inDescriptor的描述符集。

异常

MBeanException套分布式通信异常。

RuntimeOperationsException包描述符无效时。

另请参见：

getMBeanDescriptor()

getAttribute

ModelMBeanAttributeInfo getAttribute(String inName)
                              throws MBeanException,
                                     RuntimeOperationsException

返回请求的名称modelmbeanattributeinfo。

参数

inName - ModelMBeanAttributeInfo的名字取得。如果这个名字没有modelmbeanattributeinfo存在返回。

结果

属性信息的命名属性，或无效，如果没有。

异常

MBeanException套分布式通信异常。

RuntimeOperationsException包为空属性的名字时。

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。

clone

Object clone()

创建并返回此对象的副本。

getAttributes

MBeanAttributeInfo[] getAttributes()

返回用于管理的属性列表。每个属性由一个 MBeanAttributeInfo对象描述。

结果

对 MBeanAttributeInfo对象数组。

getClassName

String getClassName()

返回的MBean所描述的这 MBeanInfo java类的名称。

结果

java类的名字。

getConstructors

MBeanConstructorInfo[] getConstructors()

返回的MBean的公共构造函数列表。每个构造函数是由 MBeanConstructorInfo对象描述。

结果

对 MBeanConstructorInfo对象数组。

getDescription

String getDescription()

返回一个人类的MBean可读的描述。

结果

描述。

getNotifications

MBeanNotificationInfo[] getNotifications()

返回由MBean发出的通知列表。每个通知由 MBeanNotificationInfo对象描述。

除了由应用程序指定的任何通知，ModelMBean可能永远也送两个额外的通知：

• 一个描述符的名字“通用”和“JMX DisplayName。ModelMBean。通用”
• 二是一个标准的属性更改通知和描述符的名字“attribute_change“DisplayName”JMX。属性。”

从而实现ModelMBeanInfo应该除了那些由应用程序指定添加这两个通知。

结果

对 MBeanNotificationInfo对象数组。

getOperations

MBeanOperationInfo[] getOperations()

返回的MBean操作列表。每个操作由一个 MBeanOperationInfo对象描述。

结果

对 MBeanOperationInfo对象数组。