com.haulmont.cuba.core.sys

Class AbstractScripting

java.lang.Object

com.haulmont.cuba.core.sys.AbstractScripting

All Implemented Interfaces:

Scripting

Direct Known Subclasses:

ScriptingClientImpl, ScriptingImpl

public abstract class AbstractScripting
extends java.lang.Object
implements Scripting

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractScripting.CubaGroovyClassLoader
protected class	AbstractScripting.CubaResourceConnector

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractScripting.CubaGroovyClassLoader	gcl
protected GlobalConfig	globalConfig
protected java.lang.String	groovyClassPath
protected groovy.util.GroovyScriptEngine	gse
protected java.util.Set<java.lang.String>	imports
protected JavaClassLoader	javaClassLoader
protected org.apache.commons.pool2.impl.GenericKeyedObjectPool<java.lang.String,groovy.lang.Script>	pool
protected SpringBeanLoader	springBeanLoader

Fields inherited from interface com.haulmont.cuba.core.global.Scripting

NAME

Constructor Summary

Constructors

Constructor and Description
AbstractScripting(JavaClassLoader javaClassLoader, Configuration configuration, SpringBeanLoader springBeanLoader)

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clears compiled classes cache
protected groovy.lang.Binding	createBinding(java.util.Map<java.lang.String,java.lang.Object> map)
protected groovy.lang.Script	createScript(java.lang.String text)
<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.
protected AbstractScripting.CubaGroovyClassLoader	getGroovyClassLoader()
protected groovy.util.GroovyScriptEngine	getGroovyScriptEngine()
protected abstract java.lang.String[]	getScriptEngineRootPath()
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 Scripting.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.

Methods inherited from class java.lang.Object

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

Field Detail

javaClassLoader

protected JavaClassLoader javaClassLoader

springBeanLoader

protected SpringBeanLoader springBeanLoader

groovyClassPath

protected java.lang.String groovyClassPath

imports

protected java.util.Set<java.lang.String> imports

gse

protected volatile groovy.util.GroovyScriptEngine gse

gcl

protected volatile AbstractScripting.CubaGroovyClassLoader gcl

pool

protected org.apache.commons.pool2.impl.GenericKeyedObjectPool<java.lang.String,groovy.lang.Script> pool

globalConfig

protected GlobalConfig globalConfig

Constructor Detail

AbstractScripting

public AbstractScripting(JavaClassLoader javaClassLoader,
                         Configuration configuration,
                         SpringBeanLoader springBeanLoader)

Method Detail

getScriptEngineRootPath

protected abstract java.lang.String[] getScriptEngineRootPath()

getGroovyScriptEngine

protected groovy.util.GroovyScriptEngine getGroovyScriptEngine()

getGroovyClassLoader

protected AbstractScripting.CubaGroovyClassLoader getGroovyClassLoader()

createScript

protected groovy.lang.Script createScript(java.lang.String text)

createBinding

protected groovy.lang.Binding createBinding(java.util.Map<java.lang.String,java.lang.Object> map)

evaluateGroovy

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

Description copied from interface: Scripting

Evaluates Groovy expression.

Specified by:

evaluateGroovy in interface Scripting

Type Parameters:

T - result type

Parameters:

text - expression text

binding - Groovy binding

policies - policies for script execution ScriptExecutionPolicy

Returns:

result of expression

evaluateGroovy

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

Description copied from interface: Scripting

Evaluates Groovy expression.

Specified by:

evaluateGroovy in interface Scripting

Type Parameters:

T - result type

Parameters:

text - expression text

binding - Groovy binding

Returns:

result of expression

evaluateGroovy

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

Description copied from interface: Scripting

Evaluates Groovy expression.

Specified by:

evaluateGroovy in interface Scripting

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

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

Description copied from interface: Scripting

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

Specified by:

runGroovyScript in interface Scripting

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

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

Description copied from interface: Scripting

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

Specified by:

runGroovyScript in interface Scripting

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

public java.lang.ClassLoader getClassLoader()

Description copied from interface: Scripting

Returns the dynamic classloader.

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

Specified by:

getClassLoader in interface Scripting

Returns:

dynamic classloader

loadClass

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

Description copied from interface: Scripting

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 Scripting.clearCache() method, e.g. through JMX interface CachingFacadeMBean.

Specified by:

loadClass in interface Scripting

Parameters:

name - fully qualified class name

Returns:

class or null if not found

loadClassNN

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

Description copied from interface: Scripting

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

Specified by:

loadClassNN in interface Scripting

Parameters:

name - fully qualified class name

Returns:

class

removeClass

public boolean removeClass(java.lang.String name)

Description copied from interface: Scripting

Remove compiled class from cache

Specified by:

removeClass in interface Scripting

Returns:

true if class removed from cache

clearCache

public void clearCache()

Description copied from interface: Scripting

Clears compiled classes cache

Specified by:

clearCache in interface Scripting