トレース・ファイルにメッセージを書き込みます。
構文
public void trace(int level, int msgType, String message);
public void trace(int level, int msgNum, int msgType);
public void trace(int level, int msgNum, int msgType, msgParameters);
public void trace(int level, int msgNum, int msgType, Vector paramArray);
public void trace(int level, int msgType, BusObjDef boDef);
public void trace(int level, int msgType, AgentProperty[] properties,
String foreword);
パラメーター
- boDef
- トレース・ファイルに書き込まれるビジネス・オブジェクト定義。
- foreword
- メッセージを理解しやすくするために properties プロパティー配列の前に配置される String (例えば、「These are the properties for the Object Discovery Agent」など)。
- level
- 以下のいずれかのトレース・レベル定数として指定されるトレース・レベル。
ODKConstant.TRACELEVEL0
ODKConstant.TRACELEVEL1
ODKConstant.TRACELEVEL2
ODKConstant.TRACELEVEL3
ODKConstant.TRACELEVEL4
ODKConstant.TRACELEVEL5
- message
- トレース・ファイルに書き込まれる String メッセージ。
- msgNum
- メッセージ・ファイル内のメッセージ番号を指定します。
- msgParameters
- 最大 3 つの String パラメーター値のオプショナル・リストです。各パラメーターはメッセージ・リスト内のパラメーターに対応しています。
- msgType
- 以下のいずれかのメッセージ・タイプ定数として指定されるメッセージのタイプ。
ODKConstant.XRD_FATAL
ODKConstant.XRD_ERROR
ODKConstant.XRD_URGENTWARNING
ODKConstant.XRD_WARNING
ODKConstant.XRD_INFO
ODKConstant.XRD_TRACE
- paramArray
- メッセージに挿入されるパラメーターのベクトル。
- properties
- トレース・ファイルに書き込まれるエージェント・プロパティー (AgentProperty) オブジェクトの配列。
戻り値
なし。
例外
- IllegalArgumentException
- properties 引き数が null の場合、または msgType 引き数が無効な場合にスローされます。
注記
トレース・レベル がシステム・トレース・レベル以下である場合、trace() メソッドは指定された情報をトレース・ファイルに送信します。
システム・トレース・レベルは、TraceLevel 構成プロパティーを介して設定されます。この構成プロパティーはビジネス・オブジェクト・ウィザードによって自動的に ODA 構成プロパティーに組み込まれます。
トレース・レベル がゼロ (0) の場合、エラー・ロギングがアクティブ化され、trace() によってエラー・メッセージがトレース・ファイルに送信されます。トレース・レベルがゼロ以外 (表 106 を参照)
の場合、トレースがアクティブ化され、trace()
によってトレース・メッセージがトレース・ファイルに送信されます。
表 106. ODA のトレース・レベル
トレース・レベル
| 説明
| トレース・レベル定数
|
0
| エラー・メッセージをログに記録します。
| TRACELEVEL0
|
1
| メソッドが開始されるたびにトレースをとります。通常は、ビジネス・オブジェクト定義ごとに状況メッセージおよびキー情報が提供されます。
| TRACELEVEL1
|
2
| エージェント・プロパティーおよび受け取った値のトレースをとります。
| TRACELEVEL2
|
3
| ビジネス・オブジェクト定義の名前をトレースします。通常は、ビジネス・オブジェクト・プロパティーおよび受け取った値が提供されます。
| TRACELEVEL3
|
4
| メソッドが開始および終了するたびにメッセージのトレースをとります。すべてのスレッドの作成に関する記録がとられます。
| TRACELEVEL4
|
5
| ODA の初期化を指示します。取得されたすべてのエージェント・プロパティーの値、ODA
が生成した各スレッドの詳細状況、およびビジネス・オブジェクト定義のダンプが提供されます。
| TRACELEVEL5
|
ODA のトレースの出力先の名前は、ユーザーが TraceFileName
構成プロパティーを介して設定してください。設定された構成プロパティーは ODK
によって自動的に ODA 始動プロパティーに組み込まれます。
その結果として、(初期化済み始動プロパティーを受け取る) init() メソッドの開始後に初めてトレースが開始されます。
trace() メソッドには、以下の形式があります。
- 最初の 4 つの形式を使用すると、テキスト・メッセージがトレース・ファイルに送信されます。
- 最初の形式では、指定されたテキスト message がトレース・ファイルに送信されます。
- 2 番目の形式を使用すると、指定されたメッセージ番号 (msgNum)
のメッセージが ODA メッセージ・ファイルから送信されます。
- 3 番目の形式を使用した場合も、指定されたメッセージ番号 (msgNum)
のメッセージが ODA メッセージ・ファイルから送信されます。この形式では、メッセージをトレース先に送信する前に、メッセージに挿入する String
メッセージ・パラメーター (msgParameters)
を最大 3 つまで送信することもできます。
- 4 番目の形式を使用した場合も、ODA
メッセージ・ファイルからメッセージが送信されてメッセージ・パラメーターが与えられます。ただしこの形式では、メッセージ・パラメーターが Java Vector
paramArray 内の要素として送信されます。
ODA メッセージ・ファイルについては、メッセージ・ファイル
を参照してください。メッセージ・パラメーターについては、パラメーター値の使用を参照してください。
- 5 番目の形式を使用すると、ビジネス・オブジェクト定義のダンプがトレース・ファイルに送信されます。このダンプは
repos_copy ユーティリティーの形式でフォーマットされます。基本フォーマットは以下のとおりです。
[BusinessObjectDefinition]
Name=busObjName
AppSpecificInfo=business-object-level application-specific information
[Attribute]
Name=attribute1
Type=attribute type
Cardinality=n or 1
AppSpecificInfo=attribute-level application-specific information
other attribute properties
[End]
...
- 6 番目の形式を使用すると、指定されたエージェント properties のダンプがトレース・ファイルに送信されます。
forward 引き数によって、メッセージをわかりやすくするための前置きのテキストが与えられます。
参照
getMsg()
