JMX によるカスタム管理ユーティリティの開発

概要とロードマップ

サードパーティ製の管理システムを WebLogic Server 管理システムと統合するために、WebLogic Server には標準ベースのインタフェースが用意されています。これらのインタフェースは、Java Management Extensions (JMX) 仕様に完全に準拠しています。ソフトウェアベンダはこれらのインタフェースを使用して、WebLogic Server MBean をモニタし、WebLogic Server ドメインのコンフィグレーションを変更し、ドメイン内のすべてのサーバインスタンスに対するこれらの変更の配布 (アクティブ化) をモニタすることができます。JMX クライアントは BEA 独自のクラスを使用しなくても、すべての WebLogic Server 管理機能を実行できますが、リモート JMX クライアントでは WebLogic Server プロトコル (T3 など) を使用して WebLogic Server インスタンスに接続することをお勧めします。

このマニュアルでは、WebLogic Server リソースをモニタおよび変更する JMX クライアントの作成について説明します。

以下の節では、このマニュアル『JMX によるカスタム管理ユーティリティの開発』の内容と構成について説明します。

マニュアルの内容と対象読者

このマニュアルは、JMX 互換管理システムを開発するソフトウェアベンダを対象としています。また、WebLogic Server® を評価するビジネスアナリストや、特定のアプリケーションで JMX の使用を考えているシステム設計者にとって便利な情報も掲載されています。

このマニュアルは、J2EE および一般的なアプリケーション管理の概念に精通している読者を対象としています。このマニュアルでは、限定的でありながら有用な一連の JMX 管理サービスを開発するための実践的な方法を重点的に扱います。JMX をより広範な管理上の問題に適用するには、「関連ドキュメント」に挙げる JMX 仕様などのドキュメントを参照してください。

このマニュアルの手引き

この章「概要とロードマップ」では、このマニュアルの構成を紹介します。
「WebLogic Server MBean について」では、WebLogic Server MBean のモニタと管理に使用する JMX サービスと、WebLogic Server MBean をまとめるデータモデルについて説明します。
「WebLogic Server サブシステム MBean の概要」では、WebLogic Server のさまざまなサブシステムのモニタおよび管理に使用できる MBean について説明します。
「JMX を使用した WebLogic Server MBean へのアクセス」では、JMX クライアントから WebLogic Server MBean にアクセスする手順について説明し、例を示します。
「JMX を使用したドメインのコンフィグレーションの管理」では、JMX を使用して WebLogic Server ドメインのコンフィグレーションを管理する手順について説明し、例を示します。
「通知とモニタ MBean の使い方」では、通知と WebLogic Server MBean 属性の変更をリスンするリスナの使い方について説明します。
「WebLogic Server JMX サービスのコンフィグレーション」では、ドメインで使用できる JMX サービスを指定する方法について説明します。

このリリースでの JMX の新機能と変更点

リリース 9.0 では、WebLogic Server JMX 実装に、以下のようないくつかの重要な変更点が導入されています。

JMX 1.2 および JMX リモート API 1.0 (JSR-160)

WebLogic Server 9.0 では、JDK 1.5 に含まれている Java Management Extensions (JMX) 1.2 実装が使用されています。9.0 より前のリリースでは、JMX 1.0 仕様をベースにした独自の JMX 実装が使用されていました。

