nablarch.fw.messaging

Class StructuredResponseMessage

java.lang.Object

nablarch.fw.messaging.InterSystemMessage<SendingMessage>

nablarch.fw.messaging.SendingMessage

nablarch.fw.messaging.ResponseMessage

nablarch.fw.messaging.StructuredResponseMessage

All Implemented Interfaces:

Result

public class StructuredResponseMessage
extends ResponseMessage

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

Author:

TIS

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
StructuredResponseMessage(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)と同様の処理を行う。

Methods inherited from class nablarch.fw.messaging.ResponseMessage

setFwHeaderDefinition, setStatusCodeHeader

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

StructuredResponseMessage

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

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

Parameters:

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

Method Detail

addRecord

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

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

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

Overrides:

addRecord in class ResponseMessage

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 ResponseMessage

Parameters:

recordType - レコードタイプ

record - レコード内容

Returns:

このオブジェクト自体

addRecord

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

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

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

Overrides:

addRecord in class ResponseMessage

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 ResponseMessage

Parameters:

recordType - レコードタイプ

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

Returns:

このオブジェクト自体