Java Desktop System Configuration Manager Release 1.1 開発者ガイド

ポリシーパッケージ形式

テンプレートは配布コンテナに埋め込まれます。これは JavaTM プログラミング言語の「パッケージ」に似ています。パッケージには、GUI ローカライズ用のリソースファイル、オンラインヘルプ用の HTML ファイル、独自のサポートファイルなど、オプションのファイルも含めることができます。

Configuration Manager はテンプレートや必要なオプションファイルにアクセスするために、特殊な形式のディレクトリ名とファイル名を使用しています。このディレクトリ名とファイル名の構造を 「ポリシーパッケージ形式」と呼びます。

ポリシーパッケージはすべて /usr/share/webconsole/apoc/packages ディレクトリ下の一意のサブディレクトリに格納されます。たとえば「Hello, world!」の場合は、HelloWorld を選択した結果、/usr/share/webconsole/apoc/packages/HelloWorld ディレクトリになります。


ヒント –

パッケージをインストールするソフトウェアの製品名と製品バージョンを使用してください。この方法で名前を付けると、パッケージディレクトリが他と重複することがありません。たとえば、HelloWorld よりも HelloWorld3.1 の方が適切な名前です。


特定のパッケージディレクトリ (packages ディレクトリと混乱しないようにしてください) の下に、以下のサブディレクトリを作成できます。

templates 

templates サブディレクトリには、ポリシーパッケージのテンプレートがすべて含まれていなければなりません。接尾辞が .xml のファイルはテンプレートと見なされます。ファイル名は page 要素の apt:name 属性の値と相関する必要があります。テンプレートは、そのカテゴリ階層で指定したのと同じディレクトリ階層にある限り、どのように分類してもかまいません。

classes 

classes サブディレクトリには、ポリシーパッケージのクラスファイルがすべて含まれていなければなりません。接尾辞が .class のファイルは Java クラスファイルと見なされます。ファイルの名前は、そのファイルで定義されているクラスの名前と相関する必要があります。ファイルは、そのパッケージ階層で指定したのと同じディレクトリ階層になければなりません。

web 

web サブディレクトリには、ポリシーパッケージの HTML ヘルプファイルすべてと、ポリシーパッケージが参照しているイメージが含まれていなければなりません。接尾辞が .html のファイルは HTML ファイルと見なされます。HTML ファイルの名前は、HTML ファイルを使用しているテンプレートの名前と相関付けてください。HTML ファイルは、HTML ファイルを使用しているテンプレートと同じディレクトリ階層に置きます。

res 

res サブディレクトリには、ポリシーパッケージのリソースファイルがすべて含まれていなければなりません。接尾辞が .properties のファイルは Java 対応のリソースファイルと見なされます。リソースファイルの名前とパスは、それを使用するテンプレートの名前とパスに相関付けることができます。また、リソースファイルを 1 つ含んだディレクトリ階層 1 つをすべてのテンプレートに指定することもできます。

lib 

lib サブディレクトリには、ポリシーパッケージのライブラリファイルがすべて含まれていなければなりません。接尾辞が .jar のファイルはライブラリと見なされます。ライブラリは Configuration Manager のクラスローダによって自動的に読み込まれます。ライブラリの内容にアクセスするには、 jar ファイルのルートディレクトリを絶対パスのルートディレクトリとして使用します。 ライブラリファイルの典型的な用途は、クラスファイルやリソースファイルのコンテナとしての役割、および通常は classes ディレクトリと res ディレクトリ内にあるディレクトリのコンテナとしての役割です。

その他のファイルタイプは Configuration Manager にとって特別な意味はありません。ただし、クラスファイルや HTML ファイルで必要になる場合は、classes ディレクトリまたは web ディレクトリに入れることができます。

図 2–2 では、完成した HelloWorld パッケージを使用してパッケージ形式をさらに詳しく説明しています。

図 2–2 HelloWorld パッケージ

HelloWorld パッケージ

パッケージの配布は、この章で先に定義したルールに従う限り、パッケージの開発者が自由に決めることができます。ファイル一式に正しい場所へのコピー手順を添えて配布したり、Zip ファイルを提供したり、SolarisTM の場合は pkg ファイル、Linux の場合は .rpm ファイルなど、オペレーティングシステムが提供する配布メカニズムを使用することもできます。それぞれのオペレーティングシステムが提供しているソフトウェアの保守と削除の機能を強化して、エンドユーザーによりよいサポートを提供できる最後の方法をお勧めします。