org.molgenis.script

Class ScriptRunnerController

java.lang.Object

org.molgenis.script.ScriptRunnerController

@Controller
public class ScriptRunnerController
extends Object

Controller for running a script

Url: /scripts/${scriptname}/run

If the script generates an outputfile that file is streamed to the outputstream else the script output

Constructor Summary

Constructors

Constructor and Description
ScriptRunnerController(org.molgenis.script.ScriptJobExecutionFactory scriptJobExecutionFactory, JobExecutor jobExecutor, SavedScriptRunner savedScriptRunner, com.google.gson.Gson gson, org.molgenis.security.user.UserAccountService userAccountService, JobsController jobsController)

Method Summary

Modifier and Type	Method and Description
void	handleGenerateScriptException(ScriptException e, javax.servlet.http.HttpServletResponse response)
void	handleUnknownScriptException(UnknownScriptException e, javax.servlet.http.HttpServletResponse response)
void	runScript(String scriptName, Map<String,Object> parameters, javax.servlet.http.HttpServletResponse response) Runs a Script, waits for it to finish and returns the result.
void	startScript(String scriptName, Map<String,Object> parameters, javax.servlet.http.HttpServletResponse response) Starts a Script.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptRunnerController

public ScriptRunnerController(org.molgenis.script.ScriptJobExecutionFactory scriptJobExecutionFactory,
                              JobExecutor jobExecutor,
                              SavedScriptRunner savedScriptRunner,
                              com.google.gson.Gson gson,
                              org.molgenis.security.user.UserAccountService userAccountService,
                              JobsController jobsController)

Method Detail

startScript

@RequestMapping(value="/scripts/{name}/start")
public void startScript(@PathVariable(value="name")
                                                                       String scriptName,
                                                                       @RequestParam
                                                                       Map<String,Object> parameters,
                                                                       javax.servlet.http.HttpServletResponse response)
                                                                throws IOException

Starts a Script. Will redirect the request to the jobs controller, showing the progress of the started ScriptJobExecution. The Script's output will be written to the log of the ScriptJobExecution. If the Script has an outputFile, the URL of that file will be written to the JobExecution.getResultUrl()

Parameters:

scriptName - name of the Script to start

parameters - parameter values for the script

Throws:

IOException - if an input or output exception occurs when redirecting

runScript

@RequestMapping(value="/scripts/{name}/run")
public void runScript(@PathVariable(value="name")
                                                                   String scriptName,
                                                                   @RequestParam
                                                                   Map<String,Object> parameters,
                                                                   javax.servlet.http.HttpServletResponse response)
                                                            throws IOException

Runs a Script, waits for it to finish and returns the result.

If the result has an outputFile, will redirect to a URL where you can download the result file. Otherwise, if the result has output, will write the script output to the response and serve it as /text/plain.

Parameters:

scriptName - name of the Script to run

parameters - parameter values for the script

response - HttpServletResponse to return the result

Throws:

IOException - if something goes wrong when redirecting or writing the result

ScriptException - if the script name is unknown or one of the script parameters is missing

handleUnknownScriptException

@ExceptionHandler(value=org.molgenis.script.core.UnknownScriptException.class)
public void handleUnknownScriptException(UnknownScriptException e,
                                                                                                                        javax.servlet.http.HttpServletResponse response)
                                                                                                                 throws IOException

Throws:

IOException

handleGenerateScriptException

@ExceptionHandler(value=org.molgenis.script.core.ScriptException.class)
public void handleGenerateScriptException(ScriptException e,
                                                                                                                  javax.servlet.http.HttpServletResponse response)
                                                                                                           throws IOException

Throws:

IOException