7.7.1. MOMメッセージング¶

7.7.1.1.1. 多様なMOMに対応できる¶

MOMメッセージングでは、多様なMOMに対応するため、 MessagingProvider インタフェースを設けている。 MOMに依存するMQ接続やメッセージ送受信は、このインタフェースを実装したクラスが行う。 そのため、 MessagingProvider インタフェースを実装したクラスを作成することで、 本機能を様々なMOMで使用することができる。

MOMメッセージングはJMSに対応しており、 JmsMessagingProvider を提供している。 詳細は、リンク先のJavadocを参照。

さらに、MOMとして利用実績が多い WebSphere MQ にも対応している。 詳細は、 IBM WebSphere MQアダプタ を参照。

7.7.1.3.1. MOMメッセージングを使うための設定を行う¶

MOMメッセージングでは、以下のクラスをコンポーネント定義に追加する。

• MessagingProvider の実装クラス (MQ接続、MQに対する送受信)
• メッセージングコンテキスト管理ハンドラ (MQ接続の管理)

以下に設定例を示す。

<!-- MessagingProviderの実装クラス -->
<component name="messagingProvider"
           class="nablarch.fw.messaging.provider.JmsMessagingProvider">
  <!-- 設定項目はJavadocを参照 -->
</component>

<!-- メッセージングコンテキスト管理ハンドラ -->
<component name="messagingContextHandler"
           class="nablarch.fw.messaging.handler.MessagingContextHandler">
  <property name="messagingProvider" ref="messagingProvider" />
</component>

さらに、メッセージ受信の場合は、データリーダの設定が必要となる。 以下のクラスをコンポーネント定義に追加する。

• MessageReader (MQから電文の読み込み)
• FwHeaderReader (電文からフレームワーク制御ヘッダの読み込み)

以下に設定例を示す。

ポイント

• データリーダのコンポーネント名には dataReader を指定する。
• MessageReader は FwHeaderReader の messageReader プロパティに指定する。

<!-- FwHeaderReader -->
<component name="dataReader"
           class="nablarch.fw.messaging.reader.FwHeaderReader">
  <!-- MessageReader -->
  <property name="messageReader">
    <component class = "nablarch.fw.messaging.reader.MessageReader">
      <!-- 設定項目はJavadocを参照 -->
    </component>
  </property>
</component>

7.7.1.3.2. 応答不要でメッセージを送信する(応答不要メッセージ送信)¶

外部システムに対してメッセージを送信する。

送信電文に設定する 共通プロトコルヘッダ の内容

設定する必要があるのは、基本的に送信宛先ヘッダのみである。

メッセージID:	設定不要(送信後に採番される)
関連メッセージID:	設定不要
送信宛先:	送信宛先の論理名
応答宛先:	設定不要
有効期間:	任意

応答不要メッセージ送信では、送信電文のデータを保持するテーブル(一時テーブルと呼ぶ)から送信対象のデータを取得し、 電文の作成及び送信を行う共通的なアクションとして、 AsyncMessageSendAction を提供している。 AsyncMessageSendAction は、 Nablarchバッチアプリケーション で動作するアクションクラスである。

AsyncMessageSendAction を使用することにより、以下の成果物のみを作成すればよく、 非常に簡単に電文の送信処理を実装できるようになっている。

• 送信電文のデータを保持する一時テーブル
• 電文のレイアウトを表すフォーマット定義ファイル
• SQLファイル(3種類のSQL文を定義する)

• ステータスが未送信のデータを取得するためのSELECT文
• 電文送信に成功した場合に、該当データのステータスを処理済みに更新するためのUPDATE文
• 電文送信に失敗した場合に、該当データのステータスを送信失敗に更新するためのUPDATE文

• ステータス更新用のフォームクラス

Exampleアプリケーション をベースに、 プロジェクト情報を送信する場合の実装例を以下に示す。

実装例

送信電文のデータを保持する一時テーブル

ポイント

• 主キーは、電文を一意に識別するためのIDを格納するカラムとする。
• テーブルの属性情報には、送信する電文の各項目に対応するカラムを定義する。
• 各プロジェクトの方式に合わせて共通項目(更新ユーザIDや更新日時など)を定義する。

