StandardMBean (Java Platform SE 6)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM Platform
Standard Ed. 6

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

javax.management
クラス StandardMBean

java.lang.Object
  javax.management.StandardMBean

すべての実装されたインタフェース:: DynamicMBean, MBeanRegistration

直系の既知のサブクラス:: StandardEmitterMBean

public class StandardMBean
extends Object
implements DynamicMBean, MBeanRegistration
extends Object
implements DynamicMBean, MBeanRegistration

Java インタフェースのリフレクションによって管理インタフェースを決定する MBean です。

このクラスは、Standard MBean の使用における管理インタフェースの概念の柔軟性を向上させます。JMX 仕様に説明されている Standard MBean のパターンの単純な使用方法には、MBean の実装クラスと管理インタフェース間に固定した関係があると説明されています (つまり、実装クラスが Thing の場合、管理インタフェースは ThingMBean でなければならない)。このクラスは、実装クラスとインタフェースクラス間の名前の関連性を必要とせず、Java インタフェースによる管理インタフェースの指定に役立ちます。

MBean から DynamicMBean を除外することにより、このクラスは、MBean が実装する任意のインタフェースを管理インタフェースとして選択できます。ただし、JMX パターンに準拠するインタフェースでなければなりません (取得メソッドまたは設定メソッドによって定義された属性など)。

このクラスは、DynamicMBean インタフェースから返される MBeanInfo にカスタムの記述と名前を割り当てることができるフックを提供します。

このクラスを使って、任意の実装クラス名 Impl と、任意のインタフェース Intf で定義された管理インタフェース (現在の Standard MBean 用) を指定して MBean を作成できます。一般に、次のいずれかの作成方法を選択します。

public コンストラクタ StandardMBean(impl,interface) を使用

     MBeanServer mbs;
     ...
     Impl impl = new Impl(...);
     StandardMBean mbean = new StandardMBean(impl, Intf.class, false);
     mbs.registerMBean(mbean, objectName);

StandardMBean のサブクラス化

     public class Impl extends StandardMBean implements Intf {
        public Impl() {
          super(Intf.class, false);
       }
       // implement methods of Intf
     }

     [...]

     MBeanServer mbs;
     ....
     Impl impl = new Impl();
     mbs.registerMBean(impl, objectName);

いずれの場合も、クラス Impl はインタフェース Intf を実装する必要があります。

実装クラスとインタフェースクラス間の名前の関連性に基づいた Standard MBean も、引き続き使用可能です。

このクラスは、MXBean の構築にも使用できます。使用法は、上の例のコンストラクタに渡される false パラメータまたは super(...) の呼び出しが代わりに true になることを除き、Standard MBean とまったく同じです。

導入されたバージョン:: 1.5

コンストラクタの概要
`protected`	`StandardMBean(Class<?> mbeanInterface)` 特定の `mbeanInterface` クラスを使って、DynamicMBean を `this` から除外します。
`protected`	`StandardMBean(Class<?> mbeanInterface, boolean isMXBean)` 特定の `mbeanInterface` クラスを使って、DynamicMBean を `this` から除外します。
	`StandardMBean(T implementation, Class<T> mbeanInterface)` 特定の `mbeanInterface` クラスを使って、DynamicMBean をオブジェクト `implementation` から除外します。
	`StandardMBean(T implementation, Class<T> mbeanInterface, boolean isMXBean)` 特定の `mbeanInterface` クラスを使って、DynamicMBean をオブジェクト `implementation` から除外します。

