模块 java.management

软件包 javax.management.monitor

Class Monitor

java.lang.Object

javax.management.NotificationBroadcasterSupport

javax.management.monitor.Monitor

实现的所有接口

MBeanRegistration ， MonitorMBean ， NotificationBroadcaster ， NotificationEmitter

已知直接子类：

CounterMonitor ， GaugeMonitor ， StringMonitor

public abstract class Monitor
extends NotificationBroadcasterSupport
implements MonitorMBean, MBeanRegistration

定义所有监视器MBean共有的部分。 监视器MBean监视一组观察到的MBean共有的属性值。 以粒度周期指定的间隔监视观察到的属性。 标尺值（导出的标尺）是从观察到的属性的值导出的。

从以下版本开始：

1.5

字段汇总

字段

变量和类型	字段	描述
protected int	alreadyNotified	已过时。 相当于alreadyNotifieds [0]。
protected int[]	alreadyNotifieds	已通知的选定监视器错误。
protected static int	capacityIncrement	监视器阵列的容量在其大小超过其容量时自动递增的量。
protected String	dbgTag	已过时。 没有替代品。
protected int	elementCount	观察对象向量中的有效组件数。
protected static int	OBSERVED_ATTRIBUTE_ERROR_NOTIFIED	表示在更改观察到的属性后发生通知的标志。
protected static int	OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED	表示在更改观察对象或观察到的属性后发生通知的标志。
protected static int	OBSERVED_OBJECT_ERROR_NOTIFIED	表示在更改观察对象后发生通知的标志。
protected static int	RESET_FLAGS_ALREADY_NOTIFIED	此标志用于重置 alreadyNotifieds monitor属性。
protected static int	RUNTIME_ERROR_NOTIFIED	表示在更改观察对象或观察到的属性后发生通知的标志。
protected MBeanServer	server	引用MBean服务器。

构造方法摘要

构造方法

构造器	描述
Monitor()

方法摘要

变量和类型	方法	描述
void	addObservedObject(ObjectName object)	如果此对象尚不存在，则在观察到的MBeans集中添加指定的对象。
boolean	containsObservedObject(ObjectName object)	测试指定的对象是否在观察到的MBeans集合中。
long	getGranularityPeriod()	获取粒度周期（以毫秒为单位）。
String	getObservedAttribute()	获取正在观察的属性。
ObjectName	getObservedObject()	已过时。 截至JMX 1.2，由getObservedObjects()取代
ObjectName[]	getObservedObjects()	返回包含被观察对象的数组。
boolean	isActive()	测试监视器MBean是否处于活动状态。
void	postDeregister()	允许监视器MBean在MBean服务器取消注册后执行所需的任何操作。
void	postRegister(Boolean registrationDone)	允许监视器MBean在MBean服务器中注册后或注册失败后执行所需的任何操作。
void	preDeregister()	允许监视器MBean在MBean服务器取消注册之前执行所需的任何操作。
ObjectName	preRegister(MBeanServer server, ObjectName name)	允许监视器MBean在MBean服务器中注册之前执行所需的任何操作。
void	removeObservedObject(ObjectName object)	从观察到的MBeans集中删除指定的对象。
void	setGranularityPeriod(long period)	设置粒度周期（以毫秒为单位）。
void	setObservedAttribute(String attribute)	设置要观察的属性。
void	setObservedObject(ObjectName object)	已过时。 截至JMX 1.2，由addObservedObject(javax.management.ObjectName)取代
abstract void	start()	启动显示器。
abstract void	stop()	停止显示器。

声明方法的类 javax.management.NotificationBroadcasterSupport

addNotificationListener, handleNotification, sendNotification

声明方法的类 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

声明方法的接口 javax.management.NotificationBroadcaster

getNotificationInfo, removeNotificationListener

声明方法的接口 javax.management.NotificationEmitter

removeNotificationListener

字段详细信息

capacityIncrement

protected static final int capacityIncrement

监视器阵列的容量在其大小超过其容量时自动递增的量。

另请参见：

常数字段值

elementCount

protected int elementCount

观察对象向量中的有效组件数。

alreadyNotified

@Deprecated
protected int alreadyNotified

Deprecated.

equivalent to alreadyNotifieds[0].

监控已通知的错误。

alreadyNotifieds

protected int[] alreadyNotifieds

已通知的选定监视器错误。

此数组中的每个元素对应于向量中的观察对象。 它包含标志OBSERVED_OBJECT_ERROR_NOTIFIED等的位掩码，指示是否已经为正在监视的MBean发送了相应的通知。

server

protected MBeanServer server

引用MBean服务器。 当监视器MBean未在MBean服务器中注册时，此引用为null。 在MBean服务器中注册监视器MBean之前，将初始化此引用。

另请参见：

preRegister(MBeanServer server, ObjectName name)

RESET_FLAGS_ALREADY_NOTIFIED

protected static final int RESET_FLAGS_ALREADY_NOTIFIED

此标志用于重置 alreadyNotifieds monitor属性。

另请参见：

常数字段值

OBSERVED_OBJECT_ERROR_NOTIFIED

protected static final int OBSERVED_OBJECT_ERROR_NOTIFIED

表示在更改观察对象后发生通知的标志。 此标志用于检查在第一次通知时新观察对象是否已在MBean服务器中注册。

另请参见：

常数字段值

OBSERVED_ATTRIBUTE_ERROR_NOTIFIED

protected static final int OBSERVED_ATTRIBUTE_ERROR_NOTIFIED

表示在更改观察到的属性后发生通知的标志。 此标志用于在第一次通知时检查新观察到的属性是否属于观察对象。

另请参见：

常数字段值

OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED

