診断プロバイダーの登録済み属性と登録済みテスト

各診断プロバイダー (DP) は、状態ダンプ属性、構成ダンプ属性、自己診断テスト、および自己診断テスト属性のリストを提供します。これらのテストは、DP が実行できる操作です。属性は、構成ダンプ、状態ダンプ、または特定の自己診断テストから収集できる情報の一部です。

各属性は、ラベルが付いた情報の一部と見なすことができます。各属性はまた、登録済み または未登録 であると見なすことができます。登録済み属性とは、 WebSphere® Application Server のあるリリースから次のリリースまで使用可能な属性のことです。未登録属性は、現在の形式では製品の今後のリリースで使用できない場合があります (使用が確約されていません)。

構成ダンプ、状態ダンプ、または自己診断テストを実行する場合、管理者または自動ツールは登録済みのみの 値を要求することができる場合と、すべての 値を要求できる場合があります。これは、管理者またはツールのニーズに応じて決まります。結果をフィルタリングするオプションは、診断プロバイダーの Java™ Management Extension (JMX) MBean インターフェースを介してのみ使用可能であることに注意してください。このインターフェースには、プログラマチックにアクセスすることも、wsadmin ツールを介してアクセスすることもできます。

DiagnosticProviderRegistration XML ファイル

Extensible Markup Language (XML) ファイルの DiagnosticProviderRegistration は、各種メソッド呼び出しの結果をフィルタリングするためのメソッド・シグニチャーと、一緒に使用されます。この XML ファイルは、構成情報、状態情報、およびコンポーネントごとに公開される自己診断テストを定義します。構成情報と状態情報では、主要な作業単位は属性と呼ばれます。属性の指定は、次のとおりです。

<attribute>
        <id><Regular Expression representing the attribute name></id>
        <descriptionKey><MsgKey into a ResourceBundle for localization of the label></descriptionKey>
        <registered>true</registered>
   </attribute>

パーツは、以下のとおりです。

ID:

属性名。この名前は、正規表現構文に準拠したワイルドカード文字により表記できます。登録済み属性 ID は、次の場所で使用します。

診断プロバイダー構成ダンプおよび状態ダンプの各メソッド内で、どの属性を戻すかを判別します。
管理コンソール内で、構成ダンプ、状態ダンプ、または自己診断操作のために、診断プロバイダーへの要求から戻された属性に、記述子キーを突き合わせます。

例えば、構成ダンプが ID cachedServlet-MyServlet-servletPath の属性を管理コンソールに戻す場合、管理コンソールは、 < id>cachedServlet-. *-servletPath< /id> として登録されている属性に対応する descriptionKey を使用して、この属性の名前と戻り値の横に配置する説明テキストを選択することができます。

descriptionKey:

これは、ローカリゼーション用の resourceBundle のキーです。

registered

これは、この属性がソフトウェアのあるリリースから次のリリースに使用できるかどうかを限定するブール値です。登録済みが true であれば、この属性は次のリリースで使用可能です。登録済みが false である場合、この属性が存在し続けるという保証はありません。自動化の場合、非登録属性を処理する場合に多少の注意を払う必要があります。

selfDiagnosticTest の指定は次のとおりです。

<test>
       <id><Regular Expression for the name of the test></id>
       <descriptionKey><MsgKey into a ResourceBundle for localization of the label></descriptionKey>
       <attribute><One or more attributes which will be output from this test></attribute>
</test>

パーツは、以下のとおりです。

ID:: 属性の ID と類似していますが、この場合は、戻される属性ではなく、実行されるテストを記述しています。
descriptionKey:: これは、ローカリゼーション用の resourceBundle のキーです。

メソッド・インターフェース

public DiagnosticEvent [] configDump(String aAttributeId, boolean aRegisteredOnly);
public DiagnosticEvent [] stateDump(String aAttributeId, boolean aRegisteredOnly);

これらのメソッドは、コンポーネントの構成ダンプまたは状態ダンプを呼び出し、すべての一致する属性または登録されている属性のみを含む出力をフィルタリングすると同時に、戻す属性の正規表現のフィルターを指定します。これにより、メソッドを実行する管理者または自動化ソフトウェアは、全体のフィールドのサブセットを指定することができます (特に、多くの属性が公開されているか、状態収集仕様が使用可能なデータ量を増加させる場合に重要です)。次の helper メソッドは、出力のフィルタリングを支援するために使用できます。

戻すことのできる属性のリストを取得し、これらをフィルタリングするには、次のようにします。

    public static AttributeInfo [] queryMatchingDPInfoAttributes(String aAttributeId,
        AttributeInfo [] inAttrs, String [] namesToCheck, boolean aRegisteredOnly) {

戻すことのできる単一の属性を取得し、これをフィルタリングするには、次のようにします。

    public static AttributeInfo queryMatchingDPInfoAttributes(String aAttributeId,
        AttributeInfo [] inAttrs, String nameToCheck, boolean aRegisteredOnly) {

データを取り込んだ属性情報のセットに対して実行し、不要なパーツを除去するには、次のようにします。

    public static void filterEventPayload(String aAttributeId, HashMap payLoad) {

これらのメッセージの詳細については、DiagnosticProviderHelper クラスの API 資料を検討してください。基本的な概念は、戻すことのできる属性をコンポーネントが認識すると、helper メソッドは、それらの属性のどれを戻す必要があるかを正規表現ロジックおよび登録ブール値に基づいて判別する、ということです。

次のように、ここの selfDiagnostic メソッド・インターフェースは、Configdump および Statedump のインターフェースと類似しています。

public DiagnosticEvent[] selfDiagnostic(String aTestId, boolean aRegisteredOnly)

違いは、最初のパラメーターが、テストを行う対象の正規表現フィルターであるところです。