3. 開発手順¶
全体の流れ¶
IM-Propagation を使用したデータの伝搬は、下図のように行われます。
図 データの流れ処理全体では、おおまかに「送信側」（図中の SENDER）、「受信側」（図中の RECEIVER）、および、それらを接続する「IM-Propagation マネージャ」（図中の IM-Propagation Manager）の3つに分けられます。そのうち、本書では「送信側」と「受信側」に分けて、実装方法を説明します。処理の流れについての詳細は「IM-Propagation 仕様書」-「処理仕様」を参照してください。
依存関係の設定¶
データを送受信するためには、送信側・受信側ともに自身のモジュールに対して IM-Propagation モジュールを使用するための設定を行います。IM-Propagation を使用可能にするためには、モジュールプロジェクト直下に保存されている ＜module.xml＞ の「依存関係」に、以下のモジュールを追加します。
モジュールID jp.co.intra_mart.im_propagation バージョン 8.0.6 コラム
本書で解説している IM-Propagation の説明は、バージョン 8.0.6 時点の動作に基づいて記載されています。必要に応じて、 8.0.6 以上のバージョンを指定することができます。データ受信側のモジュールが、データ送信側のモジュールに依存する必要はありません。
データを送る¶
送信側の構成は、下図の通りです。
図 送信側の処理IM-Propagation を使用して、通知やデータを送るために必要な資材は、以下の通りです。
- 送信処理を行う実装クラス（図中の TRIGGER）
- 送信するデータを格納するためのクラス（図中の Data A）
- IM-Propagation にデータを送るためのクラス（図中の Generic A）
- Data A から Generic A に変換するためのデータ変換クラス（図中の Encoder）
- 使用するデータ変換クラスを定義するためのマッピング設定（図中の Mapping Table）
- 処理結果を格納するクラス（図中の Result A）
依存関係を設定した後、上記の資材を用意してください。各資材を用意する方法についての詳細は、「データを送る側の実装 」を参照してください。
データを受け取る¶
受信側の構成は、下図の通りです。
図 受信側の処理IM-Propagation を使用して送られた通知やデータを、送信側から受け取るために必要な資材は、以下の通りです。
- IM-Propagation からデータを受け取るためのクラス（図中の Generic B）
- 受信するデータを格納するためのクラス（図中の Data B）
- Generic B から Data B に変換するためのデータ変換クラス（図中の Decoder）
- 処理結果を格納するクラス（図中の Result B）
- Data B を受け取り処理するためのデータ処理クラス（図中の Procedure）
- 使用するデータ変換クラス、データ処理クラスを定義するためのマッピング設定（図中の Mapping Table）
依存関係を設定した後、上記の資材を用意してください。各資材を用意する方法の詳細は、「データを受け取る側の実装 」を参照してください。