nablarch.fw.messaging

クラス RequestMessage

java.lang.Object

nablarch.fw.messaging.InterSystemMessage<ReceivedMessage>

nablarch.fw.messaging.ReceivedMessage

nablarch.fw.messaging.RequestMessage

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

Request<java.lang.Object>

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

StructuredRequestMessage

@Published
public class RequestMessage
extends ReceivedMessage
implements Request<java.lang.Object>

外部システムから受信した処理要求電文の内容を格納し、対応する応答電文を作成するクラス。

ReceivedMessageと比べて、以下の処理が追加されている。

• フレームワーク制御ヘッダ(FwHeader)を保持する
• 応答電文(ResponseMessage)オブジェクトを作成する

本クラスは以下のデータを格納する。

   1. プロトコルヘッダ (Map)
        - メッセージID (String)
        - 宛先キュー名 (String)   ...等
                 
   2.  フレームワーク制御ヘッダ (Map)
        - リクエストID (String)
        - ユーザID (String)
        - 再送制御フラグ (Boolean)
        - 処理結果ステータスコード (String)  ...等
                 
   3.  メッセージボディ(byte[])
      ※ フレームワーク制御ヘッダに相当するデータは含まれない。
 

このクラスはRequestインタフェースを実装しており、後続業務処理の入力となる。 (リクエストパスとして、フレームワーク制御ヘッダのリクエストIDを使用する。)

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

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

InterSystemMessage.HeaderName

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

コンストラクタ

コンストラクタと説明
RequestMessage(FwHeader header, ReceivedMessage message)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected ResponseMessage	createResponseMessage() 応答電文オブジェクトを作成する。
FwHeader	getFwHeader() フレームワーク制御ヘッダの内容を返す。
java.lang.String	getRequestPath() リクエストパスを取得する。
ResponseMessage	reply() この電文に対する応答電文(ResponseMessage)オブジェクトを作成する。
RequestMessage	setFormatterOfReply(DataRecordFormatter formatter) 応答電文のフォーマットを指定する。
RequestMessage	setRequestPath(java.lang.String requestPath) リクエストパスを設定する。

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

getBodyBytes, readRecord, readRecords

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

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

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

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

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

getParam, getParamMap

コンストラクタの詳細

RequestMessage

public RequestMessage(FwHeader header,
                      ReceivedMessage message)

パラメータ:

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

message - 受信電文オブジェクト(フレームワーク制御ヘッダに相当するデータが抜き出し済みであること)

メソッドの詳細

reply

public ResponseMessage reply()
                      throws java.lang.UnsupportedOperationException

この電文に対する応答電文(ResponseMessage)オブジェクトを作成する。

InterSystemMessage.setFormatter(nablarch.core.dataformat.DataRecordFormatter)で応答電文のフォーマットが指定されている場合はそれを設定する。 指定がなければ、InterSystemMessage.getFormatter()を実行し、電文共通のフォーマットを取得して設定する。

応答電文オブジェクトの生成については、createResponseMessage()を参照。

戻り値:

返信用電文オブジェクト

例外:

MessagingException - この電文にReplyToヘッダが指定されていない場合。

java.lang.UnsupportedOperationException

createResponseMessage

protected ResponseMessage createResponseMessage()

応答電文オブジェクトを作成する。

この実装では、応答電文オブジェクトのヘッダの設定は ResponseMessage.ResponseMessage(RequestMessage)にて行われる。

デフォルト以外の応答電文クラスを使用する場合はサブクラスで本メソッドをオーバーライドすること。

戻り値:

応答電文オブジェクト

getRequestPath

public java.lang.String getRequestPath()

リクエストパスを取得する。

定義:

getRequestPath インタフェース内 Request<java.lang.Object>

戻り値:

リクエストパス

例外:

java.lang.IllegalArgumentException - requestPathがnullか空文字である場合

setRequestPath

public RequestMessage setRequestPath(java.lang.String requestPath)

リクエストパスを設定する。

定義:

setRequestPath インタフェース内 Request<java.lang.Object>

パラメータ:

requestPath - リクエストパス

戻り値:

オブジェクト自体

getFwHeader

public FwHeader getFwHeader()

フレームワーク制御ヘッダの内容を返す。

戻り値:

フレームワーク制御ヘッダ部の内容

setFormatterOfReply

public RequestMessage setFormatterOfReply(DataRecordFormatter formatter)

応答電文のフォーマットを指定する。

パラメータ:

formatter - 応答電文のフォーマット

戻り値:

このオブジェクト自体