BEA WebLogic Server 用の Loggable オブジェクトのリファレンス

以下の節では、Loggable オブジェクトのリファレンス情報を提供します。

• Loggable オブジェクトの概要

• Loggable オブジェクトの使用例

 

---

Loggable オブジェクトの概要

デフォルトでは、すべてのログ メッセージ カタログは、メッセージの WebLogic Server ログへの書き込みに使用されるメソッドを含む Logger クラスを作成します。Logger クラスには、メッセージをログに記録せずに、Loggable Objects を返すメソッドを任意選択で組み込むことができます。Loggable オブジェクトは、ログ メッセージを生成するが、実際のログへの書き込みは後から行いたい場合に便利です。また、例外送出など、他の目的にメッセージ テキストを使用する場合にも使用できます。

 

---

Loggable オブジェクトの使用例

Loggable オブジェクトを返すメソッドを持つ Logger クラスを作成するには、メッセージ カタログに loggables 属性を設定する必要があります。

たとえば、リストC-1 に示す test.xml カタログを想定します。

リスト C-1 test.xml メッセージ カタログ

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE message_catalog PUBLIC "weblogic-message-catalog-dtd" "http://www.bea.com/servers/wls600/msgcat.dtd">
<message_catalog
   subsystem="Examples"
   version="1.0"
   baseid="500000"
   endid="500001"
   loggables="true"
   >
   <logmessage
      messageid="500000"
      severity="error"
      method="logIOError(Throwable t)"
      >
      <messagebody>
         IO failure detected.
      </messagebody>
      <messagedetail>
      </messagedetail>
      <cause>
      </cause>
      <action>
      </action>
   </logmessage>
</message_catalog>

このカタログを i18ngen ユーティリティで実行すると、このカタログに対して次の 2 つのメソッドを持つ Logger クラスが作成されます。

• logIOError (Throwable)―メッセージをログに記録する

• logIOErrorLoggable (Throwable)―Loggable オブジェクトを返す

Loggable クラスの使用例は、以下の リストC-2 に示されています。

リスト C-2 Loggable クラスの使用例

package test;
import weblogic.logging.Loggable;
import weblogic.i18n.testLogger;

...
try {
  // 何らかの入出力
} catch (IOException ioe) {
  Loggable l = testLogger.logIOErrorLoggable(ioe);
  l.log();  // エラーをログに書き込む
  throw new Exception(l.getMessage());//ログされたものと同じテキストで
 	新規の例外を送出する
}