intra-mart Accel Platform 設定ファイルリファレンス 第26版 2020-08-01

IM-Propagation 受信側設定

概要

IM-Propagation を利用してデータを伝搬するための受信側を設定します。
受信するデータを格納するクラスと、データ変換クラスを紐付けるための設定です。

IM-Propagation を利用してデータを他モジュールから伝搬するためには、受信側の設定が必要です。

データを伝搬する際に他モジュールとの依存関係を切り離す必要があるため、データは IM-Propagation 側に用意されている共通モデルクラスを利用します。
データの受信側は IM-Propagation 用のモデルから自モジュールで定義されている独自のモデルへデータをコピーさせる必要があります。
そこで、データをコピーする作業を行うデータ変換クラスの設定を行います。

また、受信したデータをもとに処理を行うデータ処理クラスの設定も同時に行います。

モジュール IM-Propagation
フォーマットファイル(xsd) WEB-INF/schema/propagation-receivers-config.xsd
設定場所 WEB-INF/conf/propagation-receivers-config/{任意のファイル名}.xml

注意

ファイル名は、他のモジュールが提供しているものと重複しないようにしてください。

<?xml version="1.0" encoding="UTF-8"?>
<propagation-receivers-config xmlns="http://www.intra-mart.jp/propagation/receivers-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.intra-mart.jp/propagation/receivers-config propagation-receivers-config.xsd">
  <receiver source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED">
    <decoder class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationDecoder">
      <params>
        <param key="key1">value1</param>
        <param key="key2">value2</param>
      </params>
    </decoder>
    <procedure class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationProcedure">
      <params>
        <param key="key1">value1</param>
        <param key="key2">value2</param>
      </params>
    </procedure>
  </receiver>
</propagation-receivers-config>

リファレンス

受信データ定義の設定

タグ名 receiver
IM-Propagation を使用してデータを受信する側が受信するデータの型と処理内容を定義します。

【設定項目】

<propagation-receivers-config>
  <receiver source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED">
    ・・・・・
  </receiver>
</propagation-receivers-config>

必須項目 ×
複数設定
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ propagation-receivers-config

【属性】

属性名 説明 必須 デフォルト値
source データ送信側が IM-Propagation に渡すクラスの完全修飾クラス名です。 なし
operationType データ送信側が IM-Propagation に渡すデータの処理内容です。 なし

コラム

source 属性には IM-Propagation 用のデータが格納されたクラスの完全修飾クラス名を指定することもできます。
これにより、データの送信側を意識せず、常に共通的なデータを受け取ることができます。

注意

データ送信側設定の sender タグに設定された source と operationType 属性に一致するデータを受け取った場合に、ここで定義された受信側設定が使用されます。
存在しないクラスや operationType が指定されている場合は、設定内容を無視します。

受信側データ変換クラスの設定

タグ名 decoder
IM-Propagation 用のデータを受信側のデータに変換するための、データ変換クラスを定義します。

【設定項目】

<propagation-receivers-config>
  <receiver source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED">
    <decoder class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationDecoder" />
  </receiver>
</propagation-receivers-config>

必須項目
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ receiver

【属性】

属性名 説明 必須 デフォルト値
class データ変換クラスの完全修飾クラス名です。 なし

注意

class 属性に指定したクラスが見つからない場合や適切なインタフェースを実装していない場合、この設定は無視されます。
この場合、データを受信することができませんので注意してください。

データ変換クラスパラメータの設定

タグ名 params
データ変換クラスに受け渡す任意のパラメータ情報を設定します。

【設定項目】

<propagation-receivers-config>
  <receiver source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED">
    <decoder class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationDecoder">
      <params>
        ・・・・・
      </params>
    </decoder>
  </receiver>
</propagation-receivers-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ decoder

データ変換クラスのパラメータ値の設定

タグ名 param
データ変換クラスに受け渡す任意のパラメータ情報を設定します。

【設定項目】

<propagation-receivers-config>
  <receiver source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED">
    <decoder class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationDecoder">
      <params>
        <param key="key1">value1</param>
        <param key="key2">value2</param>
      </params>
    </decoder>
  </receiver>
</propagation-receivers-config>

必須項目 ×
複数設定
設定値・設定する内容 任意のパラメータ値
単位・型 文字列
省略時のデフォルト値 空文字
親タグ params

【属性】

属性名 説明 必須 デフォルト値
key パラメータ値を取得するためのキー。 なし

受信側データ処理クラスの設定

タグ名 procedure
データ変換クラスによって変換されたデータを処理するための、データ処理クラスを定義します。

【設定項目】

<propagation-receivers-config>
  <receiver source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED">
    <procedure class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationProcedure" />
  </receiver>
</propagation-receivers-config>

必須項目
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ receiver

【属性】

属性名 説明 必須 デフォルト値
class データ処理クラスの完全修飾クラス名です。 なし

注意

class 属性に指定したクラスが見つからない場合や適切なインタフェースを実装していない場合、この設定は無視されます。
この場合、データを受信することができませんので注意してください。

データ処理クラスパラメータの設定

タグ名 params
データ処理クラスに受け渡す任意のパラメータ情報を設定します。

【設定項目】

<propagation-receivers-config>
  <receiver source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED">
    <procedure class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationProcedure">
      <params>
        ・・・・・
      </params>
    </procedure>
  </receiver>
</propagation-receivers-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ procedure

データ処理クラスのパラメータ値の設定

タグ名 param
データ処理クラスに受け渡す任意のパラメータ情報を設定します。

【設定項目】

<propagation-receivers-config>
  <receiver source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED">
    <procedure class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationProcedure">
      <params>
        <param key="key1">value1</param>
        <param key="key2">value2</param>
      </params>
    </procedure>
  </receiver>
</propagation-receivers-config>

必須項目 ×
複数設定
設定値・設定する内容 任意のパラメータ値
単位・型 文字列
省略時のデフォルト値 空文字
親タグ params

【属性】

属性名 説明 必須 デフォルト値
key パラメータ値を取得するためのキー。 なし