5. JMXアプリケーションの開発

5.1. チュートリアル

• JMX API
  
• JMX Remote API
  それぞれのAPIリファレンスについては[ リファレンス集 開発編（共通） ] を参照してください。
  以下は上記APIを利用してMBeanの属性を取得、設定したり、オペレーションを呼び出したり、Notification通知を受け取る手順について説明します。
  
• JMXConnectorの生成
  
• MBeanServerConnectionの取得
  
• MBeanのObjectNameの取得
  
• MBeanInfoの取得
  
• 属性の取得
  
• 属性の設定
  
• オペレーションの呼び出し
  
• Notificationの受信
  

5.1.1. JMXアプリケーション動作環境について

5.1.1.1. ビルド環境

• J2SE
      Java(TM) 2 SDK, Standard Edition　5.0以上を使用してください。
  
  
• CLASSPATH
      ビルドするときは以下のライブラリをクラスパスに追加してください。
          - ${INSTALL_ROOT}/lib/javaee.jar
          - ${INSTALL_ROOT}/lib/wosv-rt.jar

5.1.1.2. 実行環境

• J2SE
      Java(TM) 2 SDK, Standard Edition　5.0以上を使用してください。
  
  
• CLASSPATH
      実行するときは以下のライブラリをクラスパスに追加してください。
          - ${INSTALL_ROOT}/lib/javaee.jar
          - ${INSTALL_ROOT}/lib/wosv-rt.jar
  
  
• 証明書ファイル
      サーバ/クライアント間のSSL通信で利用する証明書ファイルが必要です。サーバ側の認証ファイルに格納されている情報の認証情報が格納されている必要があります。
      なおサーバ側の認証ファイルは
          ${INSTANCE_ROOT}/config/keystore.jks
      にあります。
      サンプルアプリケーションにもサンプル用の証明書ファイル(cacerts.jks)がありますのでこれを利用することは可能です。
  
  
• システムプロパティ
      JMXアプリケーションとして次のシステムプロパティを利用します。
          - javax.net.ssl.trustStore
      クライアントの証明書ファイルを指定します。

5.1.2. JMX Remote APIの設定について

コーディング例

import java.util.*;
import java.security.*;
import java.io.*;
import javax.net.ssl.*;
                  
//
// JMX API 1.2
//
import javax.management.MBeanAttributeInfo;
import javax.management.MBeanOperationInfo;
import javax.management.MBeanNotificationInfo;
import javax.management.MBeanInfo;
                  
import javax.management.Attribute;
import javax.management.MBeanServerConnection;
import javax.management.MBeanServerInvocationHandler;
import javax.management.ObjectName;
import javax.management.AttributeList;
                  
//
// JMX Remote API 1.0
//
import javax.management.remote.JMXConnector;
import javax.management.remote.JMXConnectorFactory;
import javax.management.remote.JMXServiceURL;
                  
//
// WebOTX API  8.1
// ${INSTALL_ROOT}/lib/wosv-rt.jar
//
import com.nec.webotx.enterprise.admin.jmx.remote.client.*;
import com.nec.webotx.enterprise.admin.jmx.remote.plainclient.*;

5.1.3. JMXConnectorの生成

5.1.3.1. JMXRemoteClientクラスを利用する方法

コーディング例

// URLの生成
// プロトコル RMI
// ホスト名 localhost
// 管理ポート番号 6212
JMXServiceURL url = new JMXServiceURL("service:jmx:rmi:///jndi/rmi://host:6212/management/rmi-jmx-connector");

// JMXRemoteClientの生成
final JMXRemoteClient jmxcl = new JMXRemoteClient();
jmxcl.config(System.getProperty("javax.net.ssl.trustStore"), "changeit", false);

// JMXConnectorの生成
final JMXConnector jmxc = jmxcl.connect(url.toString(), username, password);

URLの生成

JMXRemoteClientの生成

JMXConnectorの生成

service:jmx:[protocol]://[host]:[port][url-path]

5.1.3.2. 標準のJMX Remote APIを利用する方法

コーディング例

// プロファイル情報格納領域の生成
HashMap env = new HashMap();

// SSLSocketFactoryの生成
tring truststore = System.getPropery("javax.net.ssl.trustStore");
char truststorepass[] = "changeit".toCharArray();
KeyStore ks = KeyStore.getInstance("JKS");
ks.load(new FileInputStream(truststore), truststorepass);
TrustManagerFactory tmf = TrustManagerFactory.getInstance("SunX509");
tmf.init(ks);
SSLContext ctx = SSLContext.getInstance("TLSv1");
ctx.init(null, tmf.getTrustManagers(), null);
SSLSocketFactory ssf = ctx.getSocketFactory();

// プロバイダ関数の登録
Security.addProvider( new com.nec.webotx.enterprise.admin.jmx.remote.plainclient.ClientProvider());

// プロファイル情報の設定
env.put("jmx.remote.profiles","TLS SASL/PLAIN");
env.put("jmx.remote.tls.socket.factory", ssf);
env.put("jmx.remote.tls.enabled.protocols", "TLSv1");
env.put("jmx.remote.tls.enabled.cipher.suites","SSL_RSA_WITH_NULL_MD5");