また 9.0 では、リモート JMX クライアントは標準の JMX リモート API 1.0 (JSR-160) を使用して、WebLogic Server の JMX エージェントに接続できます (http://jcp.org/en/jsr/detail?id=160 を参照してください)。9.0 より前のリリースでは、JMX リモート API が公開されておらず、リモート JMX クライアントは BEA 独自の API を使用して WebLogic Server に接続しなければなりませんでした。

非推奨になった MBeanHome および型保障インタフェース

JMX リモート API (JSR-160) が公開されて、リモート JMX アクセスのための BEA 独自の API weblogic.management.MBeanHome は必要がなくなったため、非推奨になっています。

MBeanHome API では、JMX レイヤに対して、WebLogic Server MBean との対話に使用できる型付き API レイヤも提供できました。使用する JMX アプリケーションクラスでは、WebLogic Server MBean の型保障インタフェースをインポートしたり、weblogic.management.MBeanHome インタフェースを介して MBean への参照を取得したり、MBean メソッドを直接呼び出したりすることができました。

9.0 以降、型付き API レイヤも非推奨になりました。この API のようなプログラミングモデルを使用する代わりに、すべての JMX アプリケーションで、標準の JMX プログラミングモデルを使用してください。標準の JMX 設計パターンでは、クライアントは javax.management.MBeanServerConnection インタフェースを使用して、実行時に MBean、属性、および属性タイプを検索します。この JMX モデルでは、クライアントは MBeanServerConnection インタフェースを介して間接的に MBean と対話します。

型保障インタフェース (weblogic.management の下にある) をインポートするクラスがある場合は、標準の JMX プログラミングモデルを使用するように更新を行うことをお勧めします。『JMX によるカスタム管理ユーティリティの開発』の「JMX を使用した WebLogic Server MBean へのアクセス」を参照してください。JMX クライアントを更新しない場合、JMX クライアントではドメインの互換性 MBean サーバが使用されます。この互換性 MBean サーバはデフォルトで有効になっています。

MBeanHome API を使用して一般的なコンフィグレーションタスクを自動化していた場合は、JMX の代わりに新しい WebLogic Scripting Tool (WLST) を使用することを検討してください。WLST はコマンドライン形式のスクリプトインタフェースで、アクティブまたは非アクティブな Weblogic Server ドメインの管理およびモニタに使用できます。WLST スクリプト環境は、Java のスクリプトインタプリタである Jython に基づいています。WebLogic スクリプト関数に加えて、ローカル変数、条件変数、フロー制御文など、インタプリタ言語の一般的な機能を使用できます。Jython 言語構文に従って、WebLogic スクリプト言語を拡張できます。Jython の詳細については、http://www.jython.org を参照してください。WLST の詳細については、『WebLogic Scripting Tool ガイド』の「WebLogic Scripting Tool の使用」を参照してください。

ドメインにおけるコンフィグレーションデータの配布モデルの変更

WebLogic Server 9.0 では、ドメインのコンフィグレーションに対する変更を収集し、それらをまとめてドメイン全体に配布できます。また 9.0 リリースには、変更の配布のモニタに使用できる API も含まれています。

9.0 では、管理サーバは一連の保留中の MBean をホストします。これらはドメインのコンフィグレーションに対するすべての保留状態の変更をメモリ内で表現しています (保留中の MBean データは、保留中の config.xml ファイルにバックアップされます)。保留中の MBean の変更は、すぐには有効になりません。トランザクションと類似したプロセスで、明示的に変更を配布する必要があります。変更を消費できない管理対象サーバが 1 つでもあれば、分散プロセスにおける一連の変更点すべてがロールバックされます。このトランザクションプロセスが、JMX を使用してドメインのコンフィグレーションを変更する唯一の方法です。『JMX によるカスタム管理ユーティリティの開発』の「JMX を使用したドメインのコンフィグレーションの管理」を参照してください。

9.0 より前のリリースでは、ドメイン内のすべてのサーバおよびサーバリソースの永続化されたコンフィグレーションを表す一連の MBean (管理 MBean) を管理サーバがホストしていました。パフォーマンス向上のために、各サーバインスタンスは、これらの MBean をローカルでレプリケートし、ローカルコンフィグレーション MBean と呼ばれるレプリカを使用していました。JMX クライアントが管理 MBean を変更すると、管理サーバは、それ自身がその変更を統合できない場合でも、ドメイン内のすべてのサーバインスタンス上のローカルコンフィグレーション MBean をすぐに更新しました。場合によっては、サーバインスタンスを再起動しないとローカルコンフィグレーション MBean を更新できなかったり、レプリカとそのマスター管理 MBean に異なる値が格納されたりすることがあり、さらに、JMX クライアントは直接ローカルコンフィグレーション MBean にアクセスして値を変更できたため、レプリカとそのマスター MBean の間で矛盾した状態になってしまうこともありました。

MBean データモデルの変更

JMX 仕様では、MBean をまとめるためのモデルを定めていません。ただし、WebLogic Server ドメインのコンフィグレーションは XML ドキュメント内で指定されるため、WebLogic Server は MBean を、XML ドキュメント構造を反映した階層モデルにまとめます。

たとえば、ドメインのコンフィグレーションドキュメントのルートは <domain> であり、そのルートの下には、<server>、<cluster> などの子要素があります。各ドメインは、<domain> ルート要素を表す DomainMBean タイプの 1 つの MBean を保持しています。DomainMBean 内では、JMX 属性が、<server>、<cluster> などの子要素を表す MBean へのアクセスを提供します。

9.0 より前のリリースでは、次のようになっていました。

WebLogic Server サブシステム間でデータモデルが一致していなかった。
MBeanServer.createMBean を呼び出して、正確に作成された階層オブジェクト名を渡すことで、JMX クライアントは WebLogic Server MBean を作成し、それにアクセスできた。しかし、JMX クライアントがオブジェクト名を間違って作成した場合、その MBean は作成され登録されるものの、WebLogic Server データモデル内で認識されません。

9.0 以降は、以下のようになっています。

データモデルは、WebLogic Server サブシステム間で一致している。
JMX クライアントで MBean のライフサイクルを制御できるようにするために、WebLogic Server MBean には Java Bean ファクトリメソッドの設計パターンに従うオペレーションが含まれている。親 MBean には、それぞれの子に対する createChild オペレーションおよび destroyChild オペレーションが含まれています。Child は MBean タイプの短縮名です (短縮名とは、MBean サフィックスの付かない、MBean の未修飾のタイプ名。例 : createServer)。また、親には lookupChild オペレーションと Children 属性も含まれています。

たとえば、DomainMBean には、createServer、destroyServer、および lookupServer というオペレーションと Servers 属性が含まれています。
これ以外に子 MBean を作成する方法はありません。

JMX クライアントが WebLogic Server MBean を取得するときに、JMX オブジェクト名を作成する必要はなくなった。代わりに、次のようなコードを連続して呼び出すことで MBean 階層を移動します。

ObjectName on = javax.management.MBeanServerConnection.getAttribute (object-name, attribute);
各値の説明は次のとおりです。

object-name は、MBean 階層内の現在のノード (MBean) のオブジェクト名です。
attribute は、別の MBean を参照する、現在の MBean の属性の名前です。

互換性 MBean サーバ (JMX クライアントで引き続き非推奨の MBeanHome インタフェースを使用する場合は有効にする必要がある) では、JMX クライアントが WebLogic Server MBean のインスタンスの正確に作成された階層オブジェクト名を指定した場合にのみ、その新しいインスタンスが登録される。

クライアントは、明確に定義された不変のオブジェクト名で MBean サーバに登録されている一連の新しいサービス MBean を使用して、階層にアクセスできます。JMX クライアントは、このオブジェクト名を指定してサービス MBean を取得します。その後、そのサービス MBean の属性とオペレーションを使用して、WebLogic Server MBean 階層のルートを取得します。

機能が調整された新しい MBean サーバ

管理サーバは 3 種類の MBean サーバを保持しており、それぞれの MBean サーバが別々の MBean 階層へのアクセスを提供します。編集 MBean サーバはドメインの編集可能なコンフィグレーション MBean へのアクセスを提供し、ドメイン実行時 MBean サーバはドメイン内のすべての実行時 MBean および読み込み専用コンフィグレーション MBean への結合アクセスを提供し、実行時 MBean サーバは管理サーバ上の実行時および読み込み専用コンフィグレーション MBean のみへのアクセスを提供します。

各管理対象サーバは、実行時 MBean サーバを保持します。これは、実行時および読み込み専用コンフィグレーション MBean のみへのアクセスを提供するものです。

JMX クライアントは、標準の javax.remote.access (JSR-160) API を使用して、MBean サーバに登録された MBean にアクセスし、これらと対話を行います。

『JMX によるカスタム管理ユーティリティの開発』の「MBean サーバ」を参照してください。

サブシステム MBean の変更

WebLogic Server 9.0 では、アプリケーション開発者がアプリケーションのサービス (JMS サービスや JDBC サービスなど) の記述子を作成し、アプリケーションの EAR ファイルにパッケージ化できます。アプリケーションのデプロイ時に、WebLogic Server によってサービスのインスタンスが作成され、記述子で定義されているとおりにコンフィグレーションされます。これらのアプリケーションスコープのサービスをサポートするために、多くのサブシステムが、旧 JMX インタフェースの全部または一部を非推奨にして、新しい MBean または更新された MBean で置き換えています。

9.0 で非推奨になった MBean および新規の MBean のリストについては、『WebLogic Server MBean リファレンス』を参照してください。

カスタム MBean の登録機能

9.0 より前のリリースでは、WebLogic Server インスタンスで MBean サーバにカスタム MBean を登録する場合、独自の MBean サーバを作成するか、weblogic.management.RemoteMBeanServer を使用して、WebLogic Server の MBean サーバに登録を行うことができました。

9.0 および JDK 1.5 以降は、WebLogic Server JVM で実行されている JMX クライアントから、以下のいずれかを行うことができます。

(推奨) JNDI を介して実行時 MBean サーバにアクセスし、実行時 MBean サーバにカスタム MBean を登録。
JVM のプラットフォーム MBean サーバにカスタム MBean を登録。
独自の MBean サーバを作成。

『JMX による管理の容易なアプリケーションの開発』の「実行時 MBean サーバの使用」を参照してください。

WebLogic Server MBean の新しいリファレンスドキュメント

パブリックな WebLogic Server MBean はすべて、新しいドキュメント『WebLogic Server MBean リファレンス』で説明されています。このドキュメントでは、各 MBean について、以下の情報が記載されています。

WebLogic Server MBean ツリー内における MBean ファクトリメソッドおよびその他のアクセスポイント
各属性についてのデータ型、読み書きの特権、およびその他の情報
各オペレーションについての、パラメータ、署名、およびその他の情報