ScriptRunnerProxy

ScriptRunnerProxyとは

ScriptRunnerProxyの使用方法

環境設定

• Java Development Kit 6以降

事前に必要な情報

• 「ホスト名/IPアドレス」および「ポート番号」
• 「ユーザ名」および「パスワード」
• 「サービス名」および「スクリプト名」(サービス名のデフォルト形式は<ユーザ名>@<プロジェクト名>となります。)

実行手順

1. Java APIを使用し、Javaプログラムを作成します。


2. Javaプログラムをコンパイルし、Javaアプリケーションを生成します。


3. Javaアプリケーションを実行します。

Javaプログラムの作成方法

クラスパスの設定

• dssrconnection.jar
  $DATASPIDER_HOME/server/system/common/libディレクトリ内

プログラム作成の流れ

1. ScriptRunnerConnectionManagerのインスタンスを取得します。


2. ScriptRunnerConnectionManagerからScriptRunnerConnectionFactoryを生成します。


3. ScriptRunnerConnectionFactoryに接続に必要な情報をセットします。
   接続にはホスト名、ポート番号、実行ユーザ、実行ユーザのパスワードが必要です。


4. ScriptRunnerConnectionFactoryからScriptRunnerConnectionを生成します。ScriptRunnerConnectionは、スクリプトを実行するにあたり、スクリプトの実行エンジンであるDataSpiderServerとの接続を行うクラスとなります。


5. ScriptRunnerParamを作成します。ScriptRunnerParamには、スクリプトの所在や引数情報などのスクリプトを実行する際の各種パラメータを設定します。


6. ScriptPKを作成します。ScriptPKは、スクリプトを一意に表すクラスです。ScriptPKには、サービス名やスクリプト名を設定します。


7. ScriptRunnerParamにScriptPKをセットします。これでパラメータにスクリプトを実行する情報がセットされました。


8. ScriptRunnerConnectionにScriptRunnerParamをセットします。これでスクリプトを実行するために必要な準備は完了しました。


9. ScriptRunnerConnection#execute()によりスクリプトを実行します。


10. ScriptRunnerResultから実行結果を取り出します。

作成例

class ScriptRunnerTest {
	public static void main (String[] args) throws Exception {
		// ScriptRunnerConnectionManager のインスタンスの取得
		ScriptRunnerConnectionManager manager = ScriptRunnerConnectionManager.getInstance();

		// ScriptRunnerConnectionFactory の生成
		ScriptRunnerConnectionFactory factory = manager.createConnectionFactory();

		// ホスト名の設定
		factory.setHost("127.0.0.1");
		// ポート番号の設定
		factory.setPort(7700);
		// 実行ユーザの設定
		factory.setUser("test");
		// 実行ユーザのパスワードの設定
		factory.setPassword("test");
		// HTTPS通信を行うかどうかの設定
		factory.setSSLEnabled(false);

		ScriptRunnerConnection conn = null;
		try {
			// ScriptRunnerConnection の生成
			conn = factory.newConnection();

			// ScriptRunnerParam の作成
			ScriptRunnerParam param = new ScriptRunnerParam();

			// ScriptPK の作成
			// 第一引数は「サービス名」, 第二引数は「スクリプト名」
			// デフォルトのサービス名の形式は「ユーザ名@プロジェクト」となります。
			ScriptPK pk = new ScriptPK("test@project", "script");
			param.setScriptPK(pk);

			// 引数の作成
			// 引数を渡さない場合には必要ありません。
 			Map<String, Object> input = new HashMap<String, Object>();
			// 文字列型の入力変数を設定
			// String 型を取ります
			input.put("in.string", "test");
			// 数値型の入力変数の設定
			// Integer 型を取ります
			input.put("in.integer", Integer.valueOf(111));
			// 10 進数型の入力変数の設定
			// BigDecimal 型を取ります
			input.put("in.decimal", new BigDecimal(222));
			// 日付型の入力変数の設定
			// Date 型を取ります
			input.put("in.date", new Date());
			// 真偽値型の入力変数の設定
			// Boolean 型を取ります
			input.put("in.boolean", Boolean.valueOf("true"));
			// バイナリの入力変数の設定
			// byte[] 型を取ります
			input.put("in.binary", new byte[]{0x42, 0x43});
			// XML 型の入力変数の設定
			// XML 文書の文字列表現を取ります
			input.put("in.xml", "<?xml version=\"1.0\"?><root />");
			param.setInput(input);

			// オプションの作成
			// オプションを設定しない場合には必要ありません。
			ScriptRunnerOption option = new ScriptRunnerOption();
			option.setType(ExecutionTypes.TYPE_PRODUCTION); // 本番用種別で実行。省略した場合は ExecutionTypes.TYPE_DEFAULT で実行。
			// option.setType("<ユーザ指定種別>"); // ユーザ指定種別で実行。指定した種別を直接指定してください。
			option.setEnableTypeSwitch(false);
			option.setEnableXMLLog(true);
			option.setLogLevel("DEBUG");
			param.setOption(option);

			// 実行および結果の取得
			ScriptRunnerResult result = conn.execute(param);

			// 終了ステータスの取得
			System.out.println("Exit Status: " + result.getExitStatus());
			if (result.isSucceeded()) {
				// 処理が成功の場合
				Map output = result.getResultData();
				for (Object key : output.keySet()) {
					Object value = output.get(key);
					if (value == null) {
						System.out.println(key + "(null): " + value);
					} else {
						System.out.println(key + "(" + value.getClass().getName() + "): " + value);
					}
				}
			} else {
				// 処理が失敗の場合
				for (Failure f = result.getFailure(); f != null; f = f.next()) {
					System.out.println(f.toString());
				}
			}
		} finally {
			if (conn != null) conn.close();
		}
	}
}

引数の設定方法

オプションの指定方法

実行結果の取得方法

XML型結果データのアサーション方法

スクリプト実行のタイムアウト設定方法

サンプルプログラムについて

ScriptRunnerTest.java

• ホスト名/IPアドレスおよびポート番号
• ユーザ名およびパスワード
• サービス名およびスクリプト名
• サービスに渡す引数の設定

コマンドライン(バッチ)からの実行

1. setenvscriptrunner.batのDS_HOME変数に$DATASPIDER_HOME/<server|client>ディレクトリパスを指定してください。
   例:
   • serverの場合
     DS_HOME="C:\Program Files\DataSpiderServista\server"
   • clientの場合
     DS_HOME="C:\Program Files\DataSpiderServista\client"
   インストールディレクトリに半角スペースが入っている場合、ダブルクォーテーションで囲む必要があります。


2. compilescriptrunner.batにコンパイルしたいJavaファイル名を指定してください。
   (初期状態ではScriptRunnerTest.javaと指定されています。)
   例:javac -encoding %SRC_ENCODING% -cp %CP% ScriptRunnerTest.java


3. execscriptrunner.batに実行したいクラス名を指定してください。
   (初期状態ではScriptRunnerTestと指定されています。)
   例:java -cp %CP%;. ScriptRunnerTest


4. compilescriptrunnerを実行してコンパイルします。


5. execscriptrunnerでスクリプトの実行が可能です。

antからの実行

1. build.propertiesのdataspider.install.dirに$DATASPIDER_HOME/<server|client>ディレクトリパスを指定してください。
   例:
   • serverの場合
     dataspider.install.dir=C:/Program Files/DataSpiderServista/server
   • clientの場合
     dataspider.install.dir=C:/Program Files/DataSpiderServista/client
   build.propertiesに記述する場合にはパス区切り文字「\」は「/」に変換して指定してください。


2. build.xmlのjavaタスクのclassname属性に実行するクラス名を指定してください。
   初期状態ではScriptRunnerTestと指定されています。


3. sampleディレクトリに移動し、antを実行します。デフォルトタスクでコンパイルができます。


4. ant executeでスクリプトの実行が可能です。

注意事項

• スクリプトの戻り値にマイナスの値を設定してスクリプトが終了した場合、ScriptRunnerResult#isSucceeded()の結果は「false」となり実行は失敗したものとして扱われます。
  また、エラーそのものは発生していないためScriptRunnerResult#getFailure()の結果はnullとなります。