トレース・メッセージをログ宛先に書き込みます。
構文
void trace(String traceMsg)
void trace(int traceLevel, String traceMsg)
void trace(int traceLevel, int messageNum)
void trace(int traceLevel, int messageNum, String param [,...])
void trace(int traceLevel, int messageNum, Object[] paramArray)
パラメーター
- traceLevel
- 出力するトレース・メッセージを決定するために使用されるトレース・レベル。このメソッドは、コラボレーション・オブジェクトのトレース・レベルがこの traceLevel 値以上の場合に、トレース・メッセージを書き込みます。このコラボレーションのトレース・レベルを定義し文書化して、管理者が使用するコラボレーション・オブジェクトのレベルを理解できるようにする必要があります。
- traceMsg
- トレース・ファイルに書き込まれるトレース・メッセージ・テキスト。
- messageNum
- コラボレーションのメッセージ・ファイル内のメッセージのメッセージ番号で、メッセージ番号で索引付けされます。メッセージ・テキスト・ファイルの設定方法の詳細は、メッセージ・ファイルの作成を参照してください。
- param
- 単一メッセージ・パラメーターの値。コンマで区切られた、最大 5 つのメッセージ・パラメーターが可能です。各パラメーターは順次的に解決され、メッセージ・テキスト内のパラメーターになります。
- paramArray
- メッセージ・パラメーター値の配列。各パラメーターは順次的に解決され、メッセージ・テキスト内のパラメーターになります。
注記
trace() メソッドは、コラボレーション・ログ宛先にトレース・メッセージを送信します。
デフォルトのログ宛先は、ファイル InterchangeSystem.log です。
ユーザーは、InterChange Server 構成ファイル InterchangeSystem.cfg 内の LOG_FILE のパラメーター値を入力してログ宛先を変更することができます。
パラメーター値がファイル名あるいは STDOUT になることがあります。STDOUT は、InterChange Server のコマンド・ウィンドウにログを記録します。
トレース・ロギングに関連するシステム構成パラメーターを、さらに 3 つ設定することもできます。すべてのパラメーターは構成ファイル InterchangeSystem.cfg 内に格納されます。
- MAX_TRACE_FILE_SIZE パラメーターを使用して、トレース・ファイルの最大サイズを設定します。
デフォルトのファイル・サイズは無制限なので、常に最大サイズに設定する必要があります。
- NUMBER_OF_ARCHIVE_TRACES パラメーターを使用して、1 つから 5 つの間でアーカイブ・トレース・ファイルを設定します。
パラメーターが設定されていない場合、デフォルトは 5 つです。
- エラー・メッセージをトレース・ファイルに書き込むのと同時に STDOUT に表示する場合は、MIRROR_TRACE_TO_STDOUT パラメーターを設定します。
デフォルト値は false です。メッセージは STDOUT に同時に書き込まれません。
trace() メソッドにはいくつかの形式があります。
- メソッドの第 1 の形式は、ストリング・メッセージを 1 つのみ取得します。このメッセージはトレースがレベル 1 以上に設定されるときに表示されます。
- 第 2 の形式は、トレース・レベルおよびストリング・メッセージを取得します。このメッセージはトレースが指定されたレベル以上に設定されるときに表示されます。
- 第 3 の形式は、トレース・レベルおよび番号を取得します。この番号は、コラボレーションのメッセージ・ファイル内のメッセージを表します。メッセージ・テキスト全体はメッセージ・ファイルに表示されます。トレースが指定されたレベル以上に設定されるときメッセージ・ファイルは、パラメーターなしで表示どおりに出力されます。
- 第 4 の形式は、トレース・レベル、コラボレーションのメッセージ・ファイル内のメッセージを表す番号およびメッセージで使用される 1 つ以上のパラメーターを取得します。パラメーター値を最大 5 つまで送信できます。このパラメーター値を、コンマで区切ってメッセージに使用することができます。
- 第 5 の形式は、トレース・レベル、コラボレーションのメッセージ・ファイル内のメッセージを表す番号およびパラメーター値の配列を取得します。
コラボレーション・オブジェクトを構成して、システムまたはコラボレーションでトレースを生成することができます。コラボレーション生成トレースを出力するようにコラボレーションが構成されている場合、trace() メソッドは、コラボレーション・オブジェクトが出力するメッセージを生成します。トレースを使用する条件の決定についてのヘルプは、"トレース・メッセージの追加"を参照してください。
例
次の例では、メソッドの第 2 の形式を使用して、指定されたメッセージ・テキストでレベル 2 トレース・メッセージを生成します。
trace (2, "Starting to trace at Level 2");
次の例では、コラボレーション・オブジェクトのトレース・レベルが 2 以上の場合に、メソッドの第 4 の形式を使用して、コラボレーションのメッセージ・ファイル内にメッセージ 201 を書き込みます。メッセージには、名前と年の 2 つのパラメーターがあります。このメソッドの呼び出しは、これらのパラメーターの値を渡します。
trace(2, 201, "DAVID", "1961");
