クラスの使用
nablarch.fw.messaging.ResponseMessage

ResponseMessageを使用しているパッケージ

パッケージ	説明
nablarch.fw.messaging	メッセージング処理方式の実装に直接関連するモジュールを格納するパッケージ。
nablarch.fw.messaging.action	応答なし電文を受送信するアクションを提供する。
nablarch.fw.messaging.handler	外部システムとのメッセージング処理において使用するハンドラを格納するパッケージ。

nablarch.fw.messagingでのResponseMessageの使用

nablarch.fw.messagingでのResponseMessageのサブクラス

修飾子とタイプ	クラスと説明
class	StructuredResponseMessage 構造化されたデータを取り扱うために、addRecord時にデータをすぐに書き込まず、メモリ上にキャッシュする応答メッセージ。

ResponseMessageを返すnablarch.fw.messagingのメソッド

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

ResponseMessage型のパラメータを持つnablarch.fw.messagingのコンストラクタ

コンストラクタと説明
ErrorResponseMessage(ResponseMessage response) コンストラクタ。
ErrorResponseMessage(ResponseMessage response, Throwable e) 元例外とエラー応答電文の内容指定し、インスタンスを生成する。

nablarch.fw.messaging.actionでのResponseMessageの使用

ResponseMessageを返すnablarch.fw.messaging.actionのメソッド

修飾子とタイプ	メソッドと説明
protected ResponseMessage	MessagingAction.onError(Throwable e, RequestMessage request, ExecutionContext context) 業務トランザクションが異常終了した場合の処理を実行する。
protected abstract ResponseMessage	MessagingAction.onReceive(RequestMessage request, ExecutionContext context) 要求電文毎にフレームワークから起動され、要求電文の内容をもとに業務処理を実行する。

nablarch.fw.messaging.handlerでのResponseMessageの使用

ResponseMessageを返すnablarch.fw.messaging.handlerのメソッド

修飾子とタイプ	メソッドと説明
protected ResponseMessage	MessageReplyHandler.errorResponseOf(Throwable e, ExecutionContext ctx) 後続ハンドラの処理中に未捕捉の例外が発生した場合に応答するエラー電文を作成する。