nablarch.fw.messaging.logging

クラス MessagingLogFormatter

java.lang.Object

nablarch.fw.messaging.logging.MessagingLogFormatter

@Published(tag="architect")
public class MessagingLogFormatter
extends Object

メッセージ送受信処理の中でログ出力を行うクラス。 ログファイルはキュー毎に個別に設定できる。 ログが出力されるタイミングは以下のとおり

 1. 送信処理完了時 (ローカルキューへのPUT完了直後)
 2. 電文受信時
 

出力可能な項目は以下のとおり。

 1. 共通プロトコルヘッダ
   - メッセージID (String)
   - 関連メッセージID (String)
   - 送信宛先キュー論理名 (String)
   - 応答宛先キュー論理名 (String)
   
 2. メッセージボディデータ
   - メッセージボディのバイト長 (int)
   - メッセージボディ
   - メッセージボディのヘキサダンプ
   
   ※メッセージボディに含まれる個人情報や機密情報はマスクして出力することが可能である(マスク用の設定が必要)
   
 3. MOM固有プロトコルヘッダ(以下はJmsMessagingProviderの場合)
     JMSType
     JMSDeliveryMode
     JMSPriority
     JMSTimestamp
     JMSExpiration   
     JMSRedelivered
     JMSXDeliveryCount
     JMSXGroupID
     JMSXGroupSeq
     JMSXProducerTXID
      
 4. そのほか
     - スレッド名
     - メッセージヘッダ
 

作成者:

Iwauo Tajima

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	PROPS_PREFIX プロパティ名のプレフィックス

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected LogItem[]	getFormattedLogItems(Map<LogItem> logItems, Map props, String formatPropName, String defaultFormat) フォーマット済みのログ出力項目を取得する。
String	getHttpReceivedMessageLog(ReceivedMessage message, Charset charset) 同期送信処理開始時に出力されるログ文字列を生成する。
String	getHttpSentMessageLog(SendingMessage message, Charset charset) 同期送信処理開始時に出力されるログ文字列を生成する。
protected Map<LogItem>	getLogItems() フォーマット対象のログ出力項目を取得する。
String	getReceivedMessageLog(ReceivedMessage message) 同期送信処理開始時に出力されるログ文字列を生成する。
String	getSentMessageLog(SendingMessage message) 同期送信処理開始時に出力されるログ文字列を生成する。

フィールドの詳細

PROPS_PREFIX

public static final String PROPS_PREFIX

プロパティ名のプレフィックス

関連項目:

定数フィールド値

メソッドの詳細

getSentMessageLog

public String getSentMessageLog(SendingMessage message)

同期送信処理開始時に出力されるログ文字列を生成する。

パラメータ:

message - 電文オブジェクト

戻り値:

ログ文字列

getReceivedMessageLog

public String getReceivedMessageLog(ReceivedMessage message)

同期送信処理開始時に出力されるログ文字列を生成する。

パラメータ:

message - 電文オブジェクト

戻り値:

ログ文字列

getHttpSentMessageLog

public String getHttpSentMessageLog(SendingMessage message,
                                    Charset charset)

同期送信処理開始時に出力されるログ文字列を生成する。

パラメータ:

message - 電文オブジェクト

charset - 出力に使用する文字セット

戻り値:

ログ文字列

getHttpReceivedMessageLog

public String getHttpReceivedMessageLog(ReceivedMessage message,
                                        Charset charset)

同期送信処理開始時に出力されるログ文字列を生成する。

パラメータ:

message - 電文オブジェクト

charset - 出力に使用する文字セット

戻り値:

ログ文字列

getFormattedLogItems

protected LogItem[] getFormattedLogItems(Map<LogItem> logItems,
                                         Map props,
                                         String formatPropName,
                                         String defaultFormat)

フォーマット済みのログ出力項目を取得する。

パラメータ:

logItems - フォーマット対象のログ出力項目

props - 各種ログ出力の設定情報

formatPropName - フォーマットのプロパティ名

defaultFormat - デフォルトのフォーマット

戻り値:

フォーマット済みのログ出力項目

getLogItems

protected Map<LogItem> getLogItems()

フォーマット対象のログ出力項目を取得する。

戻り値:

フォーマット対象のログ出力項目