nablarch.fw.messaging

Class ResponseMessage

java.lang.Object

nablarch.fw.messaging.InterSystemMessage<SendingMessage>

nablarch.fw.messaging.SendingMessage

nablarch.fw.messaging.ResponseMessage

All Implemented Interfaces:

Result

Direct Known Subclasses:

StructuredResponseMessage

public class ResponseMessage
extends SendingMessage
implements Result

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

Author:

Iwauo Tajima

Nested Class Summary

Nested classes/interfaces inherited from interface nablarch.fw.Result

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseMessage	addRecord(java.util.Map<?> record) 電文のデータ部に、指定したレコードを追加する。 出力時に使用するデータレイアウト（レコードタイプ）は、recordの内容から自動的に判別される。
ResponseMessage	addRecord(java.lang.Object recordObj) 電文のデータ部に指定したレコードを追加する。 出力時に使用するデータレイアウト（レコードタイプ）は、渡されたデータの内容から自動的に判別される。
ResponseMessage	addRecord(java.lang.String recordType, java.util.Map<?> record) 電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。 recordTypeにnullを渡した場合、SendingMessage.addRecord(Map)と同様の処理を行う。
ResponseMessage	addRecord(java.lang.String recordType, java.lang.Object recordObj) 電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。 recordTypeにnullを渡した場合、SendingMessage.addRecord(Object)と同様の処理を行う。
ResponseMessage	setFwHeaderDefinition(nablarch.fw.messaging.FwHeaderDefinition def) フレームワークヘッダ定義を設定する。
ResponseMessage	setStatusCodeHeader(java.lang.String statusCode) フレームワーク制御ヘッダの処理結果コードの値を設定する。

Methods inherited from class nablarch.fw.messaging.SendingMessage

getBodyBytes, getBodyStream, setTimeToLive

Methods inherited from class nablarch.fw.messaging.InterSystemMessage

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

Methods inherited from interface nablarch.fw.Result

getMessage, getStatusCode, isSuccess

Constructor Detail

ResponseMessage

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

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

Parameters:

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

Method Detail

setFwHeaderDefinition

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

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

Parameters:

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

Returns:

このオブジェクト自体

setStatusCodeHeader

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

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

Parameters:

statusCode - 処理結果コード

Returns:

このオブジェクト自体

addRecord

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

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

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

Overrides:

addRecord in class SendingMessage

Parameters:

record - レコード内容

Returns:

このオブジェクト自体

addRecord

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

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

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

Overrides:

addRecord in class SendingMessage

Parameters:

recordType - レコードタイプ

record - レコード内容

Returns:

このオブジェクト自体

addRecord

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

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

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

Overrides:

addRecord in class SendingMessage

Parameters:

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

Returns:

このオブジェクト自体

addRecord

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

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

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

Overrides:

addRecord in class SendingMessage

Parameters:

recordType - レコードタイプ

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

Returns:

このオブジェクト自体