intra-mart Accel Platform テナント環境セットアップ 仕様書 第5版 2016-12-01

前処理プログラム サンプル

サンプル内容

このサンプルは 前処理プログラム のJavaクラス・サーバサイドJavaScriptの各サンプルソースになります。 前処理プログラム を実装する場合は以下のサンプルを元に必要な実装を行ってください。

Javaクラス サンプル

Javaで 前処理プログラム を実装する場合は以下のインタフェースを継承したクラスを作成します。
  • jp.co.intra_mart.system.service.importer.preprocessing.ImportPreprocessor
package jp.co.intra_mart.foo.bar;

import jp.co.intra_mart.system.service.importer.preprocessing.ImportPreprocessingException;
import jp.co.intra_mart.system.service.importer.preprocessing.ImportPreprocessor;

public class SampleImportPreprocessor implements ImportPreprocessor {

    @Override
    public void execute() throws ImportPreprocessingException {
        try {
            // ここに前処理の処理内容を実装します。
            ...
        } catch (final Exception e) {
            throw new ImportPreprocessingException("前処理プログラム失敗時のメッセージ", e);
        }
    }

}
ImportPreprocessingExceptionがスローされた場合、セットアップを中断します。
そのため、それ以降の処理は実行されなくなります。
再度セットアップが実行された場合は、例外をスローした前処理プログラムから実行されます。

正常に終了した場合は再度セットアップを行っても実行されません。

コラム

サンプルデータインポートで前処理プログラムを使用している場合は、インポートが実行されるたびに前処理プログラムが実行されます。

サーバサイドJavaScript サンプル

サーバサイドJavaScriptで 前処理プログラム を実装する場合は execute 関数をもつJsファイルを作成します。
function execute() {
    // ここに前処理の処理内容を実装します。
    ...
    
    // 戻り値にはObject もしくは Boolean 型で処理結果を返却します。
    // 戻り値にBoolean 型を返却する場合は、true : エラー / false : 正常終了 となります。
    return {
        error : false,
        errorMessage : ''
    };
}

戻り値をBoolean型で返却する場合は、以下のように返却してください。

  • 正常終了の場合 : true
  • 失敗の場合 : false

戻り値をObject型で返却する場合は、以下のプロパティを持つオブジェクトを返却してください。

  • error : 失敗の場合、true(真偽値型)
  • errorMessage : 失敗時のメッセージ(文字列型)
戻り値に「失敗( false またはerrorプロパティが true のオブジェクト)」が返却された場合、セットアップを中断します。
そのため、それ以降の処理は実行されなくなります。
再度セットアップが実行された場合は、失敗を返却した前処理プログラムから実行されます。

正常に終了した場合は再度セットアップを行っても実行されません。

コラム

サンプルデータインポートで前処理プログラムを使用している場合は、インポートが実行されるたびに前処理プログラムが実行されます。