com.haulmont.cuba.core.global

Interface Scripting

All Known Implementing Classes:

AbstractScripting, ScriptingClientImpl, ScriptingImpl

public interface Scripting

Central interface to provide scripting functionality.

Scripting includes the ability to load dynamically compiled Java and Groovy classes from classpath and conf directory, as well as running Groovy scripts and expressions.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clears compiled classes cache
<T> T	evaluateGroovy(java.lang.String text, groovy.lang.Binding binding) Evaluates Groovy expression.
<T> T	evaluateGroovy(java.lang.String text, groovy.lang.Binding binding, ScriptExecutionPolicy... policies) Evaluates Groovy expression.
<T> T	evaluateGroovy(java.lang.String text, java.util.Map<java.lang.String,java.lang.Object> context) Evaluates Groovy expression.
java.lang.ClassLoader	getClassLoader() Returns the dynamic classloader.
java.lang.Class<?>	loadClass(java.lang.String name) Loads class by name using the following sequence: Search for a Groovy source in the conf directory.
java.lang.Class<?>	loadClassNN(java.lang.String name) Loads a class by name using the sequence described in loadClass(String).
boolean	removeClass(java.lang.String name) Remove compiled class from cache
<T> T	runGroovyScript(java.lang.String name, groovy.lang.Binding binding) Runs Groovy script.
<T> T	runGroovyScript(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> context) Runs Groovy script.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

evaluateGroovy

<T> T evaluateGroovy(java.lang.String text,
                     groovy.lang.Binding binding,
                     ScriptExecutionPolicy... policies)

Evaluates Groovy expression.

Type Parameters:

T - result type

Parameters:

text - expression text

binding - Groovy binding

policies - policies for script execution ScriptExecutionPolicy

Returns:

result of expression

evaluateGroovy

<T> T evaluateGroovy(java.lang.String text,
                     groovy.lang.Binding binding)

Evaluates Groovy expression.

Type Parameters:

T - result type

Parameters:

text - expression text

binding - Groovy binding

Returns:

result of expression

evaluateGroovy

<T> T evaluateGroovy(java.lang.String text,
                     java.util.Map<java.lang.String,java.lang.Object> context)

Evaluates Groovy expression.

Type Parameters:

T - result type

Parameters:

text - expression text

context - map of parameters to pass to the expression, same as Binding

Returns:

result of expression

runGroovyScript

<T> T runGroovyScript(java.lang.String name,
                      groovy.lang.Binding binding)

Runs Groovy script. The script must be located as file under conf directory, or as a classpath resource.

Type Parameters:

T - result type

Parameters:

name - path to the script relative to conf dir or to the classpath root

binding - Groovy binding

Returns:

result of the script execution

runGroovyScript

<T> T runGroovyScript(java.lang.String name,
                      java.util.Map<java.lang.String,java.lang.Object> context)

Runs Groovy script. The script must be located as file under conf directory, or as a classpath resource.

Type Parameters:

T - result type

Parameters:

name - path to the script relative to conf dir or to the classpath root

context - map of parameters to pass to the script, same as Binding

Returns:

result of the script execution

getClassLoader

java.lang.ClassLoader getClassLoader()

Returns the dynamic classloader.

Actually it is the GroovyClassLoader which parent is JavaClassLoader. For explanation on class loading sequence see loadClass(String)

Returns:

dynamic classloader

loadClass

@Nullable
java.lang.Class<?> loadClass(java.lang.String name)

Loads class by name using the following sequence:

• Search for a Groovy source in the conf directory. If found, compile it and return
• Search for a Java source in the conf directory. If found, compile it and return
• Search for a class in classpath

It is possible to change sources in conf directory at run time, affecting the returning class, with the following restrictions:

• You can not change source from Groovy to Java
• If you had Groovy source and than removed it, you'll still get the class compiled from those sources and not from classpath

You can bypass these restrictions if you invoke clearCache() method, e.g. through JMX interface CachingFacadeMBean.

Parameters:

name - fully qualified class name

Returns:

class or null if not found

loadClassNN

java.lang.Class<?> loadClassNN(java.lang.String name)

Loads a class by name using the sequence described in loadClass(String).

Parameters:

name - fully qualified class name

Returns:

class

Throws:

java.lang.IllegalStateException - if the class is not found

removeClass

boolean removeClass(java.lang.String name)

Remove compiled class from cache

Returns:

true if class removed from cache

clearCache

void clearCache()

Clears compiled classes cache