com.fgm.scriptEngine

Class ScriptRunner

java.lang.Object

com.fgm.scriptEngine.ScriptRunner

public class ScriptRunner
extends java.lang.Object

Class to run scripts using the javax.script libraries

Author:

phil.feldman

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.Writer	consoleWriter The console writer.
private javax.script.ScriptEngine	engine The engine.
private java.io.Writer	errorWriter The error writer.
protected static org.apache.log4j.Logger	logger The logger.
private javax.script.ScriptEngineManager	manager The manager.

Constructor Summary

Constructors

Constructor and Description
ScriptRunner() Instantiates a new script runner.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() close the engine and clean up.
boolean	eval(java.lang.String script) Run a script passed in as a string.
static java.util.List<java.lang.String>	listAvailableEngines() Static method to list all scripting engines that are available.
static void	main(java.lang.String[] args) Simple tests.
boolean	safeEval(java.lang.String script) Run a script allowing only "blessed" imports.
boolean	setup(java.lang.String engineName, java.io.Writer consoleWriter, java.io.Writer errorWriter) Set up the script system including inputs and outputs.

Methods inherited from class java.lang.Object

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

Field Detail

manager

private javax.script.ScriptEngineManager manager

The manager.

engine

private javax.script.ScriptEngine engine

The engine.

consoleWriter

private java.io.Writer consoleWriter

The console writer.

errorWriter

private java.io.Writer errorWriter

The error writer.

logger

protected static org.apache.log4j.Logger logger

The logger.

Constructor Detail

ScriptRunner

public ScriptRunner()

Instantiates a new script runner.

Method Detail

listAvailableEngines

public static java.util.List<java.lang.String> listAvailableEngines()

Static method to list all scripting engines that are available.

Returns:

List of script engine names (e.g. 'jython 2.5.1', 'Mozilla Rhino Version: 1.6 release 2', etc)

setup

public boolean setup(java.lang.String engineName,
            java.io.Writer consoleWriter,
            java.io.Writer errorWriter)

Set up the script system including inputs and outputs.

Parameters:

engineName - - name string for the script engine (i.e. 'jython')

consoleWriter - - writer for console output

errorWriter - - writer for error output

Returns:

true if successfully opened

eval

public boolean eval(java.lang.String script)
             throws javax.script.ScriptException

Run a script passed in as a string.

Parameters:

script - - the entire script

Returns:

true, if successful

Throws:

javax.script.ScriptException - the script exception

safeEval

public boolean safeEval(java.lang.String script)
                 throws java.io.IOException,
                        javax.script.ScriptException

Run a script allowing only "blessed" imports.

Parameters:

script - the script

Returns:

true, if successful

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

javax.script.ScriptException - the script exception

close

public void close()

close the engine and clean up.

main

public static void main(java.lang.String[] args)

Simple tests.

Parameters:

args - the arguments