logError()、logInfo()、logWarning()

エラー、情報、または警告メッセージをログ宛先に書き込みます。

構文

void logError(String message)
 void logError(int messageNum)
 void logError(int messageNum, String param [,...])
 void logError(int messageNum, Object[] paramArray)
 
void logInfo(String message)
 void logInfo(int messageNum)
 void logInfo(int messageNum, String param [,...])
 void logInfo(int messageNum, Object[] paramArray)
 
void logWarning(String message)
 void logWarning(int messageNum)
 void logWarning(int messageNum, String param [,...])
 void logWarning(int messageNum, Object[] paramArray)
 

パラメーター

message
ログに記録されるメッセージ・テキスト。

messageNum
コラボレーションのメッセージ・ファイル内のメッセージのメッセージ番号で、メッセージ番号で索引付けされます。メッセージ・テキスト・ファイルの設定方法の詳細は、メッセージ・ファイルの作成を参照してください。

param
単一メッセージ・パラメーターの値。コンマで区切られた、最大 5 つのメッセージ・パラメーターが可能です。各パラメーターは順次的に解決され、メッセージ・テキスト内のパラメーターになります。

paramArray
メッセージ・パラメーター値の配列。各パラメーターは順次的に解決され、メッセージ・テキスト内のパラメーターになります。

注記

logError()logWarning()、および logInfo() メソッドは、コラボレーションのログ宛先にメッセージを送信します。

デフォルトのログ宛先は、ファイル InterchangeSystem.log です。

ユーザーは、InterChange Server 構成ファイル InterchangeSystem.cfg 内の LOG_FILE のパラメーター値を入力してログ宛先を変更することができます。

パラメーター値がファイル名あるいは STDOUT になることがあります。STDOUT は、InterChange Server のコマンド・ウィンドウにログを記録します。

ロギングに関連するシステム構成パラメーターを、さらに 3 つ設定することもできます。すべてのパラメーターは、InterChange Server 構成ファイル InterchangeSystem.cfg 内に格納されます。

エラー・メッセージ、情報メッセージまたは警告メッセージを記録するメソッドを使用するかどうかを判断する際のヘルプとして、"メッセージのロギング"を参照してください。ユーザーのログ・ファイルに表示されるメッセージ・テキストには、メッセージの記録に使用するメソッドに応じて、Error、Info または Warning という接頭部が付きます。

これらの各ロギング・メソッドには、いくつかの形式があります。

messageNum パラメーターを取得するメソッドのすべての形式で、メッセージ・ファイルを使用する必要があります。このファイルはメッセージ番号で索引化されます。メッセージ・テキスト・ファイルの設定方法の詳細は、メッセージ・ファイルの作成を参照してください。

logError() メソッドは、ログ宛先にメッセージを送信するのに加え、以下の場合にエラー・メッセージを E メール受信側に送信します。

注:

  1. CollaborationFoundation テンプレートによって設定される SEND_EMAIL 構成プロパティーにより、メッセージ番号ごとに、E メール通知を生成するメッセージを指定できます。詳細については、CollaborationFoundation テンプレートを参照してください。

  2. logError() メソッドにより、エラー・メッセージが E メール受信側に自動的に送信されます (Email コラボレーションと Email アダプターが実行していることを前提としています)。sendEmail() メソッドは、E メール・メッセージを明示的に送信できるようにします。

次の例では、getString() を使用してメッセージ内の属性値を取得することにより、エラー・メッセージを記録します。

logError("Incorrect customer: CustomerID: "
    + fromCustomerBusObj.getString("CustomerID"));
 

次の例では、コラボレーションのメッセージ・ファイルにテキストが格納されているエラー・メッセージをログに記録します。メッセージ・ファイルの 10 番のメッセージは、顧客のラストネーム (LName 属性) および顧客のファーストネーム (FName 属性) を示す 2 つのパラメーターを取得します。

logError(10, customer.get("LName"), customer.get("FName");
 

次の例では、パラメーターの配列を使用してエラー・メッセージを記録します。説明用に、この例ではパラメーターが 2 つのみの配列を使用します。この例では、カスタマー ID とカスタマー名の 2 つの要素を持つ配列 args が宣言されます。それから、12 番のメッセージおよび args 配列内の値を使用して、logError() メソッドはエラーを記録します。

Object[] args =
    {
       fromCustomerBusObj.getString("CustomerID"),
       fromCustomerBusObj.getString("CustomerName");
    }
 logError(12, args);
 

Copyright IBM Corp. 2004