javax.management.monitor
類別 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 集的共同屬性值。將根據粒度週期指定的區間監視 observed 屬性。尺度值（派生尺度）從 observed 屬性的值中派生。

從以下版本開始：

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 監視器屬性。
protected static int	RUNTIME_ERROR_NOTIFIED 表示已在更改被觀察物件或被觀察屬性之後發出了通知的標誌。
protected MBeanServer	server 對 MBean 伺服器的參考。

建構子摘要

Monitor()

方法摘要

void	addObservedObject(ObjectName object) 如果尚未顯示此物件，則在觀察到的 MBean 集中添加指定的物件。
boolean	containsObservedObject(ObjectName object) 測試指定的物件是否在所觀察的 MBean 集中。
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 之前執行監視器 MBean 所需要的任何操作。
ObjectName	preRegister(MBeanServer server, ObjectName name) 允許在 MBean 伺服器中註冊監視器 MBean 之前執行任何監視器 MBean 所需要的操作。
void	removeObservedObject(ObjectName object) 從所觀察的 MBean 集中移除指定的物件。
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, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

從類別 java.lang.Object 繼承的方法

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

欄位詳細資訊

capacityIncrement

protected static final int capacityIncrement

監視器陣列的大小大於其容量時，容量自動遞增的量。

另請參見：

常數欄位值

elementCount

protected int elementCount

被觀察物件的向量中的有效元件數。

alreadyNotified

@Deprecated
protected int alreadyNotified

已過時。 等效於 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 監視器屬性。

另請參見：

常數欄位值

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

已過時。 無替代版本。

出於相容的目的，對此欄位進行了保留，但不建議參考它。

建構子詳細資訊

Monitor

public Monitor()

方法詳細資訊

preRegister

public ObjectName preRegister(MBeanServer server,
                              ObjectName name)
                       throws Exception

允許在 MBean 伺服器中註冊監視器 MBean 之前執行任何監視器 MBean 所需要的操作。

初始化對 MBean 伺服器的參考。

指定者：

介面 MBeanRegistration 中的 preRegister

參數：

server - 將在其中註冊監視器 MBean 的 MBean 伺服器。

name - 監視器 MBean 的物件名稱。

返回：

註冊的監視器 MBean 的名稱。

拋出：

Exception

postRegister

public void postRegister(Boolean registrationDone)

允許在 MBean 伺服器中註冊監視器 MBean 後或註冊失敗後執行所需的任何操作。

未在此上下文中使用。

指定者：

介面 MBeanRegistration 中的 postRegister

參數：

registrationDone - 指示該 MBean 是否已在 MBean 伺服器中成功註冊。false 值意味著註冊階段已失敗。

preDeregister

public void preDeregister()
                   throws Exception

允許在 MBean 伺服器註銷監視器 MBean 之前執行監視器 MBean 所需要的任何操作。

停止監視器。

指定者：

介面 MBeanRegistration 中的 preDeregister

拋出：

Exception

postDeregister

public void postDeregister()

允許在 MBean 伺服器註銷監視器 MBean 之前執行所需的任何操作。

未在此上下文中使用。

指定者：

介面 MBeanRegistration 中的 postDeregister

start

public abstract void start()

啟動監視器。

指定者：

介面 MonitorMBean 中的 start

stop

public abstract void stop()

停止監視器。

指定者：

介面 MonitorMBean 中的 stop

getObservedObject

@Deprecated
public ObjectName getObservedObject()

已過時。 從 JMX 1.2 開始，由 getObservedObjects() 取代

返回觀察到的 MBean 集中第一個物件的名稱，如果沒有此物件，則返回 null。

指定者：

介面 MonitorMBean 中的 getObservedObject

返回：

要觀察的物件。

另請參見：

setObservedObject(ObjectName)

setObservedObject

@Deprecated
public void setObservedObject(ObjectName object)
                       throws IllegalArgumentException

已過時。 從 JMX 1.2 開始，由 addObservedObject(javax.management.ObjectName) 取代

從 observed 物件集中移除所有的物件，然後添加指定的物件。

指定者：

介面 MonitorMBean 中的 setObservedObject

參數：

object - 要觀察的物件。

拋出：

IllegalArgumentException - 指定的物件為 null。

另請參見：

getObservedObject()

addObservedObject

public void addObservedObject(ObjectName object)
                       throws IllegalArgumentException

如果尚未顯示此物件，則在觀察到的 MBean 集中添加指定的物件。

指定者：

介面 MonitorMBean 中的 addObservedObject

參數：

object - 要觀察的物件。

拋出：

IllegalArgumentException - 指定的物件為 null。

removeObservedObject

public void removeObservedObject(ObjectName object)

從所觀察的 MBean 集中移除指定的物件。

指定者：

介面 MonitorMBean 中的 removeObservedObject

參數：

object - 要移除的物件。

containsObservedObject

public boolean containsObservedObject(ObjectName object)

測試指定的物件是否在所觀察的 MBean 集中。

指定者：

介面 MonitorMBean 中的 containsObservedObject

參數：

object - 要檢查的物件。

返回：

如果指定的物件存在，則返回 true；否則返回 false。

getObservedObjects

public ObjectName[] getObservedObjects()

返回一個套件含要觀察的物件的陣列。

指定者：

介面 MonitorMBean 中的 getObservedObjects

返回：

要觀察的物件。

getObservedAttribute

public String getObservedAttribute()

獲取要觀察的屬性。
預設情況下被觀察屬性未被初始化（設置為 null）。

指定者：

介面 MonitorMBean 中的 getObservedAttribute

返回：

要觀察的屬性。

另請參見：

setObservedAttribute(java.lang.String)

setObservedAttribute

public void setObservedAttribute(String attribute)
                          throws IllegalArgumentException

設置要觀察的屬性。
預設情況下被觀察屬性未被初始化（設置為 null）。

指定者：

介面 MonitorMBean 中的 setObservedAttribute

參數：

attribute - 要觀察的屬性。

拋出：

IllegalArgumentException - 指定的屬性為 null。

另請參見：

getObservedAttribute()

getGranularityPeriod

public long getGranularityPeriod()

獲取粒度週期（以毫秒為單位）。
粒度週期的預設值是 10 秒。

指定者：

介面 MonitorMBean 中的 getGranularityPeriod

返回：

粒度週期值。

另請參見：

setGranularityPeriod(long)

setGranularityPeriod

public void setGranularityPeriod(long period)
                          throws IllegalArgumentException

設置粒度週期（以毫秒為單位）。
粒度週期的預設值是 10 秒。

指定者：

介面 MonitorMBean 中的 setGranularityPeriod

參數：

period - 粒度週期值。

拋出：

IllegalArgumentException - 粒度週期小於或等於零。

另請參見：

getGranularityPeriod()

isActive

public boolean isActive()

測試監視器 MBean 是否處於啟動狀態。當調用 start 方法時，監視器 MBean 被標記為啟動。當調用 stop 方法時，該標記變為非啟動。

指定者：

介面 MonitorMBean 中的 isActive

返回：

如果監視器 MBean 處於啟動狀態，則返回 true；否則返回 false。