INS_PROJECT_SEND_MESSAGE

送信電文連番(PK)	SEND_MESSAGE_SEQUENCE
プロジェクト名	PROJECT_NAME
プロジェクト種別	PROJECT_TYPE
プロジェクト分類	PROJECT_CLASS
：(省略)
ステータス	STATUS
更新ユーザID	UPDATED_USER_ID
更新日時	UPDATED_DATE

フォーマット定義ファイル

ポイント

• ファイル名は <送信電文のリクエストID>_SEND.fmt とする。

ProjectInsertMessage_SEND.fmt

file-type:        "Fixed" # 固定長
text-encoding:    "MS932" # 文字列型フィールドの文字エンコーディング
record-length:    2120    # 各レコードの長さ

[userData]
項目定義は省略

SQLファイル

ポイント

• ファイル名は <送信電文のリクエストID>.sql とする。
• SQL_IDは次の通りとする。

• SELECT_SEND_DATA: ステータスが未送信のデータを取得するためのSELECT文
• UPDATE_NORMAL_END: ステータスを処理済みに更新するためのUPDATE文
• UPDATE_ABNORMAL_END: ステータスを送信失敗に更新するためのUPDATE文

ProjectInsertMessage.sql

SELECT_SEND_DATA =
SELECT
    省略
FROM
    INS_PROJECT_SEND_MESSAGE
WHERE
    STATUS = '0'
ORDER BY
    SEND_MESSAGE_SEQUENCE

UPDATE_NORMAL_END =
UPDATE
    INS_PROJECT_SEND_MESSAGE
SET
    STATUS = '1',
    UPDATED_USER_ID = :updatedUserId,
    UPDATED_DATE = :updatedDate
WHERE
    SEND_MESSAGE_SEQUENCE = :sendMessageSequence

UPDATE_ABNORMAL_END =
UPDATE
    INS_PROJECT_SEND_MESSAGE
SET
    STATUS = '9',
    UPDATED_USER_ID = :updatedUserId,
    UPDATED_DATE = :updatedDate
WHERE
    SEND_MESSAGE_SEQUENCE = :sendMessageSequence

ステータス更新用のフォームクラス

ポイント

• このフォームクラスは、ステータス更新専用のクラスとなるため、 プロパティとして一時テーブルの属性を全て保持する必要はない。

SendMessagingForm.java

public class SendMessagingForm {

    /** 送信電文連番 */
    private String sendMessageSequence;

    /** 更新ユーザID */
    @UserId
    private String updatedUserId;

    /** 更新日時 */
    @CurrentDateTime
    private java.sql.Timestamp updatedDate;

    // コンストラクタとアクセッサは省略
}

AsyncMessageSendActionの設定

ポイント

• AsyncMessageSendAction を使用する場合は、送信先のキュー名やフォーマット定義ファイルの格納ディレクトリなどの設定が必要となる。 設定は、 AsyncMessageSendActionSettings をコンポーネント定義に追加することで行う。 設定項目については、リンク先のJavadocを参照。

messaging-async-send-component-configuration.xml

<component name="asyncMessageSendActionSettings"
           class="nablarch.fw.messaging.action.AsyncMessageSendActionSettings">
  <property name="formatDir" value="format" />
  <property name="headerFormatName" value="header" />
  <property name="queueName" value="TEST.REQUEST" />
  <property name="sqlFilePackage" value="com.nablarch.example.sql" />
  <property name="formClassName"
            value="com.nablarch.example.form.SendMessagingForm" />
  <property name="headerItemList">
    <list>
      <value>sendMessageSequence</value>
    </list>
  </property>
</component>

AsyncMessageSendActionの適用

ポイント

• AsyncMessageSendAction を Nablarchバッチアプリケーション で動作させるためには、 リクエストディスパッチハンドラ のコンポーネント定義で AsyncMessageSendAction を指定する。

messaging-async-send-component-configuration.xml

