BEA ホーム | 製品 | dev2dev | support | askBEA |
![]() |
![]() |
|
![]() |
e-docs > WebLogic Server > WebLogic Security サービスの開発 > MBean 定義ファイル (MDF) 要素の構文 |
WebLogic Security サービスの開発
|
MBean 定義ファイル (MDF) は WebLogic MBeanMaker ユーティリティへの入力ファイルです。WebLogic MBeanMaker ユーティリティは、このファイルを使用してカスタム セキュリティ プロバイダを管理するための MBean タイプを作成します。MDF は、単一の MBean タイプを記述する有効な整形式 XML ファイルとしてフォーマットされる必要があります。以下の節では、有効な MDF で使用可能なすべての要素と属性について説明します。
すべての MDF には MBeanType というルート要素が 1 つ含まれていなければなりません。この要素の構文は次のとおりです。
<MBeanType Name= string optional_attributes>
subelements
</MBeanType>
MBeanType 要素には Name 属性が含まれている必要があります。これは、その MBean タイプのプログラム上の内部的な名前を指定するものです (ユーザ インタフェースに表示される名前を指定するには、DisplayName 属性と LanguageMap 属性を使用します)。他の属性は省略可能です。
以下の例は、MBeanType (ルート) 要素を簡略化して示したものです。
<MBeanType Name=“MyMBean” Package=”com.mycompany”>
<MBeanAttribute Name=“MyAttr” Type=”java.lang.String” Default=“Hello World”/>
</MBeanType>
MBeanType (ルート) 要素内に指定されている属性は、その MBean タイプからインスタンス化されるすべての MBean に適用されます。特定の MBean インスタンスの属性をオーバーライドするには、MBeanAttribute 下位要素で属性を指定する必要があります。詳細については、MBeanAttribute 下位要素を参照してください。
表 A-1 では、MBeanType (ルート) 要素で使用可能な属性について説明します。「JMX 仕様/BEA 拡張機能」カラムは、当該属性が JMX 仕様に対する BEA 拡張機能なのか、それとも JMX の標準属性なのかを示します。なお、BEA 拡張機能は他の J2EE Web サーバ上では動作しない可能性があることに注意してください。
値が true の場合には、当該 MBean タイプは (Java 抽象クラスと同様に) インスタンス化できないことを意味する。ただし、他の MBean タイプは当該 MBean タイプの属性と操作を継承できる。true を指定した場合には、管理タスクを実行するための非抽象 MBean タイプを別途作成する必要がある。この属性の値を指定しない場合には、値が false であると仮定される。 |
|||
無視される。このフラグは、将来の機能をサポートするために存在している。たとえば、キャッシング スタブでキャッシングを提供する場合、このフラグはキャッシングを無効にする場合がある。 現在、WebLogic MBeanMaker で作成された MBean は、JMX Model MBean の仕様により、サーバレベルのキャッシングを提供する。 注意: JMX Model MBean の詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
この文字列を使用すると、MBean タイプを分類またはグループ化して、セキュリティ認可の実装を提供するすべての MBean タイプを識別するといったことができる。この属性には、デフォルト値または仮定される値はない。 |
|||
キャッシュされた値が有効期限内にあるとみなされる許容時間 (秒数)。この時間が経過した後、値にアクセスしようとすると、再計算がトリガされる。 MBeanType 要素に指定すると、この値は MBean タイプのデフォルトと見なされる。同じ属性を MBean の MBeanAttribute または MBeanOperation 下位要素に設定すると、個々の MBean に関してオーバーライドできる。 |
|||
当該 MBean タイプが非推奨扱いになっていることを示す。この情報は生成された Java ソースに表示されると共に、管理アプリケーションでの使用を想定して ModelMBeanInfo オブジェクトにも格納される。この属性を指定しない場合には、値が false であると仮定される。 |
|||
当該 MBean タイプに関連付けられる任意の文字列で、生成されたクラスの Javadoc など、さまざまな場所に現れる。デフォルト値または仮定される値はない。 注意: ユーザ インタフェース内に表示される概要記述を指定するには、DisplayName、DisplayMessage、および PresentationString の各属性を使用する。 |
|||
ユーザ インタフェースに表示される MBean タイプの説明用メッセージ。デフォルト値または仮定される値はない。 DisplayMessage はツールのヒントやヘルプで用いられるパラグラフになる場合がある。MBean タイプに設定された DisplayMessage は、インスタンスの作成時に個々の MBean に対して別の値を指定しない限り、MBean インスタンスのデフォルトと見なされる。 |
|||
ユーザ インタフェースに表示される MBean タイプのインスタンス識別用の名前。タイプ X のインスタンスの場合、デフォルト DisplayName は「タイプ X のインスタンス」となる。通常、この値はインスタンス作成時にオーバーライドされる。 LanguageMap 属性を使用する場合には、DisplayName 値は LanguageMap のリソース バンドル内で名前を見つけるためのキーとして使われる。LanguageMap 属性を指定しない場合や、そのキーがリソース バンドルに存在しない場合には、DisplayName 値そのものがユーザ インタフェースに表示される。 「MessageID」を参照。 |
|||
WebLogic MBeanMaker では、この属性は使用されない。ただし、これを使用する可能性のあるアプリケーションをサポートするために、WebLogic MBeanMaker では、この値を MBeanInfo オブジェクトに追加する。デフォルト値または仮定される値はない。 注意: Export 属性の詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
この MBean タイプが拡張する完全修飾 MBean タイプ名。 「Implements」を参照。 |
|||
値が true の場合には、Type が array の MBeanAttribute 下位要素はすべて、索引アクセスをサポートするための付加的な操作とインタフェース メソッドを生成できるようになる。値が false の場合には、すべての MBeanAttribute 下位要素が、付加的な操作とメソッドを生成できなくなる。この属性を指定しない場合には、値が true であると仮定される。 |
|||
この MBean タイプを実装する完全修飾 MBean タイプ名からなるカンマ区切りリスト。 「Extends」を参照。 |
|||
値が true の場合には、アクセスしやすくなるように、MBean タイプのインスタンスがすべて 1 つのリストに保持されることになる。ただし、この属性を true に設定すると、メモリ消費量が増える。 注意: デフォルトでは、セキュリティ関係のすべての MBean タイプが true に設定されている。それらの MBean のインスタンスでこの属性をオーバーライドすると、セキュリティに悪影響が及ぶおそれがある。 |
|||
表示可能な文字列のマップを格納したリソース バンドルの完全修飾パス名を指定する。他の属性 (たとえば DisplayMessage や DisplayName など) は、LanguageMap 内の文字列を用いて、MBean タイプに関する情報を表示する。 この属性を指定しない場合には、他の属性 (たとえば DisplayMessage や DisplayName など) は、自分自身の値を表示する (それらの値をキーに使ってリソース バンドル内の適切な文字列を検索するわけではない)。 |
|||
通知リスナのスタブを MBean 実装オブジェクト内に生成する。この属性を指定しない場合には、値が false であると仮定される。 注意: リスナ スタブの詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
値が true の場合、MBean タイプの通知をログ ファイルに追加するよう指定する (LogFile 属性は情報の出力先となるファイルを指定する)。この属性を指定しない場合には、値が false であると仮定され、通知はログ ファイルに追加されない。 注意: MBean 通知およびログの詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
この MBean タイプの通知が発生したときにメッセージが出力される既存の書き込み可能ファイルの完全修飾パス名。ロギングが行われるためには、Log 属性を true に設定しておく必要がある。この属性には、デフォルト値または仮定される値はない。 注意: MBean 通知およびログの詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
BEA から提供される MBean タイプのサブクラスの完全修飾クラス名。これは、主に将来の開発用および Model MBean の拡張を望む開発者向けに用意されている。 注意: JMX Model MBean の詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
Java Management eXtensions 1.0 仕様に従ってクライアントサイド メッセージ リポジトリからメッセージを取得するためのキーを提供する。 MessageID と DisplayMessage のどちらか一方あるいは両方を用いて、通知 MBean タイプを記述することができる。この属性を指定しない場合には、メッセージ ID は利用できない。 注意: MessageID は、LanguageMap 属性で指定されるのと同じリソース バンドルを使用せず、通知 MBean タイプ専用である。 |
|||
当該 MBean タイプのパッケージ名を指定し、WebLogic MBeanMaker によって作成されるクラス ファイルの場所を決定する。この属性を指定しない場合には、MBean タイプは Java デフォルト パッケージに格納される。 |
|||
WebLogic MBeanMaker では、この属性は使用されない。ただし、PersistLocation を使用する Model MBean をMBean タイプが拡張するような場合をサポートするために、WebLogic MBeanMaker では、この属性値を MBeanInfo クラスに追加する。デフォルト値または仮定される値はない。 注意: PersistLocation および Model MBean の詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
WebLogic MBeanMaker では、この属性は使用されない。ただし、PersistName を使用する Model MBean をMBean タイプが拡張するような場合をサポートするために、WebLogic MBeanMaker では、この属性値を MBeanInfo クラスに追加する。デフォルト値または仮定される値はない。 注意: PersistName および Model MBean の詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
OnTimer または NoMoreOftenThan の永続性ポリシーで使用される秒数を指定する。MBeanType または MBeanAttribute 要素でこの属性を指定しない場合には、値が 0 であると仮定される。 PersistPolicy が OnTimer に設定されている場合には、この秒数が経過したら属性が永続化される。一方、PersistPolicy が NoMoreOftenThan に設定されている場合には、指定された秒数以上の間隔を置いて永続化が行われるように制限される。 注意: MBeanType 要素内で指定された場合、この属性値は、個々の MBeanAttribute 下位要素内のあらゆる設定をオーバーライドする。 |
|||
MBeanType または MBeanAttribute 要素でこの属性を指定しない場合には、値が Never であると仮定される。 注意: MBeanType 要素内で指定された場合、この属性値は、個々の MBeanAttribute 下位要素内のあらゆる設定をオーバーライドする。 |
|||
ユーザ インタフェースで項目の表示に使用できる情報を提供する単一の XML ドキュメントの完全修飾パス名。この XML ドキュメントは、プレゼンテーション ロジックに関係のある付加的なメタデータも提供する。PresentationString のフォーマットは、XML/JMX に準拠した任意の情報である。 注意: 現在、BEA では専用のフォーマットを定義していないが、独自に定義するより待つことをお勧めする。PresentationString 属性は、将来使用するためのものである。 |
|||
MBean の属性値を MBean API を通じて読み込めるかどうかを決定する。MBeanType または MBeanAttribute 要素でこの属性を指定しない場合には、値が true であると仮定される。 |
|||
MBean タイプのインスタンスをインスタンス化でき、その MBean タイプのインスタンスを参照できるサーバのリストを定義する。MBean タイプのインスタンスは、たとえ管理サーバが利用できなくても、これらのサーバから必ずアクセス (読み取りアクセス) できる。 カンマで区切ったリストには、MBean タイプと同じ管理ドメインにあるサーバの名前を指定する必要がある。値が指定されない場合には、グローバル スコープであると仮定される。つまり、インスタンスはドメイン内のすべてのサーバから参照できる。リスト内に管理対象サーバが 1 つしかない場合には、サーバ固有のスコープになる。つまり、インスタンスは管理対象サーバからしか参照できず、他のサーバにはレプリケートできない。管理サーバと 1 つ以上の管理対象サーバがリストに含まれている場合には、共有スコープになる。つまり、インスタンスは管理サーバと指定された管理対象サーバから参照できる。管理サーバなしで複数の管理対象サーバを指定するとエラーが発生する。 |
|||
Java serialVersionUID に変換する。指定された 値は、生成された実装ファイルに次のフォーマットで直接配置される。 static final long serialVersionUID = <user provided ID>; MBean クラスを互換性を持たない方法で変更した場合、Java シリアライゼーションが正しく機能するように、VersionID を使用して serialVersionUID を変更する必要がある。 serialVersionUID の詳細については、Java 2 Platform Standard Edition v1.3.1 API 仕様を参照のこと。 |
|||
MBean タイプの重要度を示す。ユーザ インタフェースではこの数値を用いて、特定のコンテキストで特定のユーザに当該 MBean タイプを表示するかどうかを決定する。この値が小さければ小さいほど、重要度は高くなる。1 から 4 までの数値を指定できる。この属性を指定しない場合には、値が 1 であると仮定される。 ユーザの関心の高いアイテムの場合には、Visibility に低い数値を指定する。たとえば、WebLogic Server Administration Console では、Visiblity 値が 1 の MBean が左ペインのナビゲーション ツリーに表示される。 |
|||
値が true の場合には、MBean API を通じて MBeanAttribute の値を設定できるようになる。MBeanType または MBeanAttribute でこの属性を指定しない場合には、値が true であると仮定される。 |
MBean タイプ内の属性ごとに、MBeanAttribute 下位要素のインスタンスを 1 つ記述する必要があります。MBeanAttribute 下位要素の形式は次のとおりです。
<MBeanAttribute Name=string optional_attributes />
MBeanAttribute 下位要素には Name 属性が含まれている必要があります。この属性は、その MBean タイプの Java 属性のプログラム上の内部的な名前を指定します (ユーザ インタフェースに表示される名前を指定するには、DisplayName 属性と LanguageMap 属性を使用します)。他の属性は省略可能です。
以下の例は、MBeanType 要素内の MBeanAttribute 下位要素を簡略化して示したものです。
<MBeanType Name=“MyMBean” Package=”com.mycompany”>
<MBeanAttribute Name= "WhenToCache"
Type="java.lang.String"
LegalValues="'cache-on-reference','cache-at-initialization','cache-never'"
Default= "cache-on-reference"
/>
</MBeanType>
MBeanAttribute 下位要素内に指定されている属性は、特定の MBean インスタンスに適用されます。ある MBean タイプからインスタンス化されるすべての MBean の属性を設定するには、MBeanType (ルート) 要素内に属性を指定する必要があります。詳細については、MBeanType (ルート) 要素を参照してください。
表 A-2 では、MBeanAttribute 下位要素で使用可能な属性について説明します。「JMX 仕様/BEA 拡張機能」カラムは、当該属性が JMX 仕様に対する BEA 拡張機能なのかどうかを示します。なお、BEA 拡張機能は他の J2EE Web サーバ上では動作しない可能性があることに注意してください。
無視される。このフラグは、将来の機能をサポートするために存在している。たとえば、キャッシング スタブでキャッシングを提供する場合、このフラグはキャッシングを無効にする場合がある。 現在、WebLogic MBeanMaker で作成された MBean は、JMX Model MBean の仕様により、サーバレベルのキャッシングを提供する。 注意: JMX Model MBean の詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
キャッシュされた値が有効期限内にあるとみなされる許容時間 (秒数)。この時間が経過した後、値にアクセスしようとすると、再計算がトリガされる。 MBeanType 要素に指定すると、この値は MBean タイプのデフォルトと見なされる。同じ属性を MBean の MBeanAttribute または MBeanOperation 下位要素に設定すると、個々の MBean に関してオーバーライドできる。 |
|||
MBeanAttribute 下位要素からゲッター メソッドまたはキャッシュ済みの値が提供されない場合に返すべき値。文字列は、この属性に指定されたデータ型と互換性を持つ型のオブジェクトに評価しなければならない Java 式を表す。 この属性を指定しない場合には、値が null であると仮定される。この仮定値を使用し、かつ LegalNull 属性を false に設定してある場合には、WebLogic MBeanMaker と WebLogic Server から例外が送出される。 |
|||
Default と同じだが、属性のタイプが「文字列」の場合に使用できる。Default を文字列属性で使用する場合、値を引用符で囲まなければならない。DefaultString を使用する場合、引用符は付けない。 |
|||
当該 MBean 属性が非推奨扱いになっていることを示す。この情報は生成された Java ソースに表示されると共に、管理アプリケーションでの使用を想定して ModelMBeanInfo オブジェクトにも格納される。この属性を指定しない場合には、値が false であると仮定される。 |
|||
当該 MBean 属性に関連付けられる任意の文字列で、生成されたクラスの Javadoc など、さまざまな場所に現れる。デフォルト値または仮定される値はない。 注意: ユーザ インタフェース内に表示される概要記述を指定するには、DisplayName、DisplayMessage、および PresentationString の各属性を使用する。 |
|||
ユーザ インタフェースに表示される MBean 属性の説明用メッセージ。デフォルト値または仮定される値はない。 DisplayMessage はツールのヒントやヘルプで用いられるパラグラフになる場合がある。MBean タイプに設定された DisplayMessage は、インスタンスの作成時に個々の MBean に対して別の値を指定しない限り、MBean インスタンスのデフォルトと見なされる。 |
|||
ユーザ インタフェースに表示される MBean タイプのインスタンス識別用の名前。 通常、MBean タイプの DisplayName のデフォルト値は、インスタンスの作成時にオーバーライドされる。タイプ X のインスタンスの場合、デフォルト DisplayName は「タイプ X のインスタンス」となる。 LanguageMap 属性を使用する場合には、DisplayName 値は LanguageMap のリソース バンドル内で名前を見つけるためのキーとして使われる。LanguageMap 属性を指定しない場合や、そのキーがリソース バンドルに存在しない場合には、DisplayName 値そのものがユーザ インタフェースに表示される。 「MessageID」を参照。 |
|||
値が true の場合、この MBean 属性は設定されると暗号化されることを示す。この属性を指定しない場合には、値が false であると仮定される。 |
|||
WebLogic MBeanMaker では、この属性は使用されない。ただし、これを使用する可能性のあるアプリケーションをサポートするために、WebLogic MBeanMaker では、この値を MBeanInfo オブジェクトに追加する。デフォルト値または仮定される値はない。 注意: Export 属性の詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
値が true の場合には、Type が array の MBean 属性はすべて、インデックス付きアクセスをサポートするための付加的な操作とインタフェース メソッドを生成できるようになる。値が false の場合には、すべての MBeanAttribute 下位要素が、付加的な操作とメソッドを生成できなくなる。この属性を指定しない場合には、値が true であると仮定される。 |
|||
MBean タイプのデフォルト属性処理ロジックをオーバーライドし、現在の MBeanAttribute 下位要素に使用すべきゲッター メソッドの名前を指定する。その値は、現在の MDF 内でゲッター操作を定義している MBeanOperation 下位要素の Name に一致する必要がある。 この属性を指定しない場合には、MBean ではデフォルト ロジックを用いて、MBean 属性の値を取得する。 注意: この属性は Readable 属性に左右される。つまり、Readable が false であれば、現在の MBeanAttribute 下位要素についてはゲッターは呼び出されない。 |
|||
WebLogic MBeanMaker で生成される MBean インタフェースの代わりに使用すべきインタフェースのクラス名。これは、現時点では無視されるが、今後の拡張で使用される可能性はある。 |
|||
生成される Java インタフェースでは MBean 属性のブール値にアクセスするのに JMX is<AttributeName> メソッド (get<AttributeName> メソッドではなく) が使用されるかどうかを指定する。この属性を指定しない場合には、値が false であると仮定される。 |
|||
集約属性タイプの場合、属性が反復をサポートするかどうか (つまり、アクセスされるたびに値をインクリメントできるかどうか) を示す。この属性を指定しない場合には、値が false であると仮定される。 WebLogic MBeanMaker では、この属性は使用されない。ただし、これを使用する可能性のあるアプリケーションをサポートするために、WebLogic MBeanMaker では、この値を MBeanInfo クラスに追加する。 注意: Iterable 属性の詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
表示可能な文字列のマップを格納したリソース バンドルの完全修飾パス名を指定する。他の属性 (たとえば DisplayMessage や DisplayName など) は、LanguageMap 内の文字列を用いて、MBean 属性に関する情報を表示する。 この属性を指定しない場合には、他の属性 (たとえば DisplayMessage や DisplayName など) は、自分自身の値を表示する (それらの値をキーに使ってリソース バンドル内の適切な文字列を検索するわけではない)。 |
|||
現在の MBeanAttribute 下位要素が null を値として取り得るかどうかを指定する。この属性を指定しない場合には、値が true であると仮定される。 |
|||
現在の MBeanAttribute 下位要素の取り得る値の固定集合を指定する。この属性を指定しない場合、MBean 属性では、Type 属性で指定されているタイプの任意の値を指定できる。 |
|||
通知リスナのスタブを MBean 実装オブジェクト内に生成する。この属性を指定しない場合には、値が false であると仮定される。 注意: リスナ スタブの詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
値が true の場合、MBean の通知をログ ファイルに追加するよう指定する (LogFile 属性は情報の出力先となるファイルを指定する)。この属性を指定しない場合には、値が false であると仮定され、通知はログ ファイルに追加されない。 注意: MBean 通知およびログの詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
この MBean 属性の通知が発生したときにメッセージが出力される既存の書き込み可能ファイルの完全修飾パス名。ロギングが行われるためには、Log 属性を true に設定しておく必要がある。この属性には、デフォルト値または仮定される値はない。 注意: MBean 通知およびログの詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
数値型の MBean 属性タイプに限り、属性の最大値 (その値を含む) を表す数値を指定する。この属性を指定しない場合には、値はデータ型の許容最大値まで可能。 注意: 最大値がコンテキストに応じて動的に変化する場合、または値の範囲の指定が複雑な場合 (たとえば、1-10 または >100)、代わりに Validator 属性を使用する。 |
|||
Java Management eXtensions 1.0 仕様に従ってクライアントサイド メッセージ リポジトリからメッセージを取得するためのキーを提供する。 MessageID と DisplayMessage のどちらか一方あるいは両方を用いて、通知 MBean タイプを記述することができる。この属性を指定しない場合には、メッセージ ID は利用できない。 注意: MessageID は、LanguageMap 属性で指定されるのと同じリソース バンドルを使用せず、通知 MBean タイプ専用である。 |
|||
数値型の MBean 属性タイプに限り、属性の最小値 (その値を含む) を表す数値を指定する。この属性を指定しない場合には、値はデータ型の許容最小値まで可能。 注意: 最小値がコンテキストに応じて動的に変化する場合、または値の範囲の指定が複雑な場合 (たとえば、1-10 または >100)、代わりに Validator 属性を使用する。 |
|||
値が true の場合には、WebLogic MBeanDumper ユーティリティで当該 MBean 属性はダンプされなくなる。 |
|||
WebLogic MBeanMaker では、この属性は使用されない。ただし、PersistLocation を使用する Model MBean をMBean が拡張するような場合をサポートするために、WebLogic MBeanMaker では、この属性値を MBeanInfo クラスに追加する。デフォルト値または仮定される値はない。 注意: PersistLocation および Model MBean の詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
WebLogic MBeanMaker では、この属性は使用されない。ただし、PersistName を使用する Model MBean をMBean が拡張するような場合をサポートするために、WebLogic MBeanMaker では、この属性値を MBeanInfo クラスに追加する。デフォルト値または仮定される値はない。 注意: PersistName および Model MBean の詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
OnTimer または NoMoreOftenThan の永続性ポリシーで使用される秒数を指定する。MBeanType または MBeanAttribute 要素でこの属性を指定しない場合には、値が 0 であると仮定される。 PersistPolicy が OnTimer に設定されている場合には、この秒数が経過したら属性が永続化される。一方、PersistPolicy が NoMoreOftenThan に設定されている場合には、指定された秒数以上の間隔を置いて永続化が行われるように制限される。 注意: MBeanType 要素内で指定された場合、この属性値は、個々の MBeanAttribute 下位要素内のあらゆる設定をオーバーライドする。 |
|||
MBeanType または MBeanAttribute 要素でこの属性を指定しない場合には、値が Never であると仮定される。 注意: MBeanType 要素内で指定された場合、この属性値は、個々の MBeanAttribute 下位要素内のあらゆる設定をオーバーライドする。 |
|||
ユーザ インタフェースで項目の表示に使用できる情報を提供する単一の XML ドキュメントの完全修飾パス名。この XML ドキュメントは、プレゼンテーション ロジックに関係のある付加的なメタデータも提供する。PresentationString のフォーマットは、XML/JMX に準拠した任意の情報である。 注意: 現在、BEA では専用のフォーマットを定義していないが、独自に定義するより待つことをお勧めする。PresentationString 属性は、将来使用するためのものである。 |
|||
Model MBean API を使用すれば、記述子の ProtocolMap フィールドを通じて、アプリケーションの Model MBean 属性を既存の管理データ モデルにマップできるようになる。属性の記述子の ProtocolMap フィールドには、Descriptor インタフェースを実装するクラスのインスタンスへの参照が記載されている必要がある。 注意: ProtocolMap および Model MBean の詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
MBean の属性値を MBean API を通じて読み込めるかどうかを決定する。MBeanType または MBeanAttribute 要素でこの属性を指定しない場合には、値が true であると仮定される。 |
|||
MBean タイプのデフォルト属性処理ロジックをオーバーライドし、現在の MBeanAttribute 下位要素に使用すべきセッター メソッドの名前を指定する。その値は、現在の MDF 内でセッター操作を定義している MBeanOperation 下位要素の Name に一致する必要がある。 この属性を指定しない場合には、MBean ではデフォルト ロジックを用いて、MBeanAttribute の値を設定する。 注意: この属性は Writeable 属性に左右される。つまり、Writable が false であれば、現在の MBeanAttribute 下位要素についてはセッターは呼び出されない。 |
|||
この属性のデータ型の完全修飾クラス名。これに対応するクラスがクラスパスに存在していなければならない。この属性を指定しない場合には、値が java.lang.String と仮定される。 |
|||
Validator 属性には、バリデータのロジックを実装するメソッドの名前を指定する。 このメソッドは、WebLogicMBeanMaker で生成されるクラスで宣言される。特定のバリデータを指定しない場合、WebLogic Server では、型の互換性と数値に関する範囲 (Min と Max で指定した範囲) を検証する基本的なチェックのみが行われる。 バリデータのインストールおよび使用は自動化されているので、バリデータ名を MDF に、バリデータ クラスをクラスパスにそれぞれ指定する以外のアクションは必要ない。 |
|||
MBean 属性の重要度を示す。ユーザ インタフェースではこの数値を用いて、特定のコンテキストで特定のユーザに当該 MBean 属性を表示するかどうかを決定する。この値が小さければ小さいほど、重要度は高くなる。1 から 4 までの数値を指定できる。この属性を指定しない場合には、値が 1 であると仮定される。 ユーザの関心の高いアイテムの場合には、Visibility に低い数値を指定する。たとえば、WebLogic Server Administration Console では、Visiblity 値が 1 の MBean が左ペインのナビゲーション ツリーに表示される。 |
|||
値が true の場合には、MBean API を通じて MBeanAttribute の値を設定できるようになる。MBeanType または MBeanAttribute でこの属性を指定しない場合には、値が true であると仮定される。 |
MBean タイプが発行できる通知タイプごとに、MBeanNotification 下位要素のインスタンス (管理イベントのブロードキャスト) を 1 つ記述する必要があります。MBeanNotification の形式は次のとおりです。
<MBeanNotification Name=string optional_attributes />
MBeanNotification 下位要素には Name 属性 (Java 通知のプログラム上の内部的な名前を指定するもの) および NotificationTypes のカンマ区切りのリストが含まれている必要があります (ユーザ インタフェースに表示される名前を指定するには、DisplayName 属性と LanguageMap 属性を使用します)。他の属性は省略可能です。
以下の例は、MBeanType 要素内の MBeanNotification 下位要素を簡略化して示したものです。
<MBeanType Name=“MyMBean” Package=”com.mycompany”>
<MBeanNotification Name="com.mycompany.myNotification"
NotificationTypes="1.1.1.1.2.3.5" />
</MBeanType>
表 A-3 では、MBeanNotification 下位要素で使用可能な属性について説明します。「JMX 仕様/BEA 拡張機能」カラムは、当該属性が JMX 仕様に対する BEA 拡張機能なのかどうかを示します。なお、BEA 拡張機能は他の J2EE Web サーバ上では動作しない可能性があることに注意してください。
MBeanNotification のクラス名 (Java Management eXtensions 1.0 仕様で定義されているもの)。たいていはデフォルト クラス名で問題ないが、必要であれば、この属性を用いて変更することができる。 |
|||
当該 MBean 通知が非推奨扱いになっていることを示す。この情報は生成された Java ソースに表示されると共に、管理アプリケーションでの使用を想定して ModelMBeanInfo オブジェクトにも格納される。この属性を指定しない場合には、値が false であると仮定される。 |
|||
当該 MBean 通知に関連付けられる任意の文字列で、生成されたクラスの Javadoc など、さまざまな場所に現れる。デフォルト値または仮定される値はない。 注意: ユーザ インタフェース内に表示される概要記述を指定するには、DisplayName、DisplayMessage、および PresentationString の各属性を使用する。 |
|||
ユーザ インタフェースに表示される MBean 通知の説明用メッセージ。デフォルト値または仮定される値はない。 DisplayMessage はツールのヒントやヘルプで用いられるパラグラフになる場合がある。MBean タイプに設定された DisplayMessage は、インスタンスの作成時に個々の MBean に対して別の値を指定しない限り、MBean インスタンスのデフォルトと見なされる。 |
|||
ユーザ インタフェースに表示される MBean 通知タイプ識別用の名前。デフォルト値または仮定される値はない。 LanguageMap 属性を使用する場合には、DisplayName 値は LanguageMap のリソース バンドル内で名前を見つけるためのキーとして使われる。LanguageMap 属性を指定しない場合や、そのキーがリソース バンドルに存在しない場合には、DisplayName 値そのものがユーザ インタフェースに表示される。 「MessageID」を参照。 |
|||
表示可能な文字列のマップを格納したリソース バンドルの完全修飾パス名を指定する。他の属性 (たとえば DisplayMessage や DisplayName など) は、LanguageMap 内の文字列を用いて、MBean 通知に関する情報を表示する。 この属性を指定しない場合には、他の属性 (たとえば DisplayMessage や DisplayName など) は、自分自身の値を表示する (それらの値をキーに使ってリソース バンドル内の適切な文字列を検索するわけではない)。 |
|||
通知リスナのスタブを MBean 実装オブジェクト内に生成する。この属性を指定しない場合には、値が false であると仮定される。 注意: リスナ スタブの詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
値が true の場合、MBean の通知をログ ファイルに追加するよう指定する (LogFile 属性は情報の出力先となるファイルを指定する)。この属性を指定しない場合には、値が false であると仮定され、通知はログ ファイルに追加されない。 注意: MBean 通知およびログの詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
この MBean 通知タイプの通知が発生したときにメッセージが出力される既存の書き込み可能ファイルの完全修飾パス名。ロギングが行われるためには、Log 属性を true に設定しておく必要がある。この属性には、デフォルト値または仮定される値はない。 注意: MBean 通知およびログの詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
Java Management eXtensions 1.0 仕様に従ってクライアントサイド メッセージ リポジトリからメッセージを取得するためのキーを提供する。 MessageID と DisplayMessage のどちらか一方あるいは両方を用いて、通知 MBean タイプを記述することができる。この属性を指定しない場合には、メッセージ ID は利用できない。 注意: MessageID は、LanguageMap 属性で指定されるのと同じリソース バンドルを使用せず、通知 MBean 専用である。 |
|||
汎用的な通知オブジェクトを特徴付ける通知タイプ。このリストは、ドットで区切られた任意の数のコンポーネントをカンマで区切って列挙したもので、通知タイプの命名において任意のユーザ定義構造を作ることが可能である。 注意: 通知タイプの詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
ユーザ インタフェースで項目の表示に使用できる情報を提供する単一の XML ドキュメントの完全修飾パス名。この XML ドキュメントは、プレゼンテーション ロジックに関係のある付加的なメタデータも提供する。PresentationString のフォーマットは、XML/JMX に準拠した任意の情報である。 注意: 現在、BEA では専用のフォーマットを定義していないが、独自に定義するより待つことをお勧めする。PresentationString 属性は、将来使用するためのものである。 |
|||
このタグの値は、数値でも、定義済みの文字列 (大文字/小文字の区別はない) でもかまわない。文字列を使用する場合、それは常に、MBeanInfo オブジェクトによって等価な数値に変換されて格納される。 |
|||
MBean 通知の重要度を示す。ユーザ インタフェースではこの数値を用いて、特定のコンテキストで特定のユーザに当該 MBean 通知を表示するかどうかを決定する。この値が小さければ小さいほど、重要度は高くなる。1 から 4 までの数値を指定できる。この属性を指定しない場合には、値が 1 であると仮定される。 ユーザの関心の高いアイテムの場合には、Visibility に低い数値を指定する。たとえば、WebLogic Server Administration Console では、Visiblity 値が 1 の MBean が左ペインのナビゲーション ツリーに表示される。 |
MBeanConstructor 下位要素は現在のところ、WebLogic MBeanMaker では使用されておらず、Java Management eXtensions 1.0 仕様に準拠し、上位互換性を保つためにサポートされているだけです。したがって、ここでは、MBeanConstructor 下位要素 (およびそれに関連する MBeanConstructorArg 下位要素) の属性の詳細については説明を省略します。
MBean タイプでサポートされている操作 (メソッド) ごとに、MBeanOperation 下位要素のインスタンスを 1 つ記述する必要があります。MBeanOperation の形式は次のとおりです。
<MBeanOperation Name=string optional_attributes >
<MBeanOperationArg Name=string optional_attributes />
</MBeanOperation>
MBeanOperation 下位要素には Name 属性が付いている必要があります。これは、その操作のプログラム上の内部的な名前を指定するものです (ユーザ インタフェースに表示される名前を指定するには、DisplayName 属性と LanguageMap 属性を使用します)。他の属性は省略可能です。
MBeanOperation 要素内には、その操作 (メソッド) で使用される引数ごとに MBeanOperationArg 下位要素のインスタンスを 1 つ記述する必要があります。MBeanOperationArg の形式は次のとおりです。
<MBeanOperationArg Name=string optional_attributes />
Name 属性には操作の名前を指定する必要があります。MBeanOperationArg のオプション属性は Type だけで、これは、特定タイプの Java 属性の動作を指定する Java クラス名を与えるものです。この属性を指定しない場合には、値が java.lang.String と仮定されます。
次の例は、MBeanType 要素内の MBeanOperation 下位要素と MBeanOperationArg 下位要素を簡略化して示したものです。
<MBeanType Name=“MyMBean” Package=”com.mycompany”>
<MBeanOperation
Name= "findParserSelectMBeanByKey"
ReturnType="XMLParserSelectRegistryEntryMBean"
Description="Given a public ID, system ID, or root element tag, returns the object name of the corresponding XMLParserSelectRegistryEntryMBean."
>
<MBeanOperationArg Name=”publicID” Type=”java.lang.String”/>
<MBeanOperationArg Name=”systemID” Type=”java.lang.String”/>
<MBeanOperationArg Name=”rootTag” Type=”java.lang.String”/>
</MBeanOperation>
</MBeanType>
表 A-4 では、MBeanOperation 下位要素で使用可能な属性について説明します。「JMX 仕様/BEA 拡張機能」カラムは、当該属性が JMX 仕様に対する BEA 拡張機能なのかどうかを示します。なお、BEA 拡張機能は他の J2EE Web サーバ上では動作しない可能性があることに注意してください。
キャッシュされた値が有効期限内にあるとみなされる許容時間 (秒数)。この時間が経過した後、値にアクセスしようとすると、再計算がトリガされる。 MBeanType 要素に指定すると、この値は MBean タイプのデフォルトと見なされる。同じ属性を MBean の MBeanAttribute または MBeanOperation 下位要素に設定すると、個々の MBean に関してオーバーライドできる。 |
|||
当該 MBean 操作が非推奨扱いになっていることを示す。この情報は生成された Java ソースに表示されると共に、管理アプリケーションでの使用を想定して ModelMBeanInfo オブジェクトにも格納される。この属性を指定しない場合には、値が false であると仮定される。 |
|||
当該 MBean 操作に関連付けられる任意の文字列で、生成されたクラスの Javadoc など、さまざまな場所に現れる。デフォルト値または仮定される値はない。 注意: ユーザ インタフェース内に表示される概要記述を指定するには、DisplayName、DisplayMessage、および PresentationString の各属性を使用する。 |
|||
ユーザ インタフェースに表示される MBean 操作の説明用メッセージ。デフォルト値または仮定される値はない。 DisplayMessage はツールのヒントやヘルプで用いられるパラグラフになる場合がある。MBean タイプに設定された DisplayMessage は、インスタンスの作成時に個々の MBean に対して別の値を指定しない限り、MBean インスタンスのデフォルトと見なされる。 |
|||
ユーザ インタフェースに表示される MBean 操作識別用の名前。デフォルト値または仮定される値はない。 LanguageMap 属性を使用する場合には、DisplayName 値は LanguageMap のリソース バンドル内で名前を見つけるためのキーとして使われる。LanguageMap 属性を指定しない場合や、そのキーがリソース バンドルに存在しない場合には、DisplayName 値そのものがユーザ インタフェースに表示される。 「MessageID」を参照。 |
|||
MBean 操作のうち、MBean で表される管理対象エンティティに対して操作が及ぼす影響を知らせる部分。 注意: 詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
表示可能な文字列のマップを格納したリソース バンドルの完全修飾パス名を指定する。他の属性 (たとえば DisplayMessage や DisplayName など) は、LanguageMap 内の文字列を用いて、MBean 操作に関する情報を表示する。 この属性を指定しない場合には、他の属性 (たとえば DisplayMessage や DisplayName など) は、自分自身の値を表示する (それらの値をキーに使ってリソース バンドル内の適切な文字列を検索するわけではない)。 |
|||
通知リスナのスタブを MBean 実装オブジェクト内に生成する。この属性を指定しない場合には、値が false であると仮定される。 注意: リスナ スタブの詳細については、Java Management eXtensions 1.0 仕様を参照のこと。 |
|||
Java Management eXtensions 1.0 仕様に従ってクライアントサイド メッセージ リポジトリからメッセージを取得するためのキーを提供する。 MessageID と DisplayMessage のどちらか一方あるいは両方を用いて、通知 MBean タイプを記述することができる。この属性を指定しない場合には、メッセージ ID は利用できない。 注意: MessageID は、LanguageMap 属性で指定されるのと同じリソース バンドルを使用せず、通知 MBean 専用である。 |
|||
ユーザ インタフェースで項目の表示に使用できる情報を提供する単一の XML ドキュメントの完全修飾パス名。この XML ドキュメントは、プレゼンテーション ロジックに関係のある付加的なメタデータも提供する。PresentationString のフォーマットは、XML/JMX に準拠した任意の情報である。 注意: 現在、BEA では専用のフォーマットを定義していないが、独自に定義するより待つことをお勧めする。PresentationString 属性は、将来使用するためのものである。 |
|||
当該操作から返される Java オブジェクトについて説明するテキスト。 これは、Javadoc または グラフィカル ユーザ インタフェースで使用することができる。 |
|||
MBean 操作の重要度を示す。ユーザ インタフェースではこの数値を用いて、特定のコンテキストで特定のユーザに当該 MBean 操作を表示するかどうかを決定する。この値が小さければ小さいほど、重要度は高くなる。1 から 4 までの数値を指定できる。この属性を指定しない場合には、値が 1 であると仮定される。 ユーザの関心の高いアイテムの場合には、Visibility に低い数値を指定する。たとえば、WebLogic Server Administration Console では、Visiblity 値が 1 の MBean が左ペインのナビゲーション ツリーに表示される。 |
表 A-5 では、MBeanOperationArg 下位要素で使用可能な属性について説明します。「JMX 仕様/BEA 拡張機能」カラムは、当該属性が JMX 仕様に対する BEA 拡張機能なのかどうかを示します。なお、BEA 拡張機能は他の J2EE Web サーバ上では動作しない可能性があることに注意してください。
リストA-1 とリストA-2 に、この付録で説明した属性の多くを使用した MBean 定義ファイル (MDF) の例を示します。リストA-1 には、述語を管理し、述語とそれらの引数に関するデータを読み取る MBean タイプを生成するための MDF を示します。リストA-2 には、WebLogic (デフォルト) 認証プロバイダの MBean タイプを生成するための MDF を示します。
コード リストA-1 PredicateEditor.xml
<?xml version="1.0" ?>
<!DOCTYPE MBeanType SYSTEM "commo.dtd">
<MBeanType
Name = "PredicateEditor"
Package = "weblogic.security.providers.authorization"
Implements = "weblogic.security.providers.authorization.PredicateReader"
PersistPolicy = "OnUpdate"
Abstract = "false"
Description = "This MBean manages predicates and reads data about predicates and their arguments.<p>"
>
<MBeanOperation
Name = "registerPredicate"
ReturnType = "void"
Description = "Registers a new predicate with the specified class name."
>
<MBeanOperationArg
Name = "predicateClassName"
Type = "java.lang.String"
Description = "The name of the Java class that implements the predicate."
/>
<MBeanException>weblogic.management.utils.InvalidPredicateException</MBeanException>
<MBeanException>weblogic.management.utils.AlreadyExistsException</MBeanException>
</MBeanOperation>
<MBeanOperation
Name = "unregisterPredicate"
ReturnType = "void"
Description = "Unregisters the currently registered predicate."
>
<MBeanOperationArg
Name = "predicateClassName"
Type = "java.lang.String"
Description = "The name of the Java class that implements predicate to be unregistered."
/>
<MBeanException>weblogic.management.utils.NotFoundException</MBeanException>
</MBeanOperation>
</MBeanType>
コード リストA-2 DefaultAuthorizer.xml
<?xml version="1.0" ?>
<!DOCTYPE MBeanType SYSTEM "commo.dtd">
<MBeanType
Name = "DefaultAuthorizer"
DisplayName = "DefaultAuthorizer"
Package = "weblogic.security.providers.authorization"
Extends = "weblogic.management.security.authorization.DeployableAuthorizer"
Implements = "weblogic.management.security.authorization.PolicyEditor, weblogic.security.providers.authorization.PredicateEditor"
PersistPolicy = "OnUpdate"
Description = "This MBean represents configuration attributes for the WebLogic Authorization provider. <p>"
>
<MBeanAttribute
Name = "ProviderClassName"
Type = "java.lang.String"
Writeable = "false"
Default = ""weblogic.security.providers.authorization.DefaultAuthorizationProviderImpl""
Description = "The name of the Java class used to load the WebLogic Authorization provider."
/>
<MBeanAttribute
Name = "Description"
Type = "java.lang.String"
Writeable = "false"
Default = ""Weblogic Default Authorization Provider""
Description = "A short description of the WebLogic Authorization provider."
/>
<MBeanAttribute
Name = "Version"
Type = "java.lang.String"
Writeable = "false"
Default = ""1.0""
Description = "The version of the WebLogic Authorization provider."
/>
</MBeanType>
![]() |
![]() |
![]() |
![]() |
||
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |