C レポート・グループ構成リファレンス

この付録では、レポート・グループ・デプロイメント・ディスクリプタの要素のリファレンスと、ディスクリプタの簡単な概要を示します。個々のレポート・ファイルの作成に使用するレポート・ファイル・デプロイメント・ディスクリプタ要素の詳細は、付録B「レポート・ファイル構成リファレンス」を参照してください。

この付録は、次の各項で構成されています。

レポート・グループ構成デプロイメント・ディスクリプタ
要素リファレンス

C.1 レポート・グループ構成デプロイメント・ディスクリプタ

レポート・グループ・デプロイメント・ディスクリプタでは、Coherence JMXレポータの実行時に作成される個別レポートの数が任意に指定されます。2つの事前定義されたディスクリプタが/reportsディレクトリ内のcoherence.jarファイルに置かれています。このデフォルトのディスクリプタはreport-group.xmlと呼ばれ、事前定義されたレポートのサブセットが含まれています。report-all.xmlディスクリプタには、すべての事前定義済レポートが含まれます。レポート・グループ・デプロイメント・ディスクリプタは事前定義されたものを必要に応じて変更するか、または新しいレポート・グループ・デプロイメント・ディスクリプタを作成できます。実行時に使用するレポート・グループ・デプロイメント・ディスクリプタの名前と場所はオペレーション・デプロイメント・ディスクリプタで構成され、オペレーション・オーバーライド・ファイルでオーバーライドできます。詳細は、第4章「JMXレポーティングの使用」を参照してください。

レポート・ファイル・デプロイメント・ディスクリプタ・スキーマは、coherence-report-group-config.xsdファイルで定義されます。このファイルは、coherence.jarライブラリのルートおよび次のWeb URLにあります。

http://xmlns.oracle.com/coherence/coherence-report-group/1.0/coherence-report-group.xsd

<report-group>要素はディスクリプタのルート要素であり、通常はXSDリファレンス、Coherenceネームスペース・リファレンス、およびcoherence-report-group-config.xsdファイルの場所が含まれます。次に例を示します。

<?xml version='1.0'?>
<report-group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://xmlns.oracle.com/coherence/coherence-report-group-config"
   xsi:schemaLocation="http://xmlns.oracle.com/coherence/
   coherence-report-group-config coherence-report-group-config.xsd">

注意:

xsi:schemaLocation属性でWeb URLを参照した場合でも、coherence.jarライブラリにあるスキーマは必ず実行時に使用されます。
xsi:schemaLocation属性を省略してスキーマ検証を無効にできます。
デフォルトのキャラクタ・セットがASCIIではなくEBCDICである環境にCoherenceをデプロイする場合、このデプロイメント・ディスクリプタ・ファイルがASCII形式であり、ランタイム環境にバイナリ形式でデプロイされることを確認してください。

要素リファレンス

表C-1は、レポート・グループ・デプロイメント・ディスクリプタのすべての非終端要素を示しています。

表C-1 レポート・グループ・デプロイメント・ディスクリプタの非終端要素

要素	使用場所
init-param	init-params
init-params	report-config
report-config	report-group
report-group	ルート要素
report-list	report-group

init-param

使用場所: init-params

説明

init-param要素には、レポートの初期化パラメータを記述します。このパラメータは、パラメータ名(またはパラメータ・タイプ)とその値で構成されます。

要素

表C-2は、init-param要素のサブ要素を示しています。

表C-2 init-paramのサブ要素

要素必須/
オプション説明

要素	必須/ オプション	説明
`param-name`	オプション	初期化パラメータの名前を指定します。この要素は、`param-type`要素と一緒には使用できません。
`param-type`	オプション	初期化パラメータのJavaタイプを指定します。サポートされているタイプは次のとおりです。 `string`: 値が`java.lang.String`であることを示します。 `long`: 値が`java.lang.Long`であることを示します。 `double`: 値が`java.lang.Double`であることを示します。この要素は、`para-name`要素と一緒には使用できません。
`param-value`	必須	初期化パラメータの値を指定します。この値は、パラメータの型に固有の形式にします。

param-name

オプション

初期化パラメータの名前を指定します。

この要素は、param-type要素と一緒には使用できません。

param-type

オプション

初期化パラメータのJavaタイプを指定します。サポートされているタイプは次のとおりです。

string: 値がjava.lang.Stringであることを示します。
long: 値がjava.lang.Longであることを示します。
double: 値がjava.lang.Doubleであることを示します。

この要素は、para-name要素と一緒には使用できません。

param-value

必須

初期化パラメータの値を指定します。この値は、パラメータの型に固有の形式にします。

init-params

使用場所: report-config

説明

init-params要素には、初期化パラメータのリストを記述します。

要素

表C-2は、init-params要素のサブ要素を示しています。

表C-3 init-paramsのサブ要素

要素	必須/ オプション	説明
`init-param`	オプション	レポートの初期化パラメータを指定します。

report-config

使用場所: report-group

説明

report-configには、レポートの構成ファイル名および初期化パラメータを記述します。

要素

表C-4は、report-config要素のサブ要素を示しています。

表C-4 report-configのサブ要素

要素	必須/ オプション	説明
`location`	必須	`coherence-report-config.xsd`ファイルに準拠するレポート構成ディスクリプタへのパスを指定します。このパスは、ファイルまたはURLのいずれかになる場合もあります。
`init-params`	オプション	初期化パラメータのリストを指定します。

report-group

使用場所: ルート要素

説明

report-group要素には、レポート・リスト、実行間隔、レポート・パラメータおよびバッチの出力ディレクトリを記述します。

要素

表C-5は、report-group要素のサブ要素を示しています。

表C-5 report-groupのサブ要素

要素	必須/ オプション	説明
`frequency`	必須	レポート・バッチの実行間隔の分数または秒数を指定する文字列です。10sと指定すると、レポートは10秒ごとに実行されます。5mと指定すると、レポートは5分ごとに実行されます。実行間隔には適切な値を選択することが重要です。実行間隔が短かすぎると、レポータは膨大な量のデータを生成し、ディスク領域が著しく消費される可能性があります。実行間隔が長すぎると、十分な情報が生成されません。レポータを構成する前に、履歴情報の消去とアーカイブのプロセスを適正化することをお薦めします。
`output-directory`	オプション	レポート構成ファイルの出力ファイル名の先頭に付加するディレクトリ・パスです。メンバーが実行されているユーザー名には、このパスへの読取り/書込みアクセスを可能にしておく必要があります。
`report-list`	必須	レポート構成のリストを指定します。

report-list

使用場所: report-group

説明

report-list要素には、バッチに含めるレポートのリストを記述します。

要素

表C-6は、report-list要素のサブ要素を示しています。

表C-6 report-listのサブ要素

要素	必須/ オプション	説明
`report-config`	必須	レポートを構成する場所と対応する初期化パラメータです。