| Oracle® Fusion Middleware Oracle WebLogic Server アプリケーション ロギングのロギング サービス ユーザーズ ガイド 11g リリース 1 (10.3.1) B55513-01 |
|
 戻る |
 次へ |
| Oracle® Fusion Middleware Oracle WebLogic Server アプリケーション ロギングのロギング サービス ユーザーズ ガイド 11g リリース 1 (10.3.1) B55513-01 |
|
戻る |
次へ |
以下の節では、メッセージ エディタの使用方法について説明します。
メッセージ エディタは、XML メッセージ カタログの作成、読み込み、および書き込みに使用するグラフィカル インタフェース ツールです。メッセージ エディタは、WebLogic Server のインストール時にインストールされます。必要に応じて、XML カタログはテキスト エディタまたは任意の XML 編集ツールで編集することもできます。
|
注意 : WebLogic Server には独自のメッセージ カタログがあり、WebLogic Server のサブシステムおよび機能に関連するメッセージがすべて含まれます。これらのカタログは、編集できません。WebLogic Server のカタログの詳細については、『Oracle Fusion Middleware Oracle WebLogic Server メッセージ カタログ』の「WebLogic Server メッセージ カタログ」を参照してください。 |
メッセージ エディタで可能な作業は以下のとおりです。
XML メッセージ カタログを作成する
メッセージを作成および編集する
1 つのカタログのすべてのメッセージを表示する
複数のカタログのメッセージを同時に表示する
メッセージを検索する
カタログ エントリで XML の有効性を検証する
メッセージを廃止、および復帰する
|
注意 : メッセージ エディタは、ローカライズされたカタログの編集はサポートしていません。 |
メッセージ エディタを起動する前に、WebLogic Server システムのインストールとコンフィグレーションを行い、環境変数 SAMPLES_HOME\domains\wl_server\setExamplesEnv.cmd を設定します。SAMPLES_HOME は WebLogic Server のサンプル ホーム ディレクトリ (WL_HOME\samples) を示します。また、クラスパスの設定が正しいことを確認してください。このトピックの詳細については、『Oracle Fusion Middleware Oracle WebLogic Server インストール ガイド』を参照してください。
サンプルのメッセージ カタログ ファイルは、SAMPLES_HOME/server/examples/src/examples/i18n/msgcat ディレクトリにあります。
|
注意 : SAMPLES_HOME ディレクトリの場所は、WebLogic Server のインストール先によって異なる場合があります。 |
このサンプルのメッセージ カタログをテンプレートとして使用し、独自のメッセージを作成できます。パッケージ名、クラス名などの与えられた情報を変更するだけです。次に、メッセージ テキストを翻訳し、カタログを保存します。このトピックの詳細については、「WebLogic Server ログへのメッセージの書き込み」を参照してください。
メッセージ エディタを起動するには、次のように入力します。
java weblogic.MsgEditor
または
java weblogic.i18ntools.gui.MessageEditor
基本的なコマンドライン ヘルプにアクセスするには、次のコマンドを入力します。
java weblogic.MsgEditor -help
ログ メッセージ用の WebLogic メッセージ エディタのメイン ウィンドウが図 6-1 のように表示されます。
以下の節では、メッセージ エディタをカタログ管理に使用する方法について説明します。
WebLogic メッセージ エディタのメイン ウィンドウから、既存のカタログを検索するには、[メッセージ カタログ] フィールドに絶対パス名を入力するか、[参照] をクリックして [開く] ダイアログから既存のカタログに移動します。
WebLogic Server のインストールに付属しているサンプル カタログは、SAMPLES_HOME/server/examples/src/examples/i18n/msgcat ディレクトリにあります。
|
注意 : ディレクトリ パスは、WebLogic Server のインストール先によって異なる場合があります。 |
ユーザ定義のカタログは、任意のディレクトリを指定して配置できます。
カタログの場所を指定すると、[パッケージ]、[サブシステム]、[バージョン]、および [開始 ID] と [終了 ID] (ある場合) が表示され、その表示されたカタログが、他のすべてのアクションが実行されるコンテキスト カタログになります。
この時点で、カタログでは、新しいメッセージの入力、既存のメッセージの編集、メッセージの検索、またはすべてのメッセージの表示を行うことができます。
[メッセージ カタログ] フィールドで、ログ メッセージ カタログを選択した場合、図 6-3 に示されているようなログ メッセージ用の WebLogic メッセージ エディタ ウィンドウが表示されます。
[メッセージ カタログ] フィールドで、シンプル メッセージ カタログを選択した場合、図 6-4 に示されているようなシンプル メッセージ用の WebLogic メッセージ エディタ ウィンドウが表示されます。
新規カタログを作成するには、次の手順に従います。
WebLogic メッセージ エディタ ウィンドウのメイン メニュー バーから [ファイル｜新しいカタログの開始] を選択します。
図 6-5 に示すように、[新しいカタログを作成] ダイアログが表示されます。
[メッセージ カタログ] フィールドに、新規カタログ (拡張子 xml を含むファイル) の絶対パス名と名前を入力します。または、[参照] をクリックして、適切なカタログ ディレクトリに移動します (WebLogic Server のサンプル メッセージを使用している場合は、msgcat ディレクトリに移動します)。
[カタログ タイプ] ドロップダウン リストを使用して、作成するカタログが、ログ メッセージ (Log messages) カタログ、シンプル テキスト メッセージ (Simple messages) カタログのどちらになるのかを指定します。
ログ メッセージ カタログを選択した場合は、[開始 ID] および [終了 ID] フィールドが表示されます。この 2 つのフィールドは、カタログ内のメッセージに使用する ID 番号の範囲を指定するものです。シンプル テキスト メッセージ カタログを選択した場合は、これらのフィールドは表示されません。
生成された Logger クラスを入れるパッケージの名前を [I18n パッケージ] フィールドに入力します。
デフォルト値は weblogic.i18n です。Logger クラスをアプリケーションと共に別のパッケージに入れたい場合は、ここでそのパッケージ名を指定します。
カタログ データを入れるパッケージの名前を [L10n パッケージ] フィールドに入力します。
デフォルト値は weblogic.l10n です。カタログ データをアプリケーションと共に別のパッケージに入れる場合は、ここでそのパッケージ名を指定します。
|
注意 : ほとんどの場合は、メッセージのクラス ファイルとプロパティ ファイルはアプリケーションと同じパッケージ階層に配置することをお勧めします。メッセージのクラスとプロパティをアプリケーションのパッケージ階層に含めない場合は、クラスが必ずアプリケーションのクラスパスに存在するようにする必要があります。 |
[サブシステム] フィールドに、メッセージをログに記録するシステムの部分を示す名前を入力します。
この名前がメッセージと共にログに書き込まれます。アプリケーションの場合、通常、[サブシステム] フィールドにはそのアプリケーション名が入ります。
[プレフィックス] フィールドに、ログに記録されるときにメッセージ ID の先頭に追加するプレフィックスを入力します。
デフォルトのサーバ メッセージのプレフィックスは、BEA です。ユーザ メッセージに、任意のプレフィックスを入力できます (プレフィックスは、10 文字未満にすることをお勧めします。また、標準的な Java 命名規約を使用してください)。
[カタログを作成] をクリックします。
[新しいカタログを作成] ダイアログが閉じ、今作成したカタログが、メッセージ エディタのウィンドウにコンテキスト カタログとして表示されます。
以下の節では、メッセージ エディタを使用してカタログにメッセージを追加する方法について説明します。
ログ カタログに新規メッセージを入力するには、以下の手順に従います。
WebLogic メッセージ エディタのメイン ダイアログ (図 6-6) で、[メッセージ カタログ] フィールドに絶対パス名を入力するか、[参照] をクリックして既存のカタログに移動します。
[次の ID を取得] ボタンをクリックして、コンテキスト カタログ内でユニークな次の ID を生成します。
ID は、[メッセージ ID] フィールドに表示されます。
メッセージに関連するコメントを、[コメント] フィールドに入力します。
括弧と引数も含めて、ログ メッセージに使用する適切なメソッドを入力します。例 : logErrorSavingTimestamps(Exception ioExcep)
ログ メッセージのメソッド タイプを設定します。
選択肢は logger または getter です。デフォルトのメソッド タイプは logger で、ログとして記録されるメッセージに使用します。getter は、例外など、ログとして記録しないメッセージに使用する場合に選択します。
リストから [重大度] を選択します。
[メッセージ本文] にテキストを入力します。
パラメータは {n} で示します。例 : "Exception occurred while loading _WL_TIMESTAMP FILE."
[メッセージ詳細] にテキストを入力します。
パラメータは {n} で示します。例 : "Exception occurred while loading _WL_TIMESTAMP FILE.Forcing recompilation: {0}."
[妥当な原因] にテキストを入力します。
パラメータは {n} で示します。例 : "There was an error reading this file."
[アクション] にテキストを入力します。
パラメータは {n} で示します。例 : "No action required."
[スタックトレースを表示] オプションを、チェック ボックスをチェックするか、チェックをはずして、切り替えます。
このオプションは、Logger メソッドが例外を引数として取る場合に、メッセージと共にスタックトレースを出力するときに使用します。
[廃止されたメッセージ] オプションを、チェック ボックスをチェックするか、チェックをはずして、切り替えます。
使用しなくなったメッセージを廃止 (非表示に) するには、このオプションを使用します。廃止されたメッセージは、生成されたクラスに表示されないという観点では削除されます。ただし、メッセージ データは .xml ファイルに残ります。
[追加] をクリックします。
メッセージが追加されると、カタログ全体が直ちにディスクに書き込まれます。
シンプル メッセージ カタログにシンプル テキスト メッセージを入力するには、次の手順に従います。
WebLogic メッセージ エディタのメイン ダイアログで、[メッセージ カタログ] フィールドに絶対パス名を入力するか、[参照] をクリックして既存のカタログに移動します。
図 6-7 に示されているようなシンプル メッセージ用の WebLogic メッセージ エディタのダイアログが表示されます。
ユニークな英数字のメッセージ ID を入力します。
必要に応じて、コメントを入力します。
括弧と引数も含めて、シンプル メッセージに使用する適切なメソッドを入力します。例 : startingClusterService()
メッセージ本文を入力します。例 : startingClusterService
[追加] をクリックします。
メッセージが追加されると、カタログ全体が直ちにディスクに書き込まれます。
以下の節では、メッセージ エディタをメッセージ検索に使用する方法について説明します。
ログ メッセージを検索するには、次の手順に従います。
コンテキスト カタログがログ メッセージ カタログであること、図 6-3 に示されているように WebLogic メッセージ エディタのログ メッセージのウィンドウが表示されていることを確認します。
メイン メニュー バーから [編集] を選択します。
[検索] を選択して、図 6-8 に示すような [ログ メッセージを検索] ダイアログを表示します。
メッセージ ID およびメソッド名を入力します。
[メッセージ テキスト検索] フィールドに、求めるメッセージの検索データを必要なだけ入力します。
テキストの検索では、テキスト フィールドに入力されたすべての内容について部分一致検索が行われます。
[先頭から検索] または [次を検索] をクリックします。
メッセージの検索は、フィールドの情報をつなぎ合わせて実行されます。一致するメッセージが見つかると、図 6-1 に示されているように、そのメッセージがメッセージ エディタのウィンドウに表示されます。
シンプル テキスト メッセージを検索するには、次の手順に従います。
コンテキスト カタログがシンプル テキスト メッセージ カタログであること、図 6-4 に示されているように WebLogic メッセージ エディタのシンプル メッセージのウィンドウが表示されていることを確認します。
メイン メニュー バーから [編集] を選択します。
[検索] を選択して、図 6-9 に示すような [シンプル メッセージを検索] ダイアログを表示します。
メッセージ ID を入力します。
[メッセージ テキスト検索] フィールドに、求めるメッセージの検索データを必要なだけ入力します。
テキストの検索では、テキスト フィールドに入力されたすべての内容について部分一致検索が行われます。
[先頭から検索] または [次を検索] をクリックします。
メッセージの検索は、フィールドの情報をつなぎ合わせて実行されます。一致するメッセージが見つかると、図 6-4 に示されているように、そのメッセージがメッセージ エディタのウィンドウに表示されます。
WebLogic メッセージ エディタには、メッセージ ビューアが付属しており、このビューアを使えば、1 つのカタログ内の全メッセージおよび複数のカタログ内の全メッセージを表示すること、さらに任意のメッセージを選択して編集することができます。
以下の節では、メッセージ ビューアを使用して、メッセージを表示する方法、およびメッセージを選択して編集する方法を説明します。
1 つのカタログ内のすべてのメッセージを表示する手順は次のとおりです。
WebLogic メッセージ エディタを開きます。
WebLogic メッセージ エディタのウィンドウに、最後に表示したメッセージのカタログが、現在のコンテキスト カタログとして表示されます。
メニュー バーから [表示] を選択します。
[すべてのメッセージ] を選択します。
現在のコンテキスト カタログのすべてのメッセージが、図 6-10 に示されているように [メッセージ ビューア] ウィンドウに表示されます。メッセージ エディタのウィンドウは開いたままです。
現在のコンテキスト カタログからメッセージを表示し、次に新しいカタログに移動してコンテキストを変更すると、別の [メッセージ ビューア] ウィンドウが開いて、新しいカタログが表示されます。必要な (または画面に表示が収まる限りの) 数のカタログを同時に表示できます。カタログごとに別々の [メッセージ ビューア] ウィンドウが表示されます。新規カタログの参照の詳細については、「既存のカタログの参照」を参照してください。
メッセージ ビューアに表示される任意のメッセージを選択すると、その選択されたメッセージがコンテキスト カタログとなります。メッセージは、メッセージ エディタのウィンドウに表示されます。
既存のメッセージを編集するには、次の手順に従います。
編集するメッセージを見つけます。
「ログ メッセージの検索」および「シンプル テキスト メッセージの検索」に記載されているように [検索] ダイアログを使用しても、「メッセージ ビューアからの編集対象メッセージの選択」に示されているようにメッセージ ビューアでメッセージを選択してもかまいません。
メッセージは、メッセージ エディタのウィンドウに表示されます。
変更するフィールドを編集します。
[更新] をクリックします。
メッセージが更新され、カタログ全体が直ちにディスクに書き込まれます。
メッセージ エディタのウィンドウで、メッセージの廃止および復帰ができます。メッセージを廃止しても、そのメッセージはマスタ カタログからは削除されません。ユーザから見えなくなるだけです。この機能は、使用しなくなったメッセージを削除する場合に役立ちます。廃止したメッセージを再び表示する必要がある場合は、復帰できます。
メッセージを廃止、または復帰するには、次の手順に従います。
廃止または復帰するメッセージを見つけます。
メッセージ エディタのウィンドウで、[廃止されたメッセージ] オプションを、チェック ボックスをチェックするか、チェックをはずして、切り替えます。
[更新] をクリックします。
