HelloMBeanという基本的なMBeanインタフェースの例を、次のコード例に示します。

 
package com.example.mbeans; 
 
public interface HelloMBean { 
 
    public void sayHello(); 
    public int add(int x, int y); 
 
    public String getName(); 
 
    public int getCacheSize(); 
    public void setCacheSize(int size); 
} 
 

次のコード例に示すHelloクラスは、HelloMBeanを実装します。

 
package com.example.mbeans; 
 
public class Hello implements HelloMBean { 
    public void sayHello() { 
        System.out.println("hello, world"); 
    } 
 
    public int add(int x, int y) { 
        return x + y; 
    } 
 
    public String getName() { 
        return this.name; 
    } 
 
 
    public int getCacheSize() { 
        return this.cacheSize; 
    } 
 
    public synchronized void setCacheSize(int size) { 
        this.cacheSize = size; 
 
        System.out.println("Cache size now " + this.cacheSize); 
    } 
 
    private final String name = "Reginald"; 
    private int cacheSize = DEFAULT_CACHE_SIZE; 
    private static final int DEFAULT_CACHE_SIZE = 200; 
} 
 

Java Management Extensions Technology User's Guideに説明されているように、MBeanによってリソースが計測された後は、そのリソースの管理はJMXエージェントにより実行されます。

JMXエージェントのコア・コンポーネントはMBeanサーバーです。MBeanサーバーは、MBeanが登録されている管理オブジェクト・サーバーのことです。MBeanサーバー実装の詳細は、MBeanServerインタフェースのAPIドキュメントを参照してください。JMXエージェントには、MBeanを管理するための一連のサービスも含まれます。次のコード例は、Mainという名前の基本JMXエージェントを示しています。

 
package com.example.mbeans; 
 
import java.lang.management.*; 
import javax.management.*; 
 
public class Main { 
 
   public static void main(String[] args) throws Exception { 
 
      MBeanServer mbs = ManagementFactory.getPlatformMBeanServer(); 
 
      ObjectName name = new ObjectName("com.example.mbeans:type=Hello"); 
 
      Hello mbean = new Hello(); 
 
      mbs.registerMBean(mbean, name); 
 
      System.out.println("Waiting forever..."); 
      Thread.sleep(Long.MAX_VALUE); 
   } 
} 
 

例題のクラスを検証した後、例題を実行できます。Java Platform, Standard EditionにはJConsoleという管理およびモニタリング・コンソールが含まれており、この例ではMBeanとの対話に使用されています。JConsoleはJavaSE_HOME/bin/jconsoleにあります。JavaSE_HOMEはJava Platform, Standard Edition (Java SEプラットフォーム)がインストールされたディレクトリです。

例題を実行するには:

1. 「JMXの基本要素」の項に含まれているソース・コードをコピーし、対応するファイルをwork_dir/jmx_examples/Essentialディレクトリに作成します。

2. Javaクラスの例をコンパイルします。

   $ javac com/example/mbeans/*.java

3. Mainアプリケーションを起動します。

   $ java com.example.mbeans.Main

   何かの発生を待機中のMainに関する確認が表示されます。

4. 同じマシンの別の端末ウィンドウで、JConsoleを起動します。

   $ jconsole

   JConsoleツールが開き、接続可能な稼動中のJMXエージェントのリストが表示されます。

5. 「新規接続」ウィンドウのリストからcom.example.mbeans.Mainを選択し、「接続」をクリックします。

   プラットフォームの現在のアクティビティのサマリーが表示されます。

6. 「MBean」タブをクリックします。

   このパネルに、現在MBeanサーバーに登録されているすべてのMBeanが表示されます。

7. 左フレームにあるMBeanツリーのcom.example.mbeansノードを展開します。

   Mainで作成され、登録されたMBean Helloの例が表示されます。Helloをクリックすると、関連するAttributesおよびOperationsノードがMBeanツリーに表示されます。

8. MBeanツリー内のHello MBeanノードをクリックしてHello MBeanのメタデータとそれに関連する記述子を表示します。
9. MBeanツリーにあるHello MBeanのAttributesノードをクリックします。

   Helloクラスで定義されたMBean属性が表示されます。

10. CacheSize属性の値を150に変更します。

    Mainを起動した端末ウィンドウで、この属性の変更を確認が表示されます。

11. MBeanツリーにあるHello MBeanのOperationsノードをクリックします。

    ここで、Hello MBeanで宣言された2つの操作、sayHello()とadd()が表示されます。

12. 「sayHello」ボタンをクリックして、sayHello()操作を起動します。

    メソッドが正常に呼び出されたことがJConsoleのダイアログ・ボックスに通知され、Mainが起動している端末のウィンドウに「hello, world」というメッセージが表示されます。

13. add()操作で加算する2つの整数を指定し、「add」ボタンをクリックします。

    「JConsole」ダイアログ・ボックスに解答が通知されます。

14. 「接続」をクリックし、次に「終了」をクリックして、JConsoleを終了します。

前述のように、この例題と標準MBeanで示した例題の唯一の違いは、MBeanの実装により通知の送信ができるという点です。次のコード例に示すように、通知はNotificationBroadcasterインタフェースを実装することで起動します。

 
package com.example.mbeans; 
 
import javax.management.*; 
 
public class Hello 
        extends NotificationBroadcasterSupport implements HelloMBean { 
 
    public void sayHello() { 
        System.out.println("hello, world"); 
    } 
 
    public int add(int x, int y) { 
        return x + y; 
    } 
 
    public String getName() { 
        return this.name; 
    } 
 
    public int getCacheSize() { 
        return this.cacheSize; 
    } 
 
    public synchronized void setCacheSize(int size) { 
        int oldSize = this.cacheSize; 
        this.cacheSize = size; 
 
        System.out.println("Cache size now " + this.cacheSize); 
 
        Notification n = 
            new AttributeChangeNotification(this, 
                                            sequenceNumber++, 
                                            System.currentTimeMillis(), 
                                            "CacheSize changed", 
                                            "CacheSize", 
                                            "int", 
                                            oldSize, 
                                            this.cacheSize); 
 
        sendNotification(n); 
    } 
 
    @Override 
    public MBeanNotificationInfo[] getNotificationInfo() { 
        String[] types = new String[] { 
            AttributeChangeNotification.ATTRIBUTE_CHANGE 
        }; 
        String name = AttributeChangeNotification.class.getName(); 
        String description = "An attribute of this MBean has changed"; 
        MBeanNotificationInfo info = 
            new MBeanNotificationInfo(types, name, description); 
        return new MBeanNotificationInfo[] {info}; 
    } 
 
    private final String name = "Reginald"; 
    private int cacheSize = DEFAULT_CACHE_SIZE; 
    private static final int DEFAULT_CACHE_SIZE = 200; 
 
    private long sequenceNumber = 1; 
} 
 

クラスの例題を検証したあと、今度は例題を実行します。この例では、JConsoleを使用してHello MBeanと対話します。この例題を実行するには:

1. 「JMX MBeanの通知」の項に含まれるソース・コード例をwork_dir/jmx_examples/Notificationにコピーします。

2. Javaクラスの例をコンパイルします。

   $ javac com/example/mbeans/*.java

3. Mainアプリケーションを起動します。

   $ java com.example.mbeans.Main

   何かの発生を待機中のMainに関する確認が表示されます。

4. 同じマシンの別の端末ウィンドウで、JConsoleを起動します。

   $ jconsole

   JConsoleツールが開き、接続可能な稼動中のJMXエージェントのリストが表示されます。

5. 「新規接続」ウィンドウのリストからcom.example.mbeans.Mainを選択し、「接続」をクリックします。

   プラットフォームの現在のアクティビティのサマリーが表示されます。

6. 「MBean」タブをクリックします。

   このパネルに、現在MBeanサーバーに登録されているすべてのMBeanが表示されます。

7. 左フレームにあるMBeanツリーのcom.example.mbeansノードを展開します。

   Mainで作成され、登録されたMBean Helloの例が表示されます。Helloをクリックすると、関連するAttributes、Operations、およびNotificationsノードがMBeanツリーに表示されます。

8. MBeanツリーにあるHello MBeanノードをクリックします。

   これによって、MBeanのメタデータと関連する記述子が表示されます。

9. MBeanツリーにあるHello MBeanのNotificationsノードをクリックします。

   空のパネルが表示されます。

10. 「Subscribe」ボタンをクリックします。

    現在の受領通知数(0)が、Notificationsノード・ラベルに表示されます。

11. MBeanツリーにあるHello MBeanのAttributesノードをクリックし、CacheSize属性を150に変更します。

    Mainを起動した端末ウィンドウで、この属性の変更を確認が表示されます。また、Notificationsノードに表示される受領通知数が1に変更されています。

12. MBeanツリーにあるHello MBeanのNotificationsノードをふたたびクリックします。

    送信された通知の詳細が表示されます。

13. 「接続」をクリックし、次に「終了」をクリックして、JConsoleを終了します。

次のコード例に、サンプルのQueueSamplerMXBeanインタフェースのソース・コードを示します。

 
package com.example.mxbeans; 
 
public interface QueueSamplerMXBean { 
    public QueueSample getQueueSample(); 
    public void clearQueue(); 
} 
 

QueueSamplerクラスは、次のコード例に示すように、QueueSamplerMXBeanインタフェースを実装しています。

package com.example.mxbeans; 
 
import java.util.Date; 
import java.util.Queue; 
 
public class QueueSampler implements QueueSamplerMXBean { 
     
    private Queue<String> queue; 
     
    public QueueSampler(Queue<String> queue) { 
       this.queue = queue; 
    } 
     
    public QueueSample getQueueSample() { 
        synchronized (queue) { 
            return new QueueSample(new Date(), queue.size(), queue.peek()); 
        } 
    } 
     
    public void clearQueue() { 
        synchronized (queue) { 
            queue.clear(); 
        } 
    } 
} 
 

QueueSamplerによって返されたQueueSampleインスタンスは、次のコード例に示すQueueSampleクラスで定義されます。

package com.example.mxbeans; 
 
import java.beans.ConstructorProperties; 
import java.util.Date; 
 
public class QueueSample { 
     
    private final Date date; 
    private final int size; 
    private final String head; 
     
    @ConstructorProperties({"date", "size", "head"}) 
    public QueueSample(Date date, int size, String head) { 
        this.date = date; 
        this.size = size; 
        this.head = head; 
    } 
     
    public Date getDate() { 
        return date; 
    } 
     
    public int getSize() { 
        return size; 
    } 
     
    public String getHead() { 
        return head; 
    } 
} 
 

MXBeanインタフェースとこれを実装するクラス、および返されるJava型を定義したら、次はMXBeanを作成してMBeanサーバーに登録する必要があります。これらのアクションは、次のコード例のクラスMainによって実行されます。

package com.example.mxbeans; 
 
import java.lang.management.ManagementFactory; 
import java.util.Queue; 
import java.util.concurrent.ArrayBlockingQueue; 
import javax.management.MBeanServer; 
import javax.management.ObjectName; 
 
public class Main { 
 
    public static void main(String[] args) throws Exception { 
        MBeanServer mbs = ManagementFactory.getPlatformMBeanServer(); 
         
        ObjectName name = 
                new ObjectName("com.example.mxbeans:type=QueueSampler"); 
         
        Queue<String> queue = new ArrayBlockingQueue<String>(10); 
        queue.add("Request-1"); 
        queue.add("Request-2"); 
        queue.add("Request-3"); 
        QueueSampler mxbean = new QueueSampler(queue); 
         
        mbs.registerMBean(mxbean, name); 
         
        System.out.println("Waiting..."); 
        Thread.sleep(Long.MAX_VALUE); 
    } 
} 
 

MXBeanの例題を実行するには:

1. 「MXBean」の項に含まれているソース・コードをwork_dir/jmx_examples/MXBeanにコピーします。

2. Javaクラスの例をコンパイルします。

   $ javac com/example/mxbeans/*.java

3. Mainアプリケーションを起動します。

   $ java com.example.mxbeans.Main

   何かの発生を待機中のMainに関する確認が表示されます。

4. 同じマシンの別の端末ウィンドウで、JConsoleを起動します。

   $ jconsole

   JConsoleツールが開き、接続可能な稼動中のJMXエージェントのリストが表示されます。

5. 「新規接続」ウィンドウのリストからcom.example.mxbeans.Mainを選択し、「接続」をクリックします。

   プラットフォームの現在のアクティビティのサマリーが表示されます。

6. 「MBean」タブをクリックします。

   このパネルに、現在MBeanサーバーに登録されているすべてのMBeanが表示されます。

7. 左フレームにあるMBeanツリーのcom.example.mxbeansノードを展開します。

   Mainで作成され、登録されたMBean QueueSamplerの例が表示されます。QueueSamplerをクリックすると、関連するAttributesおよびOperationsノードがMBeanツリーに表示されます。

8. Attributesノードを選択します。

   右ペインにQueueSample属性とそのjavax.management.openmbean.CompositeDataSupportの値が表示されます。

9. CompositeDataSupport値をダブルクリックします。

   MXBeanフレームワークがQueueSampleインスタンスをCompositeDataに変換したため、QueueSampleの値であるdate、head、およびsizeが表示されます。QueueSamplerをMXBeanではなく標準MBeanとして定義した場合、QueueSampleクラスはそのクラス・パスには存在しないのでJConsoleからは見つかりません。QueueSamplerが標準MBeanの場合、QueueSample属性値を抽出するとClassNotFoundExceptionが返されます。このように、JConsoleのように汎用的なJMXクライアントでJMXエージェントに接続するときにMXBeanを使用すると便利です。

10. Operationsノードを選択します。

    clearQueue操作を呼び出すボタンが表示されます。

11. 「clearQueue」ボタンをクリックします。

    メソッドの呼出しに成功したことが通知されます。

12. Attributesノードをもう一度選択し、CompositeDataSupport値をダブルクリックします。

    これでキューがリセットされます。

13. 「接続」をクリックし、次に「終了」をクリックして、JConsoleを終了します。

この例では、JConsoleがJMXクライアントとして使用されましたが、JMXクライアントの自作プログラムからMXBeanにアクセスする場合は次の2つの方法のどちらかで行います。

• 一般的には次のコードを使用します。

  MBeanServer mbs = ...whatever...; 
  ObjectName name = new ObjectName("com.example.mxbeans:type=QueueSampler"); 
  CompositeData queueSample = (CompositeData) mbs.getAttribute(name,  
                               "QueueSample"); 
  int size = (Integer) queueSample.get("size"); 
  

• プロキシ経由では次のコードを使用します。

  MBeanServer mbs = ...whatever...; 
  ObjectName name = new ObjectName("com.example.mxbeans:type=QueueSampler"); 
  QueueSamplerMXBean proxy = JMX.newMXBeanProxy(mbs, name,  
                                                QueueSamplerMXBean.class); 
  QueueSample queueSample = proxy.getQueueSample(); 
  int size = queueSample.getSize(); 
  

  このコードでは、newMXBeanProxyメソッドを使用してMXBeanプロキシを作成しています。newMBeanProxyという等価のメソッドがあるのは、ほかの型のMBeanで使用するプロキシを作成するためです。newMBeanProxyおよびnewMXBeanProxyメソッドの使用法はまったく同じです。

注釈DescriptorKeyを使用することで、標準MBeanまたはMXBeanインタフェース内の注釈によって標準MBeanまたはMXBeanの記述子に情報を追加できます。これによって、ツールで既存の管理モデルから標準MBeanを生成し、そのモデルからの情報を別のファイルではなく生成されたMBeanインタフェースに含めることができます。次のコード例は、注釈Authorの定義を示しています。

 
package com.example.mxbeans; 
 
import java.lang.annotation.Documented; 
import java.lang.annotation.ElementType; 
import java.lang.annotation.Retention; 
import java.lang.annotation.RetentionPolicy; 
import java.lang.annotation.Target; 
import javax.management.DescriptorKey; 
 
@Documented 
@Target(ElementType.TYPE) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface Author { 
    @DescriptorKey("author") 
    String value(); 
} 

次のコード例で使用されているQueueSamplerMXBeanインタフェースは、MXBeansの例で使用されているインタフェースとは多少異なります。これは、MBean記述子を実装し、その情報の一部を公開します。

 
package com.example.mxbeans; 
 
@Author("Mr Bean") 
@Version("1.0") 
public interface QueueSamplerMXBean { 
    @DisplayName("GETTER: QueueSample") 
    public QueueSample getQueueSample(); 
    @DisplayName("OPERATION: clearQueue") 
    public void clearQueue(); 
} 
 

例題を実行するには:

1. 「MBean記述子」の項に含まれているソース・コードをwork_dir/jmx_examples/MXBeanにコピーします。

2. Javaクラスの例をコンパイルします。

   $ javac com/example/mxbeans/*.java

3. Mainアプリケーションを起動します。

   $ java com.example.mxbeans.Main

   何かの発生を待機中のMainに関する確認が表示されます。

4. 同じマシンの別の端末ウィンドウで、JConsoleを起動します。

   $ jconsole

   JConsoleツールが開き、接続可能な稼動中のJMXエージェントのリストが表示されます。

5. 「新規接続」ウィンドウのリストからcom.example.mxbeans.Mainを選択し、「接続」をクリックします。

   プラットフォームの現在のアクティビティのサマリーが表示されます。

6. 「MBean」タブをクリックします。

   このパネルに、現在MBeanサーバーに登録されているすべてのMBeanが表示されます。

7. 左フレームにあるMBeanツリーのcom.example.mxbeansノードを展開します。

   Mainで作成され、登録されたMBean QueueSamplerの例が表示されます。QueueSamplerをクリックすると、関連するAttributesおよびOperationsノードがMBeanツリーに表示されます。フィールドauthorおよびversionもMBeanInfo記述子表に表示されます。

8. QueueSampler MBeanノードの下にあるAttributesおよびOperationsノードを展開します。

   AttributesとOperationsが個別に表示されます。

9. QueueSampleノードを選択します。

   MBeanAttributeInfo記述子表にdisplayNameフィールドが表示されます。

10. clearQueueノードを選択します。

    MBeanOperationInfo記述子表にdisplayNameフィールドが表示されます。

11. 「接続」をクリックし、次に「終了」をクリックして、JConsoleを終了します。