メソッドの概要
`protected void`	`cacheMBeanInfo(MBeanInfo info)` カスタマイズフック:このオブジェクト用に構築された MBeanInfo をキャッシュに入れます。
`Object`	`getAttribute(String attribute)` Dynamic MBean の特定の属性の値を取得します。
`AttributeList`	`getAttributes(String[] attributes)` Dynamic MBean の複数の属性の値を取得します。
`protected MBeanInfo`	`getCachedMBeanInfo()` カスタマイズフック:このオブジェクト用にキャッシュされた MBeanInfo を返します。
`protected String`	`getClassName(MBeanInfo info)` カスタマイズフック:この MBean から返される MBeanInfo 内で使用される className を取得します。
`protected MBeanConstructorInfo[]`	`getConstructors(MBeanConstructorInfo[] ctors, Object impl)` カスタマイズフック:この MBean から返される MBeanInfo で使用される MBeanConstructorInfo[] を取得します。
`protected String`	`getDescription(MBeanAttributeInfo info)` カスタマイズフック:この MBean が返す MBeanAttributeInfo 内で使用される説明を取得します。
`protected String`	`getDescription(MBeanConstructorInfo info)` カスタマイズフック:この MBean から返される MBeanConstructorInfo 内で使用される説明を取得します。
`protected String`	`getDescription(MBeanConstructorInfo ctor, MBeanParameterInfo param, int sequence)` カスタマイズフック:この MBean から返される MBeanConstructorInfo の `sequence` MBeanParameterInfo に使用される説明を取得します。
`protected String`	`getDescription(MBeanFeatureInfo info)` カスタマイズフック:この MBean が返す MBeanFeatureInfo 内で使用される説明を取得します。
`protected String`	`getDescription(MBeanInfo info)` カスタマイズフック:この MBean から返される MBeanInfo 内で使用される説明を取得します。
`protected String`	`getDescription(MBeanOperationInfo info)` カスタマイズフック:この MBean から返される MBeanOperationInfo 内で使用される説明を取得します。
`protected String`	`getDescription(MBeanOperationInfo op, MBeanParameterInfo param, int sequence)` カスタマイズフック:この MBean から返される MBeanOperationInfo の `sequence` MBeanParameterInfo に使用される説明を取得します。
`protected int`	`getImpact(MBeanOperationInfo info)` カスタマイズフック:この MBean から返される MBeanOperationInfo で使用されるオペレーションの `impact` フラグを取得します。
`Object`	`getImplementation()` この Standard MBean (または MXBean) の実装を取得します。
`Class<?>`	`getImplementationClass()` この Standard MBean (または MXBean) の実装のクラスを取得します。
`MBeanInfo`	`getMBeanInfo()` この MBean の `MBeanInfo` を取得します。
`Class<?>`	`getMBeanInterface()` この Standard MBean (または MXBean) の管理インタフェースを取得します。
`protected String`	`getParameterName(MBeanConstructorInfo ctor, MBeanParameterInfo param, int sequence)` カスタマイズフック:この MBean から返される MBeanConstructorInfo の `sequence` MBeanParameterInfo に使用される名前を取得します。
`protected String`	`getParameterName(MBeanOperationInfo op, MBeanParameterInfo param, int sequence)` カスタマイズフック:この MBean から返される MBeanOperationInfo の `sequence` MBeanParameterInfo に使用される名前を取得します。
`Object`	`invoke(String actionName, Object[] params, String[] signature)` Dynamic MBean 上でのアクションの実行を許可します。
`void`	`postDeregister()` MBean サーバーから登録解除したあと、MBean が必要なオペレーションを実行できるようにします。
`void`	`postRegister(Boolean registrationDone)` MBean サーバーへの登録が成功または失敗したあと、MBean が必要なオペレーションを実行できるようにします。
`void`	`preDeregister()` MBean サーバーから登録解除する前に、MBean が必要なオペレーションを実行できるようにします。
`ObjectName`	`preRegister(MBeanServer server, ObjectName name)` MBean サーバーに登録する前に、MBean に必要なオペレーションを実行させることができます。
`void`	`setAttribute(Attribute attribute)` Dynamic MBean の特定の属性の値を設定します。
`AttributeList`	`setAttributes(AttributeList attributes)` Dynamic MBean の複数の属性の値を設定します。
`void`	`setImplementation(Object implementation)` このオブジェクト内のラップされた実装オブジェクトを置換します。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

コンストラクタの詳細

StandardMBean

public StandardMBean(T implementation,
                     Class<T> mbeanInterface)
              throws NotCompliantMBeanException

特定の mbeanInterface クラスを使って、DynamicMBean をオブジェクト implementation から除外します。

型パラメータ:: T - mbeanInterface で記述されたクラスを implementation が実際に実装しているかチェックすることをコンパイラに許可する。コンパイラがこのチェックを実行できるのは、 mbeanInterface が MyMBean.class などのクラスリテラルである場合のみ
パラメータ:: implementation - この MBean の実装; mbeanInterface - この MBean の実装によってエクスポートされる管理インタフェース。null の場合、このオブジェクトは標準 JMX 設計パターンを使って、指定された実装に関連付けられた管理インタフェースを特定する
例外:: IllegalArgumentException - 指定された implementation が null の場合; NotCompliantMBeanException - mbeanInterface が管理インタフェースの JMX 設計パターンに従っていない場合、または指定された implementation が特定のインタフェースを実装していない場合

StandardMBean

protected StandardMBean(Class<?> mbeanInterface)
                 throws NotCompliantMBeanException

特定の mbeanInterface クラスを使って、DynamicMBean を this から除外します。

this(this,mbeanInterface) を呼び出します。このコンストラクタはサブクラス用として予約されています。

パラメータ:: mbeanInterface - この MBean によってエクスポートされる管理インタフェース
例外:: NotCompliantMBeanException - mbeanInterface が管理インタフェースの JMX 設計パターンに従っていない場合、または this が特定のインタフェースを実装していない場合

StandardMBean

public StandardMBean(T implementation,
                     Class<T> mbeanInterface,
                     boolean isMXBean)

特定の mbeanInterface クラスを使って、DynamicMBean をオブジェクト implementation から除外します。このコンストラクタは、Standard MBean または MXBean の作成に使用できます。StandardMBean(Object, Class) コンストラクタとは異なり、これは NotCompliantMBeanException をスローしません。

型パラメータ:: T - mbeanInterface で記述されたクラスを implementation が実際に実装しているかチェックすることをコンパイラに許可する。コンパイラがこのチェックを実行できるのは、 mbeanInterface が MyMBean.class などのクラスリテラルである場合のみ
パラメータ:: implementation - この MBean の実装; mbeanInterface - この MBean の実装によってエクスポートされる管理インタフェース。null の場合、このオブジェクトは標準 JMX 設計パターンを使って、指定された実装に関連付けられた管理インタフェースを特定する; isMXBean - true の場合、mbeanInterface パラメータにより MXBean インタフェースが命名され、生成される MBean は MXBean になる
例外:: IllegalArgumentException - 指定された implementation が null の場合、mbeanInterface が管理インタフェースの JMX 設計パターンに従っていない場合、または指定された implementation が特定のインタフェースを実装していない場合
導入されたバージョン:: 1.6

StandardMBean

protected StandardMBean(Class<?> mbeanInterface,
                        boolean isMXBean)

特定の mbeanInterface クラスを使って、DynamicMBean を this から除外します。このコンストラクタは、Standard MBean または MXBean の作成に使用できます。StandardMBean(Object, Class) コンストラクタとは異なり、これは NotCompliantMBeanException をスローしません。

this(this, mbeanInterface, isMXBean) を呼び出します。このコンストラクタはサブクラス用として予約されています。

パラメータ:: mbeanInterface - この MBean によってエクスポートされる管理インタフェース; isMXBean - true の場合、mbeanInterface パラメータにより MXBean インタフェースが命名され、生成される MBean は MXBean になる
例外:: IllegalArgumentException - mbeanInterface が管理インタフェースの JMX 設計パターンに従っていない場合、または this が特定のインタフェースを実装していない場合
導入されたバージョン:: 1.6

メソッドの詳細

setImplementation

public void setImplementation(Object implementation)
                       throws NotCompliantMBeanException

このオブジェクト内のラップされた実装オブジェクトを置換します。

パラメータ:: implementation - この Standard MBean (または MXBean) の新しい実装。implementation オブジェクトは、 StandardMBean の構築時に提供された Standard MBean (または MXBean) インタフェースを実装する必要がある
例外:: IllegalArgumentException - 指定された implementation が null の場合; NotCompliantMBeanException - 指定された implementation が構築時に提供された Standard MBean (または MXBean) インタフェースを実装していない場合
関連項目:: getImplementation()

getImplementation

public Object getImplementation()

この Standard MBean (または MXBean) の実装を取得します。

戻り値:: この Standard MBean (または MXBean) の実装
関連項目:: setImplementation(java.lang.Object)

getMBeanInterface

public final Class<?> getMBeanInterface()

この Standard MBean (または MXBean) の管理インタフェースを取得します。

戻り値:: この Standard MBean (または MXBean) の管理インタフェース

getImplementationClass

public Class<?> getImplementationClass()

この Standard MBean (または MXBean) の実装のクラスを取得します。

戻り値:: この Standard MBean (または MXBean) の実装のクラス