Class JexlScriptEngine
- All Implemented Interfaces:
Compilable,ScriptEngine
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.
- Since:
- 2.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classA factory that shares the JexlEngine instance between all JexlScriptEngine instances it creates.private static final classHolds singleton JexlScriptEngineFactory (IODH).private final classWrapper to help convert a JEXL JexlScript into a JSR-223 CompiledScript.private final classWrapper to help convert a JSR-223 ScriptContext into a JexlContext.classImplements engine and engine context properties for use by JEXL scripts. -
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final intThe shared expression cache size.static final StringReserved key for context (mandated by JSR-223).static final StringReserved key for JexlScriptObject.(package private) final JexlEngineThe JEXL EL engine.(package private) final JexlScriptEngine.JexlScriptObjectThe JexlScriptObject instance.(package private) static final org.apache.commons.logging.LogThe logger.(package private) final JexlScriptEngineFactoryThe factory which created this instance.private static final StringReserved key for script.Fields inherited from class javax.script.AbstractScriptEngine
contextFields inherited from interface javax.script.ScriptEngine
ARGV, ENGINE, ENGINE_VERSION, FILENAME, LANGUAGE, LANGUAGE_VERSION, NAME -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.JexlScriptEngine(ScriptEngineFactory scriptEngineFactory) JSR-223 compatibility constructor.JexlScriptEngine(JexlScriptEngineFactory scriptEngineFactory) Create a scripting engine using the supplied factory. -
Method Summary
Modifier and TypeMethodDescriptioneval(Reader reader, ScriptContext context) eval(String script, ScriptContext context) private static StringreaderToString(Reader scriptReader) Reads from a reader into a local buffer and return a String with the contents of the reader.(package private) static ScriptExceptionstatic voidsetInstance(JexlEngine engine) Sets the shared instance used for the script engine in the default factory.static voidsetPermissions(JexlPermissions permissions) Deprecated.3.6.3Methods inherited from class javax.script.AbstractScriptEngine
eval, eval, eval, eval, get, getBindings, getContext, getScriptContext, put, setBindings, setContext
-
Field Details
-
LOG
static final org.apache.commons.logging.Log LOGThe logger. -
CACHE_SIZE
static final int CACHE_SIZEThe shared expression cache size.- See Also:
-
CONTEXT_KEY
Reserved key for context (mandated by JSR-223).- See Also:
-
JEXL_OBJECT_KEY
Reserved key for JexlScriptObject.- See Also:
-
SCRIPT
Reserved key for script.- See Also:
-
jexlObject
The JexlScriptObject instance. -
parentFactory
The factory which created this instance. -
jexlEngine
The JEXL EL engine.
-
-
Constructor Details
-
JexlScriptEngine
public JexlScriptEngine()Default constructor.Only intended for use when not using a factory. Sets the factory to
JexlScriptEngineFactory. -
JexlScriptEngine
JSR-223 compatibility constructor.- Parameters:
scriptEngineFactory- The factory which must be aJexlScriptEngineFactory
-
JexlScriptEngine
Create a scripting engine using the supplied factory.- Parameters:
scriptEngineFactory- The factory which creates this instance.- Throws:
NullPointerException- if factory is null
-
-
Method Details
-
readerToString
Reads from a reader into a local buffer and return a String with the contents of the reader.- Parameters:
scriptReader- to be read.- Returns:
- The contents of the reader as a String.
- Throws:
ScriptException- on any error reading the reader.
-
scriptException
-
setInstance
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
ScriptEngineManagerfeatures.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.3.6.3Sets 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
- Specified by:
compilein interfaceCompilable- Throws:
ScriptException
-
compile
- Specified by:
compilein interfaceCompilable- Throws:
ScriptException
-
createBindings
- Specified by:
createBindingsin interfaceScriptEngine
-
eval
- Specified by:
evalin interfaceScriptEngine- Throws:
ScriptException
-
eval
- Specified by:
evalin interfaceScriptEngine- Throws:
ScriptException
-
getFactory
- Specified by:
getFactoryin interfaceScriptEngine
-