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, handleNotification, sendNotification
クラス java.lang.Objectで宣言されたメソッド
clone、equals、finalize、getClass、hashCode、notify、notifyAll、toString、wait、wait、wait
インタフェース javax.management.NotificationBroadcasterで宣言されたメソッド
getNotificationInfo, removeNotificationListener
-
フィールド詳細
-
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 serverMBeanサーバーへの参照です。 この参照は、モニターMBeanがMBeanサーバーに登録されていない場合nullになります。 モニターMBeanがMBeanに登録される前に初期化されます。 -
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 ExceptionMBeanサーバーに登録する前に必要なオペレーションをモニターMBeanが実行することを許可します。MBeanサーバーの参照を初期化します。
- 定義:
preRegister
、インタフェース:MBeanRegistration
- パラメータ:
server
- MBeanサーバー。モニターMBeanはこのMBeanサーバーに登録される。name
- モニターMBeanのオブジェクト名。- 戻り値:
- 登録済みモニターMBeanの名前。
- 例外:
Exception
- 何かがうまくいかない場合
-
postRegister
public void postRegister(Boolean registrationDone)MBeanサーバーへの登録が成功または失敗したあと、モニターMBeanが必要なオペレーションを実行できるようにします。このコンテキストでは使用しません。
- 定義:
postRegister
、インタフェース:MBeanRegistration
- パラメータ:
registrationDone
- MBeanがMBeanサーバーに正常に登録されたかどうかを示す。 登録に失敗した場合の値はfalse。
-
preDeregister
public void preDeregister() throws ExceptionMBeanサーバーから登録解除する前に、モニターMBeanが必要なオペレーションを実行できるようにします。モニターを停止します。
- 定義:
preDeregister
、インタフェース:MBeanRegistration
- 例外:
Exception
- 何かがうまくいかない場合
-
postDeregister
public void postDeregister()MBeanサーバーから登録解除したあと、モニターMBeanが必要なオペレーションを実行できるようにします。このコンテキストでは使用しません。
- 定義:
postDeregister
、インタフェース:MBeanRegistration
-
start
public abstract void start()モニターを開始します。- 定義:
start
、インタフェース:MonitorMBean
-
stop
public abstract void stop()モニターを停止します。- 定義:
stop
、インタフェース:MonitorMBean
-
getObservedObject
@Deprecated public ObjectName getObservedObject()非推奨。JMX 1.2以降は、getObservedObjects()
に置き換えられています。監視対象のMBeanのセット内の最初のオブジェクトのオブジェクト名を返します。該当するオブジェクトが存在しない場合、null
を返します。- 定義:
getObservedObject
、インタフェース:MonitorMBean
- 戻り値:
- 監視対象のオブジェクト。
- 関連項目:
setObservedObject(ObjectName)
-
setObservedObject
@Deprecatedpublic void setObservedObject(ObjectName object) throws IllegalArgumentException非推奨。JMX 1.2以降は、addObservedObject(javax.management.ObjectName)
に置き換えられています。監視対象のオブジェクトのセットからすべてのオブジェクトを削除し、指定されたオブジェクトを追加します。- 定義:
setObservedObject
、インタフェース:MonitorMBean
- パラメータ:
object
- 監視対象のオブジェクト。- 例外:
IllegalArgumentException
- 指定されたオブジェクトがnullの場合。- 関連項目:
getObservedObject()
-
addObservedObject
public void addObservedObject(ObjectName object) throws IllegalArgumentException監視対象のMBeanのセットに指定されたオブジェクトが含まれない場合、そのオブジェクトを追加します。- 定義:
addObservedObject
、インタフェース:MonitorMBean
- パラメータ:
object
- 監視対象のオブジェクト。- 例外:
IllegalArgumentException
- 指定されたオブジェクトがnullの場合。
-
removeObservedObject
public void removeObservedObject(ObjectName object)監視対象のMBeanのセットから指定されたオブジェクトを削除します。- 定義:
removeObservedObject
、インタフェース:MonitorMBean
- パラメータ:
object
- 削除するオブジェクト。
-
containsObservedObject
public boolean containsObservedObject(ObjectName object)監視対象のMBeanのセット内に指定されたオブジェクトが含まれるかどうかをテストします。- 定義:
containsObservedObject
、インタフェース:MonitorMBean
- パラメータ:
object
- チェック対象のオブジェクト。- 戻り値:
- 指定された要素が存在する場合は
true
、そうでない場合はfalse
。
-
getObservedObjects
public ObjectName[] getObservedObjects()監視対象のオブジェクトを含む配列を返します。- 定義:
getObservedObjects
、インタフェース:MonitorMBean
- 戻り値:
- 監視対象のオブジェクト。
-
getObservedAttribute
public String getObservedAttribute()監視対象の属性を取得します。
監視対象の属性は、デフォルトでは初期化されません(nullに設定される)。- 定義:
getObservedAttribute
、インタフェース:MonitorMBean
- 戻り値:
- 監視対象の属性。
- 関連項目:
setObservedAttribute(java.lang.String)
-
setObservedAttribute
public void setObservedAttribute(String attribute) throws IllegalArgumentException監視対象の属性を設定します。
監視対象の属性は、デフォルトでは初期化されません(nullに設定される)。- 定義:
setObservedAttribute
、インタフェース:MonitorMBean
- パラメータ:
attribute
- 監視対象の属性。- 例外:
IllegalArgumentException
- 指定された属性がnullの場合。- 関連項目:
getObservedAttribute()
-
getGranularityPeriod
public long getGranularityPeriod()粒度周期(ミリ秒単位)を取得します。
デフォルトの粒度周期の値は10秒です。- 定義:
getGranularityPeriod
、インタフェース:MonitorMBean
- 戻り値:
- 粒度周期の値。
- 関連項目:
setGranularityPeriod(long)
-
setGranularityPeriod
public void setGranularityPeriod(long period) throws IllegalArgumentException粒度周期をミリ秒単位で設定します。
デフォルトの粒度周期の値は10秒です。- 定義:
setGranularityPeriod
、インタフェース:MonitorMBean
- パラメータ:
period
- 粒度周期の値。- 例外:
IllegalArgumentException
- 粒度周期がゼロ以下の場合。- 関連項目:
getGranularityPeriod()
-
isActive
public boolean isActive()- 定義:
isActive
、インタフェース:MonitorMBean
- 戻り値:
- モニターMBeanがアクティブな場合は
true
、そうでない場合はfalse
。
-