nablarch.fw.messaging

クラス StructuredResponseMessage

java.lang.Object

nablarch.fw.messaging.InterSystemMessage<SendingMessage>

nablarch.fw.messaging.SendingMessage

nablarch.fw.messaging.ResponseMessage

nablarch.fw.messaging.StructuredResponseMessage

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

Result

public class StructuredResponseMessage
extends ResponseMessage

構造化されたデータを取り扱うために、addRecord時にデータをすぐに書き込まず、メモリ上にキャッシュする応答メッセージ。

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース nablarch.fw.messaging.InterSystemMessage

InterSystemMessage.HeaderName

インタフェースから継承されたネストされたクラス/インタフェース nablarch.fw.Result

Result.ClientError, Result.Error, Result.MultiStatus, Result.NotFound, Result.Success

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

コンストラクタ

コンストラクタと説明
StructuredResponseMessage(RequestMessage message) 要求電文に対する応答電文を作成する。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
ResponseMessage	addRecord(java.util.Map<java.lang.String,?> record) 電文のデータ部に、指定したレコードを追加する。
ResponseMessage	addRecord(java.lang.Object recordObj) 電文のデータ部に指定したレコードを追加する。
ResponseMessage	addRecord(java.lang.String recordType, java.util.Map<java.lang.String,?> record) 電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。
ResponseMessage	addRecord(java.lang.String recordType, java.lang.Object recordObj) 電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。
byte[]	getBodyBytes() メッセーボディのバイナリ表現を返す。
StructuredResponseMessage	setFormatter(DataRecordFormatter formatter) メッセージボディのフォーマット定義を設定する。

クラスから継承されたメソッド nablarch.fw.messaging.ResponseMessage

getFwHeader, getMessage, getStatusCode, isSuccess, setFwHeaderDefinition, setResult, setStatusCodeHeader, throwAsError, throwAsError

クラスから継承されたメソッド nablarch.fw.messaging.SendingMessage

getBodyStream, getTimeToLive, setTimeToLive

クラスから継承されたメソッド nablarch.fw.messaging.InterSystemMessage

getCorrelationId, getDestination, getFormatter, getHeader, getHeaderMap, getMessageId, getParam, getParamMap, getRecordOf, getRecords, getRecordsOf, getReplyTo, setCorrelationId, setDestination, setHeader, setHeaderMap, setMessageId, setReplyTo

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

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

コンストラクタの詳細

StructuredResponseMessage

@Published(tag="architect")
public StructuredResponseMessage(RequestMessage message)

要求電文に対する応答電文を作成する。 RequestMessage#reply() から呼ばれることを想定している。

パラメータ:

message - 要求電文オブジェクト

メソッドの詳細

setFormatter

public StructuredResponseMessage setFormatter(DataRecordFormatter formatter)

メッセージボディのフォーマット定義を設定する。
この実装ではフォーマッタの初期化処理を行う。

オーバーライド:

setFormatter クラス内 InterSystemMessage<SendingMessage>

パラメータ:

formatter - フォーマット定義オブジェクト

戻り値:

このオブジェクト自体

getBodyBytes

public byte[] getBodyBytes()

メッセーボディのバイナリ表現を返す。 送信(仕向)電文の場合はデータレコードをレコードフォーマッタで直列化したものを返す。 受信(被仕向)電文の場合はパース前の送信電文の内容をそのまま返す。 この実装では、フレームワーク制御ヘッダ部と業務データ部をそれぞれ直列化し、 連結したものを返す。 ただし、フレームワーク制御ヘッダを直列化する際、フレームワーク制御ヘッダ定義 を使用する。これは、通常MessageReplyHandlerによって設定される。 この実装ではこの時点でキャッシュされたメッセージをフォーマッタに書き込み、バイト列を生成する。

オーバーライド:

getBodyBytes クラス内 ResponseMessage

戻り値:

メッセーボディのバイナリ表現

addRecord

@Published(tag="architect")
public ResponseMessage addRecord(java.util.Map<java.lang.String,?> record)

電文のデータ部に、指定したレコードを追加する。

出力時に使用するデータレイアウト（レコードタイプ）は、recordの内容から自動的に判別される。

オーバーライド:

addRecord クラス内 ResponseMessage

パラメータ:

record - レコード内容

戻り値:

このオブジェクト自体

addRecord

@Published(tag="architect")
public ResponseMessage addRecord(java.lang.String recordType,
                                                             java.util.Map<java.lang.String,?> record)

電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。

recordTypeにnullを渡した場合、SendingMessage.addRecord(Map)と同様の処理を行う。

オーバーライド:

addRecord クラス内 ResponseMessage

パラメータ:

recordType - レコードタイプ

record - レコード内容

戻り値:

このオブジェクト自体

addRecord

@Published(tag="architect")
public ResponseMessage addRecord(java.lang.Object recordObj)

電文のデータ部に指定したレコードを追加する。

出力時に使用するデータレイアウト（レコードタイプ）は、渡されたデータの内容から自動的に判別される。

オーバーライド:

addRecord クラス内 ResponseMessage

パラメータ:

recordObj - レコード内容を表現したオブジェクト

戻り値:

このオブジェクト自体

addRecord

@Published(tag="architect")
public ResponseMessage addRecord(java.lang.String recordType,
                                                             java.lang.Object recordObj)

電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。

recordTypeにnullを渡した場合、SendingMessage.addRecord(Object)と同様の処理を行う。

オーバーライド:

addRecord クラス内 ResponseMessage

パラメータ:

recordType - レコードタイプ

recordObj - レコード内容を表現したオブジェクト

戻り値:

このオブジェクト自体