| Oracle® Fusion Middleware Oracle WebLogic Serverアプリケーション・ロギングのためのロギング・サービスの使用 11g リリース1 (10.3.6) B61615-04 |
|
 前 |
 次 |
| Oracle® Fusion Middleware Oracle WebLogic Serverアプリケーション・ロギングのためのロギング・サービスの使用 11g リリース1 (10.3.6) B61615-04 |
|
前 |
次 |
以下の節では、メッセージ・エディタの使用方法について説明します。
メッセージ・エディタは、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 WebLogic Serverインストレーション・ガイドを参照してください。
サンプルのメッセージ・カタログ・ファイルは、SAMPLES_HOME/server/examples/src/examples/i18n/msgcatディレクトリにあります。
|
注意: SAMPLES_HOMEディレクトリの場所は、WebLogic Serverのインストール先によって異なる場合があります。 |
このサンプルのメッセージ・カタログをテンプレートとして使用し、独自のメッセージを作成できます。パッケージ名、クラス名などの与えられた情報を変更するだけです。次に、メッセージ・テキストを翻訳し、カタログを保存します。このトピックの詳細は、第5章「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に示されているように「メッセージ・ビューア」ウィンドウに表示されます。メッセージ・エディタのウィンドウは開いたままです。
現在のコンテキスト・カタログからメッセージを表示し、次に新しいカタログに移動してコンテキストを変更すると、別の「メッセージ・ビューア」ウィンドウが開いて、新しいカタログが表示されます。必要な(または画面に表示が収まるかぎりの)数のカタログを同時に表示できます。カタログごとに別々の「メッセージ・ビューア」ウィンドウが表示されます。新規カタログの参照の詳細は、「既存のカタログの参照」を参照してください。
メッセージ・ビューアに表示される任意のメッセージを選択すると、その選択されたメッセージがコンテキスト・カタログとなります。メッセージは、メッセージ・エディタのウィンドウに表示されます。
既存のメッセージを編集するには:
編集するメッセージを見つけます。
「ログ・メッセージの検索」および「シンプル・テキスト・メッセージの検索」に記載されているように「検索」ダイアログを使用しても、「メッセージ・ビューアからの編集対象メッセージの選択」に示されているようにメッセージ・ビューアでメッセージを選択してもかまいません。
メッセージは、メッセージ・エディタのウィンドウに表示されます。
変更するフィールドを編集します。
「更新」をクリックします。
メッセージが更新され、カタログ全体が直ちにディスクに書き込まれます。
メッセージ・エディタのウィンドウで、メッセージのリタイアおよびリタイア解除ができます。メッセージをリタイアしても、そのメッセージはマスタ・カタログからは削除されません。ユーザーから見えなくなるだけです。この機能は、使用しなくなったメッセージを削除する場合に役立ちます。リタイアしたメッセージを再び表示する必要がある場合は、リタイア解除できます。
メッセージをリタイア、またはリタイア解除するには、次の手順に従います。
リタイアまたはリタイア解除するメッセージを見つけます。
メッセージ・エディタのウィンドウで、「リタイアされたメッセージ」オプションを、チェック・ボックスをチェックするか、チェックをはずして、切り替えます。
「更新」をクリックします。