<component class="nablarch.fw.handler.RequestPathJavaPackageMapping">
  <property name="basePackage"
            value="com.nablarch.example.action.ExampleAsyncMessageSendAction" />
  <property name="immediate" value="false" />
</component>

7.7.1.3.3. 同期応答でメッセージを送信する(同期応答メッセージ送信)¶

外部システムに対してメッセージを送信し、その応答を待機する。応答メッセージを受信するか、待機タイムアウト時間が経過するまでブロックする。

応答不要でメッセージを送信する(応答不要メッセージ送信) とは異なり、応答電文を受信するので、 通信先で処理が正しく行われることをある程度保証することができる。 ただし、何らかの問題により、規定時間内に応答を受信できずにタイムアウトした場合は、何らかのエラー処理(例えば、電文の再試行や障害通知など)を行う必要がある。

送信電文に設定する 共通プロトコルヘッダ の内容

送信宛先ヘッダに加え、応答時の送信宛先となる応答宛先ヘッダを設定しておく必要がある。

メッセージID:	設定不要(送信後に採番される)
関連メッセージID:	設定不要
送信宛先:	送信宛先の論理名
応答宛先:	応答宛先の論理名
有効期間:	任意

外部システムが作成する応答電文の 共通プロトコルヘッダ の内容

送信処理完了後、アプリケーションは、送信した電文のメッセージIDと同じ関連メッセージIDをもつ電文が応答宛先上で受信されるまで待機する。 そのため、外部システムは応答電文に関連メッセージIDを設定しておく必要がある。

メッセージID:	設定不要(送信後に採番される)
関連メッセージID:	送信電文のメッセージIDヘッダの値
送信宛先:	送信電文の応答宛先ヘッダの値
応答宛先:	設定不要
有効期間:	任意

同期応答メッセージ送信では、定型的な処理をラップしたユーティリティクラスとして、 MessageSender を提供している。 MessageSender を使用することにより、以下の成果物のみを作成すればよく、 簡便に同期応答メッセージの送信処理を作成できるようになっている。

• 送受信に使用するフォーマット定義ファイル
• MessageSender を使った送受信処理

Exampleアプリケーション をベースに、 テーブルに格納された送信データから、 バッチアクションでプロジェクト情報を送信する場合の実装例を以下に示す。 テーブルからのデータ読み込み部分は、メッセージ送信に関係しないので実装例を省略する。

実装例

送受信に使用するフォーマット定義ファイル

ポイント

• ファイル名は以下とする。

• 送信用： <電文のリクエストID>_SEND.fmt
• 受信用： <電文のリクエストID>_RECEIVE.fmt

• レコードタイプ名は data 固定である。

ProjectInsertMessage_SEND.fmt

file-type:        "Fixed" # 固定長
text-encoding:    "MS932" # 文字列型フィールドの文字エンコーディング
record-length:    2120    # 各レコードの長さ
record-separator: "\r\n"  # 改行コード

[data]
項目定義は省略

ProjectInsertMessage_RECEIVE.fmt

file-type:        "Fixed" # 固定長
text-encoding:    "MS932" # 文字列型フィールドの文字エンコーディング
record-length:    130     # 各レコードの長さ
record-separator: "\r\n"  # 改行コード

[data]
項目定義は省略

MessageSenderを使った送受信処理

ポイント

• 要求電文は、 SyncMessage で作成する。
• メッセージ送信には、 MessageSender#sendSync を使用する。 使い方については、リンク先のJavadocを参照。

SendProjectInsertMessageAction.java

public Result handle(SqlRow inputData, ExecutionContext ctx) {

    // インプットデータを使った業務処理は省略

    SyncMessage responseMessage = null;
    try {
        responseMessage = MessageSender.sendSync(
            new SyncMessage("ProjectInsertMessage").addDataRecord(inputData));
    } catch (MessagingException e) {
        // 送信エラー
        throw new TransactionAbnormalEnd(100, e, "error.sendServer.fail");
    }

    Map<String, Object> responseDataRecord = responseMessage.getDataRecord();

    // レスポンスデータを使った業務処理は省略

    return new Success();
}

