Package org.apache.commons.jexl3.scripting

Class JexlScriptEngine

java.lang.Object

javax.script.AbstractScriptEngine

org.apache.commons.jexl3.scripting.JexlScriptEngine

All Implemented Interfaces:

Compilable, ScriptEngine

public class JexlScriptEngine
extends AbstractScriptEngine
implements Compilable

Implements the JEXL ScriptEngine for JSF-223.

This implementation gives access to both ENGINE_SCOPE and GLOBAL_SCOPE bindings. When a JEXL script accesses a variable for read or write, this implementation checks first ENGINE and then GLOBAL scope. The first one found is used. If no variable is found, and the JEXL script is writing to a variable, it will be stored in the ENGINE scope.

The implementation also creates the "JEXL" script object as an instance of the class JexlScriptEngine.JexlScriptObject for access to utility methods and variables.

See Java Scripting API Javadoc.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JexlScriptEngine.Factory	A factory that shares the JexlEngine instance between all JexlScriptEngine instances it creates.
class	JexlScriptEngine.JexlScriptObject	Implements engine and engine context properties for use by JEXL scripts.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTEXT_KEY	Reserved key for context (mandated by JSR-223).
static final String	JEXL_OBJECT_KEY	Reserved key for JexlScriptObject.

Fields inherited from class javax.script.AbstractScriptEngine

context

Fields inherited from interface javax.script.ScriptEngine

ARGV, ENGINE, ENGINE_VERSION, FILENAME, LANGUAGE, LANGUAGE_VERSION, NAME

Constructor Summary

Constructors

Constructor	Description
JexlScriptEngine()	Default constructor.
JexlScriptEngine(ScriptEngineFactory scriptEngineFactory)	JSR-223 compatibility constructor.
JexlScriptEngine(JexlScriptEngineFactory scriptEngineFactory)	Create a scripting engine using the supplied factory.

Method Summary

Modifier and Type	Method	Description
CompiledScript	compile(Reader script)
CompiledScript	compile(String script)
Bindings	createBindings()
Object	eval(Reader reader, ScriptContext context)
Object	eval(String script, ScriptContext context)
ScriptEngineFactory	getFactory()
static void	setInstance(JexlEngine engine)	Sets the shared instance used for the script engine in the default factory.
static void	setPermissions(JexlPermissions permissions)	Deprecated. 3.6.3

Methods inherited from class javax.script.AbstractScriptEngine

eval, eval, eval, eval, get, getBindings, getContext, getScriptContext, put, setBindings, setContext

Methods inherited from class java.lang.Object

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

Field Details

CONTEXT_KEY

public static final String CONTEXT_KEY

Reserved key for context (mandated by JSR-223).

See Also:

• Constant Field Values

JEXL_OBJECT_KEY

public static final String JEXL_OBJECT_KEY

Reserved key for JexlScriptObject.

See Also:

• Constant Field Values

Constructor Details

JexlScriptEngine

public JexlScriptEngine()

Default constructor.

Only intended for use when not using a factory. Sets the factory to JexlScriptEngineFactory.

JexlScriptEngine

public JexlScriptEngine(ScriptEngineFactory scriptEngineFactory)

JSR-223 compatibility constructor.

Parameters:

scriptEngineFactory - the factory which must be a JexlScriptEngineFactory

JexlScriptEngine

public JexlScriptEngine(JexlScriptEngineFactory scriptEngineFactory)

Create a scripting engine using the supplied factory.

Parameters:

scriptEngineFactory - the factory which creates this instance.

Throws:

NullPointerException - if factory is null

Method Details

setInstance

public static void setInstance(JexlEngine engine)

Sets the shared instance used for the script engine in the default factory.

This should be called early enough to have an effect, ie before any ScriptEngineManager features.

To restore 3.2 script behavior:

JexlScriptEngine.setInstance(new JexlBuilder() .cache(512) .logger(LogFactory.getLog(JexlScriptEngine.class)) .permissions(JexlPermissions.UNRESTRICTED) .create());

Parameters:

engine - the JexlEngine instance to use

Since:

3.3

setPermissions

@Deprecated
public static void setPermissions(JexlPermissions permissions)

Deprecated.

3.6.3

Sets the permissions instance used to create the script engine.

This method has been considered unsafe and is no longer supported. Use JexlScriptEngineFactory.setDefaultPermissions(JexlPermissions) during initialization - before requesting an engine - to achieve the intended permission injection.

Parameters:

permissions - unused, method will throw

compile

public CompiledScript compile(Reader script)
                       throws ScriptException

Specified by:

compile in interface Compilable

Throws:

ScriptException

compile

public CompiledScript compile(String script)
                       throws ScriptException

Specified by:

compile in interface Compilable

Throws:

ScriptException

createBindings

public Bindings createBindings()

Specified by:

createBindings in interface ScriptEngine

eval

public Object eval(Reader reader,
 ScriptContext context)
            throws ScriptException

Specified by:

eval in interface ScriptEngine

Throws:

ScriptException

eval

public Object eval(String script,
 ScriptContext context)
            throws ScriptException

Specified by:

eval in interface ScriptEngine

Throws:

ScriptException

getFactory

public ScriptEngineFactory getFactory()

Specified by:

getFactory in interface ScriptEngine