K MBeanの構成要素

この付録では、MBeanの構成に使用できる要素について説明します。

Coherenceのデプロイメント・ディスクリプタにおけるMBean

MBeanの構成要素は、coherence.jarにパッケージ化されているcoherence.dtd XMLファイルで定義されます。

ドキュメント・ルート

POFユーザー定義型のディスクリプタのルート要素はmbeansです。MBeanの構成はここから開始します。

ドキュメントの形式

MBeanの構成要素の形式およびネストを例K-1に示します。

例K-1 MBeanの構成要素の形式およびネスト

<mbeans>
  <mbean>
    <mbean-class>
    <mbean-factory>
    <mbean-query>
    <mbean-accessor>
    <mbean-name>
    <enabled>
    <extend-lifecycle>
  </mbean>
</mbeans>

MBeanの構成要素の索引

表K-1 MBeanの構成要素の索引

要素	使用場所
`extend-lifecycle`	`mbean`
`enabled`	`mbean`
`mbean`	`mbeans`
`mbean-accessor`	`mbean`
`mbean-class`	mbean
`mbean-factory`	`mbean`
`mbean-name`	`mbean`
`mbean-query`	`mbean`
`mbeans`	ルート要素

extend-lifecycle

使用場所: mbean

説明

MBeanがノード接続のライフ・サイクルを超えるかどうかを指定します。falseの場合、MBeanは破棄され、グリッドからノードの接続が切断されたときに再作成されます。trueの場合、MBeanは、複数回の接続にわたって統計および値を保持します。

例

<extend-lifecycle>true</extend-lifecycle>

enabled

使用場所: mbean

説明

enabled要素は、MBeanをインスタンス化する場合はtrue、MBeanを無視する場合はfalseを指定します。

例

<enabled>true</enabled>

mbean

使用場所: mbeans

説明

mbean要素には、Coherence Managementインフラストラクチャでインスタンス化および登録される要素のリストを記述します。

要素

表K-2は、mbeans要素で定義可能なサブ要素について説明しています。

表K-2 mbeanのサブ要素

要素	必須/オプション	説明
<`mbean-class`>	オプション	インスタンス化する標準MBeanのクラスを指定します。
<`mbean-factory`>	オプション	MBeanのインスタンス化に使用されるファクトリのクラスを指定します。
<`mbean-query`>	オプション	MBeanの取得に使用されるJMX `ObjectName`問合せパターンを指定します。
<`mbean-accessor`>	オプション	MBeanのインスタンス化に使用される`<mbean-factory>`上のアクセッサ・メソッドを指定します。
<`mbean-name`>	必須	MBeanの`ObjectName`接頭辞を指定します。
<local-only>	オプション	クラスタ全体でのMBeanの可視性を制御します。`true`に設定されていると、MBeanはローカルのMBeanServerにのみ登録され、他のクラスタ・ノードからはアクセスできません。それ以外の場合は、`nodeId=...`キー属性が名前に追加され、MBeanはあらゆる管理ノード（値が`all`または`remote-only`に設定されたmanaged-nodes要素を持つノード）で可視になります。デフォルト値は`false`です。
<`enabled`>	オプション	このインスタンスにMBeanを登録するかどうかを指定します。デフォルト値は`false`です。
<extend-lifecycle>	オプション	MBeanがノード接続のライフ・サイクルを超えるかどうかを指定します。`false`の場合、MBeanは破棄され、グリッドからノードの接続が切断されたときに再作成されます。`true`の場合、MBeanは複数回の接続にわたって統計および値を保持します。

mbean-accessor

使用場所: mbean

説明

mbean-accessor要素には、MXBeanをインスタンス化するMBeanファクトリ上のアクセッサ・メソッド名を記述します。正しくインスタンス化するには、クラス・パスにMBeanファクトリ・クラスを指定する必要があります。<mbean-accessor>要素には、mbean-factory要素が必要です。

例

<mbean-factory>java.lang.management.ManagementFactory</mbean-factory>
<mbean-accessor>getMemoryMXBean</mbean-accessor>

mbean-class

使用場所: mbean

説明

mbean-class要素には、standard MBeanのクラス名を記述します。正しくインスタンス化するには、クラス・パスにMBeanクラスを指定する必要があります。

例

<mbean-class>com.oracle.custom.mbeans.query</mbean-class>

mbean-factory

使用場所: mbean

説明

mbean-factory要素には、MXBeansをインスタンス化するMBeanファクトリのクラス名を記述します。正しくインスタンス化するには、クラス・パスにMBeanファクトリ・クラスを指定する必要があります。<mbean-factory>要素には、mbean-accessor要素が必要です。

例

<mbean-factory>java.lang.management.ManagementFactory</mbean-factory>
<mbean-accessor>getMemoryMXBean</mbean-accessor>

mbean-name

使用場所: mbean

説明

mbean-name要素には、生成されたMBeanのObjectName接頭辞を記述します。このObjectName接頭辞は、カンマで区切られたキー=値のペアである必要があります。CoherenceのMBeanのネーミング規則には、名前は"type"/"value"のペア（つまり、type=Platform）で始まる必要があると規定されています。

例

カスタムmbeansにtype=Platformの接頭辞を付けるには:

<mbean-name>type=Platform</mbean-name>

mbean-query

使用場所: mbean

説明

mbean-query要素には、JMX ObjectName問合せパターンを記述します。問合せパターンはローカルのMBeanサーバーに対して実行され、生成されたオブジェクトはCoherence Managementインフラストラクチャに登録されます。これにより、グリッドに対してMBeanのシングル・ポイント統合が可能になります。

例

<mbean-query>java.lang:*</mbean-query>

この場合、Coherence Managementインフラストラクチャのjava.langドメインにすべてのMBeanが含まれます。

注意:

ローカルのMBeanサーバーが有効である必要があります。

mbeans

使用場所: management-config

説明

mbeans要素は、カスタムmbeanコンフィギュレーション・ファイルのルート要素です。この要素には、Coherence Managementインフラストラクチャでインスタンス化および登録されるmbean要素のリストを記述します。

要素

表K-3は、mbeans要素で定義可能な要素について説明しています。

表K-3 mbeansのサブ要素

要素	必須/オプション	説明
<`mbean`>	必須	Coherence Managementサービスでインスタンス化および登録されるMBeanのタイプ、実装および`ObjectName`を指定します。