net.shibboleth.utilities.java.support.scripting

Class EvaluableScript

java.lang.Object

net.shibboleth.utilities.java.support.scripting.EvaluableScript

public class EvaluableScript
extends java.lang.Object

This is a helper class that takes care of reading in, optionally compiling, and evaluating a script.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.script.CompiledScript	compiledScript The compiled form of the script, if the script engine supports compiling.
private java.lang.String	script The script to execute.
private javax.script.ScriptEngine	scriptEngine The script engine to execute the script.
private java.lang.String	scriptLanguage The scripting language.

Constructor Summary

Constructors

Constructor and Description
EvaluableScript(java.lang.String scriptSource) Constructor.
EvaluableScript(java.lang.String engineName, java.io.File scriptSource) Constructor.
EvaluableScript(java.lang.String engineName, java.lang.String scriptSource) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	eval(javax.script.Bindings scriptBindings) Evaluates this script against the given bindings.
java.lang.Object	eval(javax.script.ScriptContext scriptContext) Evaluates this script against the given context.
java.lang.String	getScript() Gets the script source.
java.lang.String	getScriptLanguage() Gets the script language.
private void	initialize() Initializes the scripting engine and compiles the script, if possible.

Methods inherited from class java.lang.Object

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

Field Detail

scriptLanguage

private final java.lang.String scriptLanguage

The scripting language.

script

private final java.lang.String script

The script to execute.

scriptEngine

private javax.script.ScriptEngine scriptEngine

The script engine to execute the script.

compiledScript

private javax.script.CompiledScript compiledScript

The compiled form of the script, if the script engine supports compiling.

Constructor Detail

EvaluableScript

public EvaluableScript(@Nonnull @NotEmpty
                       java.lang.String engineName,
                       @Nonnull @NotEmpty
                       java.lang.String scriptSource)
                throws javax.script.ScriptException

Constructor.

Parameters:

engineName - the JSR-223 scripting engine name

scriptSource - the script source

Throws:

javax.script.ScriptException - thrown if the scripting engine supports compilation and the script does not compile

EvaluableScript

public EvaluableScript(@Nonnull @NotEmpty
                       java.lang.String scriptSource)
                throws javax.script.ScriptException

Constructor.

Parameters:

scriptSource - the script source

Throws:

javax.script.ScriptException - thrown if the scripting engine supports compilation and the script does not compile

EvaluableScript

public EvaluableScript(@Nonnull @NotEmpty
                       java.lang.String engineName,
                       @Nonnull
                       java.io.File scriptSource)
                throws javax.script.ScriptException

Constructor.

Parameters:

engineName - the JSR-223 scripting engine name

scriptSource - the script source

Throws:

javax.script.ScriptException - thrown if the script source file can not be read or the scripting engine supports compilation and the script does not compile

Method Detail

getScript

@Nonnull
public java.lang.String getScript()

Gets the script source.

Returns:

the script source

getScriptLanguage

@Nonnull
public java.lang.String getScriptLanguage()

Gets the script language.

Returns:

the script source

eval

@Nullable
public java.lang.Object eval(javax.script.Bindings scriptBindings)
                                throws javax.script.ScriptException

Evaluates this script against the given bindings.

Parameters:

scriptBindings - the script bindings

Returns:

the result of the script or null if the script did not return a result

Throws:

javax.script.ScriptException - thrown if there was a problem evaluating the script

eval

@Nullable
public java.lang.Object eval(javax.script.ScriptContext scriptContext)
                                throws javax.script.ScriptException

Evaluates this script against the given context.

Parameters:

scriptContext - the script context

Returns:

the result of the script or null if the script did not return a result

Throws:

javax.script.ScriptException - thrown if there was a problem evaluating the script

initialize

private void initialize()
                 throws javax.script.ScriptException

Initializes the scripting engine and compiles the script, if possible.

Throws:

javax.script.ScriptException - thrown if the scripting engine supports compilation and the script does not compile