IM-Propagation 送信側設定¶
概要¶
IM-Propagation を利用してデータを伝搬するための送信側を設定します。送信するデータを格納するクラスと、データ変換クラスを紐付けるための設定です。IM-Propagation を利用してデータを他モジュールへ伝搬するためには、送信側の設定が必要です。データを伝搬する際に他モジュールとの依存関係を切り離す必要があるため、データは IM-Propagation 側に用意されている共通モデルクラスを利用します。データの送信側は自モジュールで定義されている独自のモデルから、IM-Propagation 用のモデルへデータをコピーさせる必要があります。そこで、データをコピーする作業を行うデータ変換クラスの設定を行います。
モジュール IM-Propagation フォーマットファイル(xsd) WEB-INF/schema/propagation-senders-config.xsd 設定場所 WEB-INF/conf/propagation-senders-config/{任意のファイル名}.xml 注意
ファイル名は、他のモジュールが提供しているものと重複しないようにしてください。<?xml version="1.0" encoding="UTF-8"?> <propagation-senders-config xmlns="http://www.intra-mart.jp/propagation/senders-config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.intra-mart.jp/propagation/senders-config propagation-senders-config.xsd"> <sender source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED"> <encoder class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationEncoder"> <params> <param key="key1">value1</param> <param key="key2">value2</param> </params> </encoder> <required-procedure class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationProcedure" /> </sender> </propagation-senders-config>
リファレンス¶
送信データ定義の設定¶
タグ名 sender IM-Propagation を使用してデータを送信する側が送信するデータの型と処理内容を定義します。【設定項目】
<propagation-senders-config> <sender source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED"> ・・・・・ </sender> </propagation-senders-config>
必須項目 × 複数設定 ○ 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ propagation-senders-config 【属性】
属性名 説明 必須 デフォルト値 source データ送信側が IM-Propagation に渡すクラスの完全修飾クラス名です。 ○ なし operationType データ送信側が IM-Propagation に渡すデータの処理内容です。 ○ なし コラム
operationType 属性には IM-Propagation によりいくつかの候補が用意されていますので、基本的にはそれをご利用ください。自モジュール内で完結する伝搬処理の場合は、独自の operationType を定義することができます。注意
source 属性に定義されていないクラスが IM-Propagation に渡された場合、伝搬処理は失敗します。送られるデータの定義は必ず設定ファイルに記述してください。
送信側データ変換クラスの設定¶
タグ名 encoder 送信側のデータを IM-Propagation 用のデータに変換するための、データ変換クラスを定義します。【設定項目】
<propagation-senders-config> <sender source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED"> <encoder class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationEncoder" /> </sender> </propagation-senders-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ sender 【属性】
属性名 説明 必須 デフォルト値 class データ変換クラスの完全修飾クラス名です。 ○ なし 注意
class 属性に指定したクラスが見つからない場合や適切なインタフェースを実装していない場合、伝搬処理は失敗します。
データ変換クラスパラメータの設定¶
タグ名 params データ変換クラスに受け渡す任意のパラメータ情報を設定します。【設定項目】
<propagation-senders-config> <sender source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED"> <encoder class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationEncoder"> <params> ・・・・・ </params> </encoder> </sender> </propagation-senders-config>
必須項目 × 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ encoder
データ変換クラスのパラメータ値の設定¶
タグ名 param データ変換クラスに受け渡す任意のパラメータ情報を設定します。【設定項目】
<propagation-senders-config> <sender source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED"> <encoder class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationEncoder"> <params> <param key="key1">value1</param> <param key="key2">value2</param> </params> </encoder> </sender> </propagation-senders-config>
必須項目 × 複数設定 ○ 設定値・設定する内容 任意のパラメータ値 単位・型 文字列 省略時のデフォルト値 空文字 親タグ params 【属性】
属性名 説明 必須 デフォルト値 key パラメータ値を取得するためのキー。 ○ なし
必須呼出データ処理クラスの設定¶
タグ名 required-procedure IM-Propagation でデータを必ず受け取って欲しい受信側のデータ処理クラスを指定します。【設定項目】
<propagation-senders-config> <sender source="jp.co.intra_mart.foundation.sample.model.SampleModel" operationType="DATA_CREATED"> <required-procedure class="jp.co.intra_mart.system.sample.propagation.SampleModelPropagationProcedure" /> </sender> </propagation-senders-config>
必須項目 × 複数設定 ○ 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ sender 【属性】
属性名 説明 必須 デフォルト値 class データ受信側のデータ処理クラスの完全修飾クラス名です。 ○ なし 注意
class 属性に指定したクラスに対してデータが送信されなかった場合、伝搬処理は失敗します。