protected static final int OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED

表示在更改观察对象或观察到的属性后发生通知的标志。 此标志用于在第一次通知时检查观察到的属性类型是否正确（取决于使用中的监视器）。

另请参见：

常数字段值

RUNTIME_ERROR_NOTIFIED

protected static final int RUNTIME_ERROR_NOTIFIED

表示在更改观察对象或观察到的属性后发生通知的标志。 当尝试在第一次通知时获取被观察属性的值时，该标志用于通知任何异常（上述情况除外）。

另请参见：

常数字段值

dbgTag

@Deprecated
protected String dbgTag

Deprecated.

No replacement.

保留此字段是为了兼容性，但不应引用。

构造方法详细信息

Monitor

public Monitor()

方法详细信息

preRegister

public ObjectName preRegister(MBeanServer server,
                              ObjectName name)
                       throws 异常

允许监视器MBean在MBean服务器中注册之前执行所需的任何操作。

初始化对MBean服务器的引用。

Specified by:

preRegister ，接口 MBeanRegistration

参数

server - 将在其中注册监视器MBean的MBean服务器。

name - 监视器MBean的对象名称。

结果

监视器MBean的名称已注册。

异常

异常 - 如果出现问题

postRegister

public void postRegister(Boolean registrationDone)

允许监视器MBean在MBean服务器中注册后或注册失败后执行所需的任何操作。

在此上下文中未使用。

Specified by:

postRegister在接口 MBeanRegistration

参数

registrationDone - 指示MBean是否已在MBean服务器中成功注册。 值false表示注册阶段已失败。

preDeregister

public void preDeregister()
                   throws 异常

允许监视器MBean在MBean服务器取消注册之前执行所需的任何操作。

停止显示器。

Specified by:

preDeregister接口 MBeanRegistration

异常

异常 - 如果出现问题

postDeregister

public void postDeregister()

允许监视器MBean在MBean服务器取消注册后执行所需的任何操作。

在此上下文中未使用。

Specified by:

postDeregister接口 MBeanRegistration

start

public abstract void start()

启动显示器。

Specified by:

start接口 MonitorMBean

stop

public abstract void stop()

停止显示器。

Specified by:

stop ，接口 MonitorMBean

getObservedObject

@Deprecated
public ObjectName getObservedObject()

Deprecated.

As of JMX 1.2, replaced by getObservedObjects()

返回观察到的MBeans集中第一个对象的对象名，如果没有此类对象，则 null 。

Specified by:

getObservedObject接口 MonitorMBean

结果

正在观察的对象。

另请参见：

setObservedObject(ObjectName)

setObservedObject

@Deprecated
public void setObservedObject(ObjectName object)
                       throws IllegalArgumentException

Deprecated.

As of JMX 1.2, replaced by addObservedObject(javax.management.ObjectName)

从观察对象集中删除所有对象，然后添加指定的对象。

Specified by:

setObservedObject接口 MonitorMBean

参数

object - 要观察的对象。

异常

IllegalArgumentException - 指定的对象为null。

另请参见：

getObservedObject()

addObservedObject

public void addObservedObject(ObjectName object)
                       throws IllegalArgumentException

如果此对象尚不存在，则在观察到的MBeans集中添加指定的对象。

Specified by:

addObservedObject接口 MonitorMBean

参数

object - 要观察的对象。

异常

IllegalArgumentException - 指定的对象为null。

removeObservedObject

public void removeObservedObject(ObjectName object)

从观察到的MBeans集中删除指定的对象。

Specified by:

removeObservedObject在接口 MonitorMBean

参数

object - 要删除的对象。

containsObservedObject

public boolean containsObservedObject(ObjectName object)

测试指定的对象是否在观察到的MBeans集合中。

Specified by:

containsObservedObject接口 MonitorMBean

参数

object - 要检查的对象。

结果

true如果指定的对象存在，否则为 false 。

getObservedObjects

public ObjectName[] getObservedObjects()

返回包含被观察对象的数组。

Specified by:

getObservedObjects接口 MonitorMBean

结果

被观察的物体。

getObservedAttribute

public String getObservedAttribute()

获取正在观察的属性。
默认情况下，observe属性未初始化（设置为null）。

Specified by:

getObservedAttribute接口 MonitorMBean

结果

正在观察的属性。

另请参见：

setObservedAttribute(java.lang.String)

setObservedAttribute

public void setObservedAttribute(String attribute)
                          throws IllegalArgumentException

设置要观察的属性。
默认情况下，observe属性未初始化（设置为null）。

Specified by:

setObservedAttribute接口 MonitorMBean

参数

attribute - 要观察的属性。

异常

IllegalArgumentException - 指定的属性为null。

另请参见：

getObservedAttribute()

getGranularityPeriod

public long getGranularityPeriod()

获取粒度周期（以毫秒为单位）。
粒度周期的默认值为10秒。

Specified by:

getGranularityPeriod接口 MonitorMBean

结果

粒度周期值。

另请参见：

setGranularityPeriod(long)

setGranularityPeriod

public void setGranularityPeriod(long period)
                          throws IllegalArgumentException

设置粒度周期（以毫秒为单位）。
粒度周期的默认值为10秒。

Specified by:

setGranularityPeriod接口 MonitorMBean

参数

period - 粒度周期值。

异常

IllegalArgumentException - 粒度周期小于或等于零。

另请参见：

getGranularityPeriod()

isActive

public boolean isActive()

测试监视器MBean是否处于活动状态。 调用start方法时，监视器MBean标记为活动状态。 调用stop方法时，它将变为非活动状态。

Specified by:

isActive接口 MonitorMBean

结果

true如果监视器MBean处于活动状态， false 。