compact3

javax.management.monitor

インタフェースMonitorMBean

既知のすべてのサブインタフェース:

CounterMonitorMBean, GaugeMonitorMBean, StringMonitorMBean

既知のすべての実装クラス:

CounterMonitor, GaugeMonitor, Monitor, StringMonitor

public interface MonitorMBean

モニターMBeanのリモート管理インタフェースを公開します。

導入されたバージョン:

1.5

メソッドのサマリー

修飾子と型	メソッドと説明
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	removeObservedObject(ObjectName object) 監視対象のMBeanのセットから指定されたオブジェクトを削除します。
void	setGranularityPeriod(long period) 粒度周期をミリ秒単位で設定します。
void	setObservedAttribute(String attribute) 監視対象の属性を設定します。
void	setObservedObject(ObjectName object) 非推奨。 JMX 1.2以降は、addObservedObject(javax.management.ObjectName)に置き換えられています。
void	start() モニターを開始します。
void	stop() モニターを停止します。

メソッドの詳細

start

void start()

モニターを開始します。

stop

void stop()

モニターを停止します。

addObservedObject

void addObservedObject(ObjectName object)
                throws IllegalArgumentException

監視対象のMBeanのセットに指定されたオブジェクトを追加します。

パラメータ:

object - 監視対象のオブジェクト。

例外:

IllegalArgumentException - 指定されたオブジェクトがnullの場合。

removeObservedObject

void removeObservedObject(ObjectName object)

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

パラメータ:

object - 削除するオブジェクト。

containsObservedObject

boolean containsObservedObject(ObjectName object)

監視対象のMBeanのセット内に指定されたオブジェクトが含まれるかどうかをテストします。

パラメータ:

object - チェック対象のオブジェクト。

戻り値:

指定された要素がセット内に存在する場合はtrue、そうでない場合はfalse。

getObservedObjects

ObjectName[] getObservedObjects()

監視対象のオブジェクトを含む配列を返します。

戻り値:

監視対象のオブジェクト。

getObservedObject

@Deprecated
ObjectName getObservedObject()

非推奨。JMX 1.2以降は、getObservedObjects()に置き換えられています。

監視対象のオブジェクトのオブジェクト名を取得します。

戻り値:

監視対象のオブジェクト。

関連項目:

setObservedObject(javax.management.ObjectName)

setObservedObject

@Deprecated
void setObservedObject(ObjectName object)

非推奨。JMX 1.2以降は、addObservedObject(javax.management.ObjectName)に置き換えられています。

オブジェクト名で識別される監視対象のオブジェクトを設定します。

パラメータ:

object - 監視対象のオブジェクト。

関連項目:

getObservedObject()

getObservedAttribute

String getObservedAttribute()

監視対象の属性を取得します。

戻り値:

監視対象の属性。

関連項目:

setObservedAttribute(java.lang.String)

setObservedAttribute

void setObservedAttribute(String attribute)

監視対象の属性を設定します。

パラメータ:

attribute - 監視対象の属性。

関連項目:

getObservedAttribute()

getGranularityPeriod

long getGranularityPeriod()

粒度周期(ミリ秒単位)を取得します。

戻り値:

粒度周期。

関連項目:

setGranularityPeriod(long)

setGranularityPeriod

void setGranularityPeriod(long period)
                   throws IllegalArgumentException

粒度周期をミリ秒単位で設定します。

パラメータ:

period - 粒度周期。

例外:

IllegalArgumentException - 粒度周期がゼロ以下の場合。

関連項目:

getGranularityPeriod()

isActive

boolean isActive()

モニターMBeanがアクティブかどうかをテストします。モニターMBeanは、startメソッドが呼び出されるとアクティブになります。stopメソッドが呼び出されると非アクティブになります。

戻り値:

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