MessageSenderの設定

ポイント

• MessageSender を使用する場合は、 送受信先のキュー名やフォーマット定義ファイルの格納ディレクトリなどの設定が必要となる。 設定は、 環境依存値を設定する により行う。 設定項目については、 MessageSenderSettings を参照。

messaging.config

messageSender.DEFAULT.messagingProviderName=defaultMessagingProvider
messageSender.DEFAULT.destination=TEST.REQUEST
messageSender.DEFAULT.replyTo=TEST.RESPONSE
messageSender.DEFAULT.retryCount=10
messageSender.DEFAULT.formatDir=format
messageSender.DEFAULT.headerFormatName=HEADER
messageSender.DEFAULT.messageConvertorName=defaultSyncMessageConvertor

7.7.1.3.4. 応答不要でメッセージを受信する(応答不要メッセージ受信)¶

特定の宛先に送信されるメッセージを受信する。メッセージを受信するか待機タイムアウト時間が経過するまでブロックする。

外部システムが作成する受信電文の 共通プロトコルヘッダ の内容

メッセージID:	設定不要(送信後に採番される)
関連メッセージID:	設定不要
送信宛先:	宛先の論理名
応答宛先:	設定不要
有効期間:	任意

応答不要メッセージ受信では、受信した電文を一時テーブル(電文受信テーブル)に保存するための共通的なアクションとして、 AsyncMessageReceiveAction を提供している。 AsyncMessageReceiveAction は、MOMによるメッセージング で動作するアクションクラスである。

AsyncMessageReceiveAction を使用することにより、以下の成果物のみを作成すればよく、 非常に簡易的に電文をテーブルに保存することが可能となっている。

• 電文を登録するための一時テーブル
• 電文のレイアウトを表すフォーマット定義ファイル
• 電文を登録するためのINSERT文(SQLファイル)
• 電文を登録する際に使用するフォームクラス

Exampleアプリケーション をベースに、 プロジェクト情報を受信する場合の実装例を以下に示す。

実装例

電文を登録するための一時テーブル

ポイント

• 受信した電文は、電文の種類毎に専用の一時テーブルに保存する。
• 主キーは、電文を一意に識別するためのIDを格納するカラムとする。 このカラムに格納する値は、 サロゲートキーの採番 を用いてフレームワークで採番を行う。
• テーブルの属性情報には、受信した電文の各項目に対応するカラムを定義する。
• 各プロジェクトの方式に合わせて共通項目(登録ユーザIDや登録日時など)を定義する。

INS_PROJECT_RECEIVE_MESSAGE

受信メッセージ連番(PK)	RECEIVED_MESSAGE_SEQUENCE
プロジェクト名	PROJECT_NAME
プロジェクト種別	PROJECT_TYPE
プロジェクト分類	PROJECT_CLASS
：(省略)
ステータス	STATUS
登録ユーザID	INSERT_USER_ID
登録日時	INSERT_DATE

フォーマット定義ファイル

ポイント

• ファイル名は <受信電文のリクエストID>_RECEIVE.fmt とする。

ProjectInsertMessage_RECEIVE.fmt

file-type:        "Fixed" # 固定長
text-encoding:    "MS932" # 文字列型フィールドの文字エンコーディング
record-length:    2120    # 各レコードの長さ

[userData]
項目定義は省略

SQLファイル

ポイント

• ファイル名は <受信電文のリクエストID>.sql とする。
• SQL_IDは INSERT_MESSAGE とする。

ProjectInsertMessage.sql