// コールバック関数の登録
env.put("jmx.remote.sasl.callback.handler"
        , new com.nec.webotx.enterprise.admin.jmx.remote.client.UserPasswordCallbackHandler(user, password));

// URLの生成
// プロトコル RMI
// ホスト名 localhost
// 管理ポート番号 6212
JMXServiceURL url = new JMXServiceURL("service:jmx:rmi:///jndi/rmi://host:6212/management/rmi-jmx-connector");

// JMXConnectorの生成
final JMXConnector jmxc = JMXConnectorFactory.connect(url, env);

SSLSocketFactoryの生成

プロバイダ関数の設定

プロファイル情報の設定

コールバック関数の登録

URLの生成

JMXConnectorの生成

5.1.4. MBeanServerConnectionの取得

コーディング例

	MBeanServerConnection mbsc = jmxc.getMBeanServerConnection();
	

MBeanServerConnectionインタフェース

5.1.5. MBeanのObjectNameの取得

コーディング例

// オブジェクト名の検索
ObjectName objname = new ObjectName("*:*");
et objnames = mbsc.queryNames(objname,null);

for (final Iterator i=objnames.iterator();i.hasNext(); ) {
    bjectName name = (ObjectName)i.next();
    System.out.println("MBean: " + name);
}

オブジェクト名の検索について

MyDomain:description=Printer,type=laser
MyDomain:description=Disk,capacity=2
DefaultDomain:description=Disk,capacity=1
DefaultDomain:description=Printer,type=ink

DefaultDomain:description=Printer,type=laser,date=1993

Socrates:description=Printer,type=laser,date=1993

•  “*:*” はMBeanサーバの全てのオブジェクトと一致します。 パターンとして使用される無効のストリング・オブジェクトあるいは空のストリング("")名は、"*:*"と等価です。
  
• “:*” はデフォルトのドメイン(DefaultDomain)の全てのオブジェクトと一致します。
  
• “MyDomain:*”はMyDomainの中の全てのオブジェクトが一致します。
  
• “??Domain:*”はMyDomainの中でオブジェクトとすべて一致します。
  “*Dom*:*”はMyDomainとDefaultDomainの中の全てのオブジェクトと一致します。
  
• “*:description=Printer,type=laser,*” は、次のオブジェクトと一致します。
  
  
     MyDomain:description=Printer,type=laser
     DefaultDomain:description=Printer,type=laser,date=1993
     Socrates:description=Printer,type=laser,date=1993
  
  
  
• “*Domain:description=Printer,*” は、次のオブジェクトと一致します。
  
  
     MyDomain:description=Printer,type=laser
     DefaultDomain:description=Printer,type=ink
     DefaultDomain:description=Printer,type=laser,date=1993
  
  
  

5.1.6. MBeanInfoの取得

コーディング例

MBeanInfo info = mbsc.getMBeanInfo((ObjectName)name);
MBeanAttributeInfo[] attrs = info.getAttributes();
if (attrs != null){
  for (int j=0; j<attrs.length; j++) {
    System.out.println("attribute : " + attrs[j].getName());
  }
}

MBeanOperationInfo[] ops = info.getOperations();
if (ops != null){
  for (int j=0; j< ops.length; j++) {
    System.out.println("operation : " + ops[j].getName());
  }
}

MBeanNotificationInfo[] nts = info.getNotifications();
if (nts != null){
  for (int j=0; j< nts.length; j++) {
    System.out.println("nts : " + nts[j].getName());
  }
}

MBeanInfo

• 属性の情報(MBeanAttributeInfo)
  属性名、属性の型などを取得することが出来ます。
  
• オペレーションの情報(MBeanOperationInfo)
  オペレーション名、返却値の型、引数の情報などを取得することが出来ます。
  
• Notificationの情報(MBeanNotificationInfo)
  サポートするNotificationのタイプを取得することが出来ます。
  

5.1.7. 属性の取得

コーディング例

// 属性の取得
Object attrValue = mbsc.getAttribute(name,attrs[j].getName());
System.out.println(attrs[j].getName() + " = " + attrValue);

属性の取得

•      getAttribute : 指定した属性の値を取得します。
•      getAttributes : 指定した複数の属性の値を取得します。

5.1.8. 属性の設定

コーディング例

// 属性の設定
Attribute attr = new Attribute("description","sample test")；
mbsc.setAttribute(,name,attr);

属性の設定

•      setAttribute : 指定した属性の値を設定します。
•      setAttributes :　指定した複数の属性の値を設定します。

5.1.9. オペレーションの呼び出し

コーディング例

// オペレーションの呼び出し
Object retValue = mbsc.invoke(name, "start",null,null);

オペレーションの呼び出し

5.1.10. Notificationの受信

コーディング例

SampleListener listener = new SampleListener();
mbsc.addNotificationListener(name, listener, null, null);

Notificationリスナクラスの作成

Notificationリスナの登録