インターナショナライゼーション ガイド
|
 |
 |
|
以下の節では、メッセージ カタログとその使い方について説明します。
メッセージ カタログは、テキスト メッセージのコレクションが格納される単一の XML ファイルです。各メッセージには、ユニークな識別子が付けられます。これらの XML ファイルを、weblogic.i18ngen ユーティリティのビルド プロセスでクラスにコンパイルします (詳細については、「weblogic.i18ngen ユーティリティ」を参照してください)。生成されたクラスのメソッドは、実行時にメッセージをログに記録するために使用されるオブジェクトとなります。
メッセージ カタログでは、複数のロケールまたは言語がサポートされています。特定のメッセージ カタログには、最上位カタログというデフォルト バージョンが必ず 1 つあり、英語版のメッセージが含まれます。さらに、追加してサポートされるロケールごとに、対応するロケール固有のカタログが付加されます。
最上位カタログ (英語版) には、メッセージの定義に必要な情報がすべて含まれます。ロケール固有のカタログには、メッセージ ID、変更された日付、および特定ロケールに対応するメッセージの変換だけが含まれます。
メッセージ カタログ ファイルは、XML DTD (Document Type Definition : 文書型定義) によって定義されます。この DTD は、WL_HOME/server/lib/weblogic.jar の weblogic/msgcat ディレクトリに格納されます。
DTD は、http://www.bea.com/servers/wls810/dtd/msgcat.dtd からダウンロードすることもできます。
WebLogic Server 配布キットには、以下の 2 つの DTD が付属しています。
WL_HOME/server/lib/weblogic.jar の weblogic/msgcat ディレクトリには、最上位のメッセージ カタログおよびロケール固有のメッセージ カタログ作成に使用できるテンプレートが入っています。
メッセージ カタログの作成では、ロギングのすべての必要条件に対応するログ メッセージ カタログを 1 つ作成したり、サブシステムまたは Java パッケージごとに細かく分けてカタログを作成することもできます。複数のサブシステムを使用すると、表示するときにそのログの特定の部分に焦点を当てることができるので、この方法をお勧めします。
シンプル テキストのカタログの場合は、インターナショナライズされるユーティリティごとに 1 つのカタログを作成することをお勧めします。「BEA WebLogic Server メッセージ エディタの使い方」の説明に従い、メッセージ エディタを使用してメッセージ カタログを作成します。
すべてのメッセージは、デフォルトの最上位カタログで定義する必要があります。WebLogic Server 配布キットには、SAMPLES_HOME/server/examples/i18n/msgcat/ ディレクトリにサンプル カタログが付属しています。
注意 : このディレクトリ パスは、WebLogic Server のインストール先によって異なる場合があります。
基本カタログのさまざまなローカライゼーションを提供するカタログは、ロケールに基づいた名前が付いた msgcat のサブディレクトリ (ドイツ語の場合は msgcat/de など) に定義されています。たとえば、mycat.xml という最上位カタログと ..de/mycat.xml というそのドイツ語版のカタログがあります。通常、最上位カタログは英語です。ただし、SAMPLES_HOME/server/examples/i18n/msgcat/ ディレクトリ内のもの以外では、どのカタログの場合も英語は必須ではありません。
java.util.Locale のドキュメントで定義されているように、ロケールの指定 (de など) にも階層があります。ロケールでは言語、国、およびバリアントを指定できます。言語は、ロケール指定でもっとも一般的なものです。 言語は国コードによって拡張できます。たとえば、en/US はアメリカ英語を示します。これに関連付けられたカタログの名前は、..en/US/mycat.xml となります。バリアントはベンダまたはブラウザに固有であり、言語または国で定義された複数のロケールの間で細かな違い (照合順序など) を持たせるために使用します。
メッセージ カタログ ファイルの名前 (.xml 拡張子を除く) は、実行時クラスおよびプロパティ名の生成に使用されるため、命名は慎重に行ってください。
メッセージ カタログに名前を付ける場合、以下のガイドラインに従ってください。
たとえば、カタログの名前が Xyz.xml の場合、生成されるクラス名は XyzLogLocalizer および XyzLogger になります。
以下の考慮事項も、メッセージ カタログ ファイルに適用されます。
注意 : これは、ログ メッセージ カタログにのみ適用されます。シンプル テキスト カタログは任意の文字列をとることができます。
ResourceBundle プロパティ ファイルです。
ログ メッセージのメッセージ本文、メッセージ詳細、原因、およびアクションなどのセクションには、java.text.MessageFormat に記載されているようなメッセージ引数を組み込むことができます。シンプル メッセージでは、引数を入れられるのは、メッセージ本文のセクションに限られます。引数は、実行時に動的に設定される値を表します。これらの値は、メッセージを出力するなどのルーチンに渡されます。1 つのメッセージには 0 ～ 9 で番号付けされた 10 個までの引数をサポートできます。メッセージ本文にはすべての引数を入れる必要がありますが、メッセージ定義 (メッセージ本文、メッセージ詳細、妥当な原因) の任意のテキスト セクションにもこれらの引数の任意のサブセットを入れることができます。メッセージ引数は開発時にメッセージ定義に挿入され、実行時においてメッセージがログに記録されるときに適切なメッセージ コンテンツに置き換えられます。
以下は、XML ログ メッセージ定義の抜粋で、メッセージ引数の使い方を示しています。引数の番号は、method 属性で指定された引数の 1 つと対応している必要があります。具体的には、{0} は最初の引数と、{1} は 2 番目の引数と対応している必要があります。コード リスト 2-1 では、{0} は開けないファイルを表し、{1} は適切に開かれるファイルを表します。
<messagebody>Unable to open file, {0}. Opening {1}. All arguments must
be in body.</messagebody>
<messagedetail> File, {0} does not exist. The server will
restore the file contents from {1}, resulting in the use of
default values for all future requests. </messagedetail>
<cause>The file was deleted</cause>
<action>If this error repeats then investigate unauthorized
access to the file system.</action>
-method="logNoFile(Stringname, Stringpath)"
コード リスト 2-1 のメッセージの例では、2 つの引数 {0} および {1} が使用されています。
<cause> または <action> では使用されていません。注意 : 1 つのメッセージには 0 ～ 9 で番号付けされた 10 個までの引数をサポートできます。メッセージ本文にはすべての引数を入れる必要がありますが、メッセージ定義 (メッセージ本文、メッセージ詳細、原因、アクション) の任意のテキスト セクションにもこれらの引数の任意のサブセットを入れることができます。
また、引数は文字列であるか、文字列として表現可能である必要があります。数値データは {n,number} として表されます。日付は {n,date} としてサポートされます。また、ログ メッセージでは重大度レベルを割り当てる必要があります。ログ メッセージは、Logger メソッドによって method 属性で定義されているとおりに生成されます。
最上位のカタログ ファイルとロケール固有のカタログ ファイルでは、カタログのフォーマットが若干異なります。最上位カタログでは、基本ロケール (デフォルトでは、英語) のテキスト メッセージが定義されます。ロケール固有のカタログ (スペイン語に翻訳されたカタログなど) は、最上位バージョンで定義されているテキストの翻訳だけを備えています。さらに、ログ メッセージ カタログではシンプル テキスト カタログと定義の方法が異なります。
各タイプのメッセージ カタログの例および要素は、以下の節で説明されています。
次の例は、ログ メッセージを 1 つ持つログ メッセージ カタログ MyUtilLog.xml を示しています。このログ メッセージは、messagebody、messagedetail、cause、および action の各要素の使用方法を示しています。
<?xml version="1.0"?>
<!DOCTYPE message_catalog PUBLIC "weblogic-message-catalog-dtd" "http://www.bea.com/servers/wls810/dtd/msgcat.dtd.">
<message_catalog
l10n_package="programs.utils"
i18n_package="programs.utils"
subsystem="MYUTIL"
version="1.0"
baseid="600000"
endid="600100"
<log_message
messageid="600001"
severity="warning"
method="logNoAuthorization(String arg0, java.util.Date arg1,
int arg2)"
<messagebody>
Could not open file, {0} on {1,date} after {2,number} attempts.
</messagebody>
<messagedetail>
The configuration for this application will be defaulted to
factory settings. Custom configuration information resides
in file, {0}, created on {1,date}, but is not readable.
</messagedetail>
<cause>
The user is not authorized to use custom configurations. Custom
configuration information resides in file, {0}, created on
{1,date}, but is not readable.The attempt has been logged to
the security log.
</cause>
<action>
The user needs to gain approriate authorization or learn to
live with the default settings.
</action>
</log_message>
</message_catalog>
この節では、ログ メッセージ カタログの以下の要素に関するリファレンス情報を提供します。
message_catalog 要素は、ログ メッセージ カタログを表します。次の表では、message_catalog 要素で定義できる各属性について説明します。
次の表では、log_message 要素で定義できる各属性について説明します。
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
次の表では、log_message 要素の子要素を説明します。
次の例は、1 つのシンプル テキスト定義を備えるシンプル テキスト カタログ MyUtilLabels.xml を示しています。
<messagebody>
File
</messagebody>
<?xml version="1.0"?>
<!DOCTYPE message_catalog PUBLIC "weblogic-message-catalog-dtd"
"http://www.bea.com/servers/wls810/dtd/msgcat.dtd.">
<message_catalog>
l10n_package="programs.utils"
i18n_package="programs.utils"
subsystem="MYUTIL"
version="1.0"
<message>
messageid="FileMenuTitle"
<messagebody>
File
</messagebody>
</message>
</message_catalog>
この節では、シンプル テキスト カタログの以下の要素に関するリファレンス情報を提供します。
次の表では、message_catalog 要素で定義できる各属性について説明します。
次の表では、message 要素で定義できる各属性について説明します。
次の例は、...\msgcat\fr\MyUtilLabels.xml にあるメッセージのフランス語版です。
翻訳されたメッセージをコード リスト 2-4 に示します。
コード リスト 2-4 フランス語に翻訳されたメッセージの例
<?xml version="1.0"?>
<!DOCTYPE message_catalog PUBLIC
"weblogic-locale-message-catalog-dtd"
"http://www.bea.com/servers/wls810/dtd/l10n_msgcat.dtd.">
<locale_message_catalog
l10n_package="programs.utils"
subsystem="MYUTIL"
version="1.0">
<message>
<messageid="FileMenuTitle">
<messagebody> Fichier </messagebody>
</message>
</locale_message_catalog>
messagebody、messagedetail、cause、および action の各要素でテキストを入力するときには、有効な UTF-8 (Unicode Transformation Format-8) 文字を生成するツールを使用するとともに、適切なキーボードのマッピングがインストールされている必要があります。UTF-8 は、ASCII 文字のエンコーディングを最適化する、効率的な Unicode 文字列エンコーディング方式です。メッセージ カタログでは常に UTF-8 エンコーディング方式が使用されます。WebLogic Server と共にダウンロードされる MessageLocalizer ユーティリティは、有効な UTF-8 文字の生成に使用できるツールです。
ロケール固有のカタログは、最上位カタログのサブセットです。ロケール固有のカタログは、それらが表すロケールに基づいた名前のサブディレクトリに格納されます。以下の節で説明する要素および属性は、ロケール固有のカタログに有効なものです。
次の表では、locale_message_catalog 要素で定義できる各属性について説明します。
ロケール固有のカタログでは、最上位のログ メッセージ カタログの log_message 要素で定義された属性が使用されるため、この要素は改めて定義する必要はありません。
ロケール固有のカタログでは、最上位のログ メッセージ カタログで定義された messagebody、messagedetail、cause、および action の各カタログ要素を使用するため、これらの要素を改めて定義する必要はありません。
|
|
|