RequestMessage (NablarchApi)

java.lang.Object
- nablarch.fw.messaging.InterSystemMessage
- - nablarch.fw.messaging.ReceivedMessage
  - - nablarch.fw.messaging.RequestMessage

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

Request
```
@Published
public class RequestMessage
extends nablarch.fw.messaging.ReceivedMessage
implements Request
```
外部システムから受信した処理要求電文の内容を格納し、対応する応答電文を作成するクラス。
ReceivedMessageと比べて、以下の処理が追加されている。
- フレームワーク制御ヘッダ(FwHeader)を保持する
- 応答電文(ResponseMessage)オブジェクトを作成する
本クラスは以下のデータを格納する。
```
   1. プロトコルヘッダ (Map)
        - メッセージID (String)
        - 宛先キュー名 (String)   ...等
                 
   2.  フレームワーク制御ヘッダ (Map)
        - リクエストID (String)
        - ユーザID (String)
        - 再送制御フラグ (Boolean)
        - 処理結果ステータスコード (String)  ...等
                 
   3.  メッセージボディ(byte[])
      ※ フレームワーク制御ヘッダに相当するデータは含まれない。
 
```
このクラスはRequestインタフェースを実装しており、後続業務処理の入力となる。 (リクエストパスとして、フレームワーク制御ヘッダのリクエストIDを使用する。)
作成者:

Iwauo Tajima

メソッドのサマリー

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

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

- メソッドの詳細
  - reply
```
public nablarch.fw.messaging.ResponseMessage reply()
```
    この電文に対する応答電文(ResponseMessage)オブジェクトを作成する。
    RequestMessage#setFormatterで応答電文のフォーマットが指定されている場合はそれを設定する。指定がなければ、InterSystemMessage#getFormatterを実行し、電文共通のフォーマットを取得して設定する。
    応答電文オブジェクトの生成については、RequestMessage.createResponseMessage()を参照。
    
    戻り値:
    
    返信用電文オブジェクト
    
    例外:
    
    nablarch.fw.messaging.MessagingException - この電文にReplyToヘッダが指定されていない場合。
  - createResponseMessage
```
protected nablarch.fw.messaging.ResponseMessage createResponseMessage()
```
    応答電文オブジェクトを作成する。
    この実装では、応答電文オブジェクトのヘッダの設定は ResponseMessage#ResponseMessage(RequestMessage)にて行われる。
    デフォルト以外の応答電文クラスを使用する場合はサブクラスで本メソッドをオーバーライドすること。
    
    戻り値:
    
    応答電文オブジェクト
  - getRequestPath
```
public String getRequestPath()
```
    リクエストパスを取得する。
    
    定義:
    
    getRequestPath インタフェース内 Request
    
    戻り値:
    
    リクエストパス
    
    例外:
    
    IllegalArgumentException - requestPathがnullか空文字である場合
  - setRequestPath
```
public RequestMessage setRequestPath(String requestPath)
```
    リクエストパスを設定する。
    
    定義:
    
    setRequestPath インタフェース内 Request
    
    パラメータ:
    
    requestPath - リクエストパス
    
    戻り値:
    
    オブジェクト自体
  - getFwHeader
```
public nablarch.fw.messaging.FwHeader getFwHeader()
```
    フレームワーク制御ヘッダの内容を返す。
    
    戻り値:
    
    フレームワーク制御ヘッダ部の内容
  - setFormatterOfReply
```
public RequestMessage setFormatterOfReply(DataRecordFormatter formatter)
```
    応答電文のフォーマットを指定する。
    
    パラメータ:
    
    formatter - 応答電文のフォーマット
    
    戻り値:
    
    このオブジェクト自体

クラス RequestMessage

メソッドのサマリー

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

メソッドの詳細

reply

createResponseMessage

getRequestPath

setRequestPath

getFwHeader

setFormatterOfReply