ScriptRunnerProxy

What is ScriptRunnerProxy?

Use of ScriptRunnerProxy

Environment Settings

• Java Development Kit 6 or higher

Required information for using

• "Host name/IP address" or "Port number"
• "User name" and "Password"
• "Service name" and "Script name"(The default form of service name is <user-name>@<project name>.)

Flow of use

1. Create Java application by using Java API.


2. Compile the created Java application.


3. Execute the created Java application.

Use from Java program

Class path

• dssrconnection.jar
  In directory $DATASPIDER_HOME/server/system/common/lib

Flow of program

1. Get the instance of ScriptRunnerConnectionManager.


2. Generate ScriptRunnerConnectionFactory from ScriptRunnerConnectionManager.


3. Set information required for the connection in ScriptRunnerConnectionFactory.
   Host name, port number, execution user, and execution user's passwords are required for the connection.


4. Generate ScriptRunnerConnection from ScriptRunnerConnectionFactory.ScriptRunnerConnection is a class that connect to DataSpiderServer, that is execution engine of the script.


5. Generate ScriptRunnerParam.Set various parameters to ScriptRunnerParam when the whereabouts of the script and the script of argument information etc. are executed.


6. Generate ScriptPK. ScriptPK is a class that uniquely shows the script.Set the service name and the script name to ScriptPK.


7. Set ScriptPK in ScriptRunnerParam.Information that executed the script was set in the parameter by this.


8. Set ScriptRunnerParam in ScriptRunnerConnection.To execute the script by this, the required preliminary was completed.


9. Execute the script by ScriptRunnerConnection#execute().


10. Get execution result from ScriptRunnerResult.

Sample program

class ScriptRunnerTest {
	public static void main (String[] args) throws Exception {
		// Get instance of ScriptRunnerConnectionManager
		ScriptRunnerConnectionManager manager = ScriptRunnerConnectionManager.getInstance();

		// Generate ScriptRunnerConnectionFactory
		ScriptRunnerConnectionFactory factory = manager.createConnectionFactory();

		// Set hostname
		factory.setHost("127.0.0.1");
		// Set port number
		factory.setPort(7700);
		// Set execution user
		factory.setUser("test");
		// Set execution user's password
		factory.setPassword("test");
		// Set whether to use HTTPS
		factory.setSSLEnabled(false);

		ScriptRunnerConnection conn = null;
		try {
			// Generate ScriptRunnerConnection
			conn = factory.newConnection();

			// Generate ScriptRunnerParam
			ScriptRunnerParam param = new ScriptRunnerParam();

			// Generate ScriptPK
			// First argument is "service name", second argument is "script name"
			// The default form of service name is "user-name@project name"
			ScriptPK pk = new ScriptPK("test@project", "script");
			param.setScriptPK(pk);

			// Create arguments
			// When the argument is not passed, it is not required.
 			Map<String, Object> input = new HashMap<String, Object>();
			// The input variable of string type is set
			// Take String type
			input.put("in.string", "test");
			// The input variable of integer type is set
			// Take Integer type
			input.put("in.integer", Integer.valueOf(111));
			// The input variable of decimal type is set
			// Take BigDecimal type
			input.put("in.decimal", new BigDecimal(222));
			// The input variable of date type is set
			// Take Date type
			input.put("in.date", new Date());
			// The input variable of boolean type is set
			// Take Boolean type
			input.put("in.boolean", Boolean.valueOf("true"));
			// The input variable of binary type is set
			// Take byte[] type
			input.put("in.binary", new byte[]{0x42, 0x43});
			// The input variable of XML type is set
			// Take the string representation of the XML document
			input.put("in.xml", "<?xml version=\"1.0\"?><root />");
			param.setInput(input);

			// Create options
			// When you don't set any option, it is not required.
			ScriptRunnerOption option = new ScriptRunnerOption();
			option.setType(ExecutionTypes.TYPE_PRODUCTION); // Execute by the type for real part. When omitting it, Execute script with ExecutionTypes.TYPE_DEFAULT.
			// Option.setType ("<user specified type>"); // Execute script by the user specified type.Specify type directly.
			option.setEnableTypeSwitch(false);
			option.setEnableXMLLog(true);
			option.setLogLevel("DEBUG");
			param.setOption(option);

			// Execute and get result
			ScriptRunnerResult result = conn.execute(param);

			// Get exit status
			System.out.println("Exit Status: " + result.getExitStatus());
			if (result.isSucceeded()) {
				// When processing is succeeded
				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 {
				// When processing is failed
				for (Failure f = result.getFailure(); f != null; f = f.next()) {
					System.out.println(f.toString());
				}
			}
		} finally {
			if (conn != null) conn.close();
		}
	}
}

Setting method of argument

Method of specifying option

Method of getting execution result

Assertion of XML tuype result data

Method of setting time-out of script execution

Sample program

ScriptRunnerTest.java

• Hostname/IP address and port number
• User name and password
• Service name/script name
• Setting of argument

Execute from command line (batch)

1. Specify the installation directory of DataSpiderServer in the DS_HOME variable of setenvscriptrunner.bat.
   Example:
   • server
     DS_HOME="C:\Program Files\DataSpiderServista\server"
   • client
     DS_HOME="C:\Program Files\DataSpiderServista\client"
   When space is included in the installation directory, it is required to bundle it by a double quotation.


2. Specify the Java file name that compiles to "compilescriptrunner.bat".
   (In the initial state, "ScriptRunnerTest.java" is specified.)
   e.g.:javac -encoding %SRC_ENCODING% -cp %CP% ScriptRunnerTest.java


3. Specify the class name to be executed for "execscriptrunner.bat".
   (In the initial state, "ScriptRunnerTest" is specified.)
   e.g.:java -cp %CP%;. ScriptRunnerTest


4. Execute "compilescriptrunner" to compile Java file.


5. Execute "execscriptrunner" to execute script.

Execute from ant

1. Specify the installation directory of DataSpiderServer at dataspider.install.dir in the build.properties
   Example;
   • server
     dataspider.install.dir=C:/Program Files/DataSpiderServista/server
   • client
     dataspider.install.dir=C:/Program Files/DataSpiderServista/client
   Replace the path delimiter "\" with "/" in the build.properties.


2. Specify the class name to be executed at the classname element in java task for build.xml.
   In the initial state, "ScriptRunnerTest" is specified.


3. Move to the sample directory and execute ant. The compilation will succeed with the default task.


4. Execute "ant execute" to execute the script.

Notes

• If the script finishes with the negative return value, ScriptRunnerResult#isSucceeded() returns "false" and the execution fails.
  However, because no error occurs in the execution, ScriptRunnerResult#getFailure() returns null.