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 のセットに共通の属性の値を監視します。監視対象の属性は、粒度周期として指定された間隔で監視されます。ゲージ値 (派生ゲージ) は、監視対象の属性の値から派生します。

導入されたバージョン:

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 が必要なオペレーションを実行できるようにします。
ObjectName	preRegister(MBeanServer server, ObjectName name) 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 サーバの参照を初期化します。

定義:

インタフェース MBeanRegistration 内の preRegister

パラメータ:

server - MBean サーバ。モニター MBean はこの MBean サーバに登録される

name - モニター MBean のオブジェクト名

戻り値:

登録済み モニター MBean の名前

例外:

Exception -

postRegister

public void postRegister(Boolean registrationDone)

MBean サーバへの登録が成功または失敗したあと、モニター MBean が必要なオペレーションを実行できるようにします。

this コンテキストでは使用しません。

定義:

インタフェース MBeanRegistration 内の postRegister

パラメータ:

registrationDone - MBean が MBean サーバに正常に登録されたかどうかを示す。登録に失敗した場合の値は false

preDeregister

public void preDeregister()
                   throws Exception

MBean サーバから登録解除する前に、モニター MBean が必要なオペレーションを実行できるようにします。

モニターを停止します。

定義:

インタフェース MBeanRegistration 内の preDeregister

例外:

Exception -

postDeregister

public void postDeregister()

MBean サーバから登録解除したあと、モニター MBean が必要なオペレーションを実行できるようにします。

this コンテキストでは使用しません。

定義:

インタフェース 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) で置換されています。

監視対象のオブジェクトのセットからすべてのオブジェクトを削除し、指定されたオブジェクトを追加します。

定義:

インタフェース 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 がアクティブかどうかをテストします。モニター MBean は、start メソッドが呼び出されるとアクティブになり、stop メソッドが呼び出されると非アクティブになります。

定義:

インタフェース MonitorMBean 内の isActive

戻り値:

モニター MBean がアクティブな場合は true、そうでない場合は false