Class StructuredFwHeaderDefinition

java.lang.Object
nablarch.fw.messaging.reader.StructuredFwHeaderDefinition
All Implemented Interfaces:
FwHeaderDefinition

public class StructuredFwHeaderDefinition extends Object implements FwHeaderDefinition
構造化データのフレームワーク制御ヘッダの解析を行うデータリーダ。

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

  • Constructor Details

    • StructuredFwHeaderDefinition

      public StructuredFwHeaderDefinition()
  • Method Details

    • readFwHeaderFrom

      public RequestMessage readFwHeaderFrom(ReceivedMessage message)
      受信電文中のフレームワーク制御ヘッダ部を読み込み、 RequestMessageオブジェクトを生成する。
      Specified by:
      readFwHeaderFrom in interface FwHeaderDefinition
      Parameters:
      message - 受信電文オブジェクト
      Returns:
      要求電文オブジェクト
    • getFormatter

      public DataRecordFormatter getFormatter(String dataType)
      フレームワーク制御ヘッダーのフォーマット定義を返す。
      Parameters:
      dataType - データ種別
      Returns:
      フレームワーク制御ヘッダーのフォーマット定義
    • getFormatter

      public DataRecordFormatter getFormatter(String dataType, FilePathSetting filePathSetting, FormatterFactory formatterFactory)
      指定されたFilePathSettingインスタンスを使用して フレームワーク制御ヘッダーのフォーマット定義を返す。
      Parameters:
      dataType - データ種別
      filePathSetting - フォーマット定義ファイルを取得するためのFilePathSetting
      formatterFactory - フォーマット定義を生成するファクトリ
      Returns:
      フレームワーク制御ヘッダーのフォーマット定義
    • writeFwHeaderTo

      public void writeFwHeaderTo(SendingMessage message, FwHeader header)
      応答電文オブジェクトに設定されたフレームワーク制御ヘッダの内容を 送信電文に反映する。
      Specified by:
      writeFwHeaderTo in interface FwHeaderDefinition
      Parameters:
      message - 応答電文オブジェクト
      header - フレームワーク制御ヘッダー
    • setResendFlagOffValue

      public StructuredFwHeaderDefinition setResendFlagOffValue(String value)
      初回電文時に設定される再送要求フラグの値を設定する。
      Parameters:
      value - 初回電文時に設定される再送要求フラグの値
      Returns:
      このオブジェクト自体
    • getResendFlagOffValue

      public String getResendFlagOffValue()
      初回電文時に設定される再送要求フラグの値を返す。
      Returns:
      初回電文時に設定される再送要求フラグの値
    • setFwHeaderKeys

      public StructuredFwHeaderDefinition setFwHeaderKeys(Map<String,String> fwHeaderKeys)
      フレームワーク制御ヘッダキー名リストを設定する
      Parameters:
      fwHeaderKeys - フレームワーク制御ヘッダキー名リスト
      Returns:
      このオブジェクト自体