nablarch.fw.messaging

クラス StandardFwHeaderDefinition

java.lang.Object

nablarch.fw.messaging.StandardFwHeaderDefinition

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

FwHeaderDefinition

public class StandardFwHeaderDefinition
extends java.lang.Object
implements FwHeaderDefinition

Nablarch標準のフレームワーク制御ヘッダ定義。 本実装では、各電文のメッセージボディの先頭レコード上に 全てのフレームワーク制御ヘッダが定義されていることを前提としており、 JMSヘッダー等のメッセージングプロバイダ実装に依存する項目は使用しない。

以下は本クラスで使用できるフレームワーク制御ヘッダの定義例である。 このデータレコードが電文の先頭に位置している必要がある。

 #====================================================================
 # フレームワーク制御ヘッダ部 (50byte)
 #====================================================================
 [NablarchHeader]
 1   requestId   X(10)       # リクエストID
 11  userId      X(10)       # ユーザID
 21  resendFlag  X(1)  "0"   # 再送要求フラグ (0: 初回送信 1: 再送要求)
 22  statusCode  X(4)  "200" # ステータスコード
 26 ?filler      X(25)       # 予備領域
 #====================================================================
 

フォーマット定義にフレームワーク制御ヘッダ以外の項目を含めた場合、 FwHeaderクラスの任意属性としてアクセスすることができる。 これらの属性は、PJ毎にフレームワーク制御ヘッダを簡易的に拡張する場合に 利用することができる。

なお、将来的な任意項目の追加およびフレームワークの機能追加に伴うヘッダ追加 に対応するために、予備領域を設けておくことを強く推奨する。

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

コンストラクタ

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

メソッドのサマリー

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

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

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

コンストラクタの詳細

StandardFwHeaderDefinition

public StandardFwHeaderDefinition()

メソッドの詳細

readFwHeaderFrom

public RequestMessage readFwHeaderFrom(ReceivedMessage message)

受信電文中のフレームワーク制御ヘッダ部を読み込み、 RequestMessageオブジェクトを生成する。 この実装ではメッセージボディの先頭レコードを取得し、 フレームワーク制御ヘッダの各項目を読み込む。

定義:

readFwHeaderFrom インタフェース内 FwHeaderDefinition

パラメータ:

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

戻り値:

要求電文オブジェクト

writeFwHeaderTo

public void writeFwHeaderTo(SendingMessage message,
                            FwHeader header)

応答電文オブジェクトに設定されたフレームワーク制御ヘッダの内容を 送信電文に反映する。 この実装では、メッセージボディ部のバイト列の先頭にフレームワーク制御ヘッダ のバイト列を連結する。

定義:

writeFwHeaderTo インタフェース内 FwHeaderDefinition

パラメータ:

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

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

setFormatFileDir

public StandardFwHeaderDefinition setFormatFileDir(java.lang.String dirName)

フレームワーク制御ヘッダーのフォーマット定義ファイルが配置されている ディレクトリの論理名を設定する。 設定を省略した場合のデフォルト値は"format"である。

パラメータ:

dirName - フォーマット定義ファイル配置ディレクトリの論理名

戻り値:

このオブジェクト自体

setFormatFileName

public StandardFwHeaderDefinition setFormatFileName(java.lang.String fileName)

フレームワーク制御ヘッダーのフォーマット定義ファイルのファイル名 を設定する。 設定を省略した場合のデフォルト値は"header.fmt"となる。

パラメータ:

fileName - フォーマット定義ファイル名

戻り値:

このオブジェクト自体

getFormatter

public DataRecordFormatter getFormatter()

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

戻り値:

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

getFormatter

public DataRecordFormatter getFormatter(FilePathSetting filePathSetting,
                                        FormatterFactory formatterFactory)

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

パラメータ:

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

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

戻り値:

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

setResendFlagOffValue

public StandardFwHeaderDefinition setResendFlagOffValue(java.lang.Object value)

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

パラメータ:

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

戻り値:

このオブジェクト自体

getResendFlagOffValue

public java.lang.Object getResendFlagOffValue()

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

戻り値:

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