nablarch.fw.messaging

クラス ResponseMessage

java.lang.Object

nablarch.fw.messaging.InterSystemMessage<SendingMessage>

nablarch.fw.messaging.SendingMessage

nablarch.fw.messaging.ResponseMessage

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

Result

直系の既知のサブクラス:

StructuredResponseMessage

public class ResponseMessage
extends SendingMessage
implements Result

本システムに対する要求電文への応答電文を表すクラス。 本クラスでは、RequestMessageと同様、応答電文の内容をフレームワークヘッダ部と 業務データ部に分離して管理しており、業務ロジックからは業務データ部しか操作できない ようになっている。 メッセージボディを直列化する際には、フレームワークヘッダ部と業務データ部をそれぞれ 直列化して連結したものを返す。

作成者:

Iwauo Tajima

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

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

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

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
ResponseMessage	addRecord(Map<?> record) 電文のデータ部に、指定したレコードを追加する。
ResponseMessage	addRecord(Object recordObj) 電文のデータ部に指定したレコードを追加する。
ResponseMessage	addRecord(String recordType, Map<?> record) 電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。
ResponseMessage	addRecord(String recordType, Object recordObj) 電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。
ResponseMessage	setFwHeaderDefinition(nablarch.fw.messaging.FwHeaderDefinition def) フレームワークヘッダ定義を設定する。
ResponseMessage	setStatusCodeHeader(String statusCode) フレームワーク制御ヘッダの処理結果コードの値を設定する。

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

getBodyBytes, getBodyStream, setTimeToLive

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

getCorrelationId, getDestination, getHeaderMap, getMessageId, getParam, getParamMap, getRecordOf, getRecords, getRecordsOf, getReplyTo, setCorrelationId, setDestination, setFormatter, setMessageId, setReplyTo

インタフェースから継承されたメソッド nablarch.fw.Result

getMessage, getStatusCode, isSuccess

コンストラクタの詳細

ResponseMessage

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

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

パラメータ:

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

メソッドの詳細

setFwHeaderDefinition

@Published(tag="architect")
public ResponseMessage setFwHeaderDefinition(nablarch.fw.messaging.FwHeaderDefinition def)

フレームワークヘッダ定義を設定する。

パラメータ:

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

戻り値:

このオブジェクト自体

setStatusCodeHeader

@Published(tag="architect")
public ResponseMessage setStatusCodeHeader(String statusCode)

フレームワーク制御ヘッダの処理結果コードの値を設定する。

パラメータ:

statusCode - 処理結果コード

戻り値:

このオブジェクト自体

addRecord

@Published(tag="architect")
public ResponseMessage addRecord(Map<?> record)

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

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

オーバーライド:

addRecord クラス内 SendingMessage

パラメータ:

record - レコード内容

戻り値:

このオブジェクト自体

addRecord

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

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

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

オーバーライド:

addRecord クラス内 SendingMessage

パラメータ:

recordType - レコードタイプ

record - レコード内容

戻り値:

このオブジェクト自体

addRecord

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

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

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

オーバーライド:

addRecord クラス内 SendingMessage

パラメータ:

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

戻り値:

このオブジェクト自体

addRecord

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

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

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

オーバーライド:

addRecord クラス内 SendingMessage

パラメータ:

recordType - レコードタイプ

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

戻り値:

このオブジェクト自体