nablarch.fw.messaging.reader

クラス StructuredFwHeaderDefinition

java.lang.Object

nablarch.fw.messaging.reader.StructuredFwHeaderDefinition

すべての実装されたインタフェース:

FwHeaderDefinition

public class StructuredFwHeaderDefinition
extends java.lang.Object
implements FwHeaderDefinition

構造化データのフレームワーク制御ヘッダの解析を行うデータリーダ。

このデータリーダ実装は、MessageReaderが読み込んだ受信電文のメッセージボディから フレームワーク制御ヘッダ部分を読み込み、後続のハンドラからそれらの値を参照可能とする。 このリーダの戻り値の型であるRequestMessageは、フレームワーク制御ヘッダに 対するアクセサを保持し、Requestインターフェースを実装する。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
StructuredFwHeaderDefinition()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
DataRecordFormatter	getFormatter(java.lang.String dataType) フレームワーク制御ヘッダーのフォーマット定義を返す。
DataRecordFormatter	getFormatter(java.lang.String dataType, FilePathSetting filePathSetting, FormatterFactory formatterFactory) 指定されたFilePathSettingインスタンスを使用して フレームワーク制御ヘッダーのフォーマット定義を返す。
java.lang.String	getResendFlagOffValue() 初回電文時に設定される再送要求フラグの値を返す。
RequestMessage	readFwHeaderFrom(ReceivedMessage message) 受信電文中のフレームワーク制御ヘッダ部を読み込み、 RequestMessageオブジェクトを生成する。
StructuredFwHeaderDefinition	setFwHeaderKeys(java.util.Map<java.lang.String,java.lang.String> fwHeaderKeys) フレームワーク制御ヘッダキー名リストを設定する
StructuredFwHeaderDefinition	setResendFlagOffValue(java.lang.String value) 初回電文時に設定される再送要求フラグの値を設定する。
void	writeFwHeaderTo(SendingMessage message, FwHeader header) 応答電文オブジェクトに設定されたフレームワーク制御ヘッダの内容を 送信電文に反映する。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

StructuredFwHeaderDefinition

public StructuredFwHeaderDefinition()

メソッドの詳細

readFwHeaderFrom

public RequestMessage readFwHeaderFrom(ReceivedMessage message)

受信電文中のフレームワーク制御ヘッダ部を読み込み、 RequestMessageオブジェクトを生成する。

定義:

readFwHeaderFrom インタフェース内 FwHeaderDefinition

パラメータ:

message - 受信電文オブジェクト

戻り値:

要求電文オブジェクト

getFormatter

public DataRecordFormatter getFormatter(java.lang.String dataType)

フレームワーク制御ヘッダーのフォーマット定義を返す。

パラメータ:

dataType - データ種別

戻り値:

フレームワーク制御ヘッダーのフォーマット定義

getFormatter

public DataRecordFormatter getFormatter(java.lang.String dataType,
                                        FilePathSetting filePathSetting,
                                        FormatterFactory formatterFactory)

指定されたFilePathSettingインスタンスを使用して フレームワーク制御ヘッダーのフォーマット定義を返す。

パラメータ:

dataType - データ種別

filePathSetting - フォーマット定義ファイルを取得するためのFilePathSetting

formatterFactory - フォーマット定義を生成するファクトリ

戻り値:

フレームワーク制御ヘッダーのフォーマット定義

writeFwHeaderTo

public void writeFwHeaderTo(SendingMessage message,
                            FwHeader header)

応答電文オブジェクトに設定されたフレームワーク制御ヘッダの内容を 送信電文に反映する。

定義:

writeFwHeaderTo インタフェース内 FwHeaderDefinition

パラメータ:

message - 応答電文オブジェクト

header - フレームワーク制御ヘッダー

setResendFlagOffValue

public StructuredFwHeaderDefinition setResendFlagOffValue(java.lang.String value)

初回電文時に設定される再送要求フラグの値を設定する。

パラメータ:

value - 初回電文時に設定される再送要求フラグの値

戻り値:

このオブジェクト自体

getResendFlagOffValue

public java.lang.String getResendFlagOffValue()

初回電文時に設定される再送要求フラグの値を返す。

戻り値:

初回電文時に設定される再送要求フラグの値

setFwHeaderKeys

public StructuredFwHeaderDefinition setFwHeaderKeys(java.util.Map<java.lang.String,java.lang.String> fwHeaderKeys)

フレームワーク制御ヘッダキー名リストを設定する

パラメータ:

fwHeaderKeys - フレームワーク制御ヘッダキー名リスト

戻り値:

このオブジェクト自体