INSERT_MESSAGE =
INSERT INTO INS_PROJECT_RECEIVE_MESSAGE (
    RECEIVED_MESSAGE_SEQUENCE,
    PROJECT_NAME,
    PROJECT_TYPE,
    PROJECT_CLASS,
    以下省略

電文を登録する際に使用するフォームクラス

ポイント

• クラス名は <受信電文のリクエストID>Form とする。
• String、RequestMessage の2つの引数を持つコンストラクタを定義する。それぞれのパラメータの意味は以下の通り。
  • String -> 受信電文連番
  • RequestMessage -> 受信電文

ProjectInsertMessageForm.java

public class ProjectInsertMessageForm {

    /** 受信電文連番 */
    private String receivedMessageSequence;

    /** プロジェクト名 */
    private String projectName;

    // 他のフィールドは省略

    public ProjectInsertMessageForm(
            String receivedMessageSequence, RequestMessage message) {
        this.receivedMessageSequence = receivedMessageSequence;

        DataRecord data = message.getRecordOf("userData");

        projectName = data.getString("projectName");

        // 以降の処理は省略
    }

    // アクセッサは省略
}

AsyncMessageReceiveActionの設定

ポイント

• AsyncMessageReceiveAction を使用する場合は、フォーマット定義ファイルやSQLファイルの配置場所などの設定が必要となる。 設定は、 AsyncMessageReceiveActionSettings をコンポーネント定義に追加することで行う。 設定項目については、リンク先のJavadocを参照。

messaging-async-receive-component-configuration.xml

<component name="asyncMessageReceiveActionSettings"
           class="nablarch.fw.messaging.action.AsyncMessageReceiveActionSettings">
  <property name="formClassPackage" value="com.nablarch.example.form" />
  <property name="receivedSequenceFormatter">
    <component class="nablarch.common.idgenerator.formatter.LpadFormatter">
      <property name="length" value="10" />
      <property name="paddingChar" value="0" />
    </component>
  </property>
  <property name="receivedSequenceGenerator" ref="idGenerator" />
  <property name="targetGenerateId" value="9991" />
  <property name="sqlFilePackage" value="com.nablarch.example.sql" />
</component>

AsyncMessageReceiveActionの適用

ポイント

• AsyncMessageReceiveAction を MOMによるメッセージング で動作させるためには、 リクエストディスパッチハンドラ のコンポーネント定義で AsyncMessageReceiveAction を指定する。

messaging-async-receive-component-configuration.xml

<component class="nablarch.fw.handler.RequestPathJavaPackageMapping">
  <property name="basePackage"
            value="nablarch.fw.messaging.action.AsyncMessageReceiveAction" />
  <property name="immediate" value="false" />
</component>

7.7.1.3.5. 同期応答でメッセージを受信する(同期応答メッセージ受信)¶

通信先から特定の宛先に送信されるメッセージを受信し、そこに設定されていた応答宛先に対して応答電文を送信する。 このとき、受信した電文のメッセージIDヘッダの値を、応答電文の関連メッセージIDヘッダに設定する。

送信電文に設定する 共通プロトコルヘッダ の内容

メッセージID:	設定不要(送信後に採番される)
関連メッセージID:	受信電文のメッセージIDヘッダの値
送信宛先:	受信電文の応答宛先ヘッダの値
応答宛先:	設定不要
有効期間:	任意

同期応答メッセージ受信では、定型的な処理を行うテンプレートクラスとして、 MessagingAction を提供している。 MessagingAction は、 MOMによるメッセージング で動作するアクションクラスである。

MessagingAction を使用することにより、以下の成果物のみを作成すればよい。

• 電文のレイアウトを表すフォーマット定義ファイル
• 電文受信時とエラー発生時の処理(アクションクラス)

Exampleアプリケーション をベースに、 プロジェクト情報を受信する場合の実装例を以下に示す。

実装例

フォーマット定義ファイル

ポイント

• ファイル名は以下とする。

• 受信用： <電文のリクエストID>_RECEIVE.fmt
• 送信用： <電文のリクエストID>_SEND.fmt

ProjectInsertMessage_RECEIVE.fmt

file-type:        "Fixed" # 固定長
text-encoding:    "MS932" # 文字列型フィールドの文字エンコーディング
record-length:    2120    # 各レコードの長さ
record-separator: "\r\n"  # 改行コード

[data]
項目定義は省略

ProjectInsertMessage_SEND.fmt

file-type:        "Fixed" # 固定長
text-encoding:    "MS932" # 文字列型フィールドの文字エンコーディング
record-length:    130     # 各レコードの長さ
record-separator: "\r\n"  # 改行コード

[data]
項目定義は省略

電文受信時とエラー発生時の処理(アクションクラス)

ポイント

• MessagingAction を継承し、 以下のメソッドをオーバーライドする。

  • MessagingAction#onReceive
  • MessagingAction#onError

• 応答電文は、 RequestMessage#reply で作成する。

• 要求電文と応答電文の内容を保持するため、それぞれに対応したフォームクラスを作成する。

ProjectInsertMessageAction.java

public class ProjectInsertMessageAction extends MessagingAction {

    @Override
    protected ResponseMessage onReceive(
            RequestMessage request, ExecutionContext context) {
         ProjectInsertMessageForm projectInsertMessageForm
            = BeanUtil.createAndCopy(
                ProjectInsertMessageForm.class, request.getParamMap());

        // バリデーション処理を行う。エラー検知時は、ApplicationExceptionが送出される。
        ValidatorUtil.validate(projectInsertMessageForm);

        ProjectTemp projectTemp
            = BeanUtil.createAndCopy(
                ProjectTemp.class, projectInsertMessageForm);

        // データ設定は省略

        UniversalDao.insert(projectTemp);

        // 応答データ返却
        ProjectInsertMessageResponseForm resForm
            = new ProjectInsertMessageResponseForm();
        resForm.setReturnCode("success");
        return request.reply().addRecord(resForm);
    }

    @Override
    protected ResponseMessage onError(
            Throwable e, RequestMessage request, ExecutionContext context) {
        ProjectInsertMessageResponseForm resForm =
                new ProjectInsertMessageResponseForm(
                    "fatal", "unexpecteed exception.");

        if (e instanceof InvalidDataFormatException) {
            //要求電文データレコード部レイアウト不正
            resForm.setReturnCode("fatal");
            resForm.setDetail("invalid layout.");
        } else if (e instanceof ApplicationException) {
            //要求電文データレコード部項目精査エラー
            resForm.setReturnCode("error.validation");
            resForm.setDetail("");
        }
        return request.reply().addRecord(resForm);
    }
}

7.7.1.4.1. フレームワーク制御ヘッダの読み書きを変更する¶

外部システムで既に電文フォーマットが規定されている場合など、 フレームワーク制御ヘッダの読み書きを変更したい場合がある。 この場合は、プロジェクトで実装を追加することで対応する。 以下に、送受信の種類ごとに対応方法を示す。

応答不要メッセージ送信の場合

フレームワーク制御ヘッダの書き込みは、以下のメソッドにより行っているので、 以下のメソッドをオーバーライドして対応すればよい。

• AsyncMessageSendAction#createHeaderRecordFormatter
• AsyncMessageSendAction#createHeaderRecord

同期応答メッセージ送信の場合

MessageSender では、送受信する電文の変換処理を変更できるように、 変換処理を SyncMessageConvertor に委譲しており、 このクラスがフレームワーク制御ヘッダの読み書きを行っている。

そのため、SyncMessageConvertor を継承したクラスを作成し、 MessageSender の設定に指定すればよい。 MessageSender の設定については、 MessageSenderSettings を参照。

応答不要メッセージ受信の場合

フレームワーク制御ヘッダの読み込みは、 FwHeaderReader に設定された FwHeaderDefinition インタフェースを実装したクラスが行う。 デフォルトでは、 StandardFwHeaderDefinition が使用される。

そのため、 StandardFwHeaderDefinition を参考に、 プロジェクトで FwHeaderDefinition インタフェースを実装したクラスを作成し、 コンポーネント定義で FwHeaderReader#fwHeaderDefinition プロパティに指定すればよい。

同期応答メッセージ受信の場合

フレームワーク制御ヘッダの読み込みは、 応答不要メッセージ受信の場合 と同じである。

フレームワーク制御ヘッダの書き込みについても、 FwHeaderDefinition インタフェースを実装したクラスを作成することは同じであるが、 コンポーネント定義で作成したクラスを 電文応答制御ハンドラ の fwHeaderDefinition プロパティに指定すればよい。