Modifier and Type	Class and Description
private static class	GroovyScriptEngine.LocalData
private static class	GroovyScriptEngine.ScriptCacheEntry
private class	GroovyScriptEngine.ScriptClassLoader

Modifier and Type	Field and Description
private static final ClassLoader	CL_STUB
private CompilerConfiguration	config
private static final URL[]	EMPTY_URL_ARRAY
private GroovyClassLoader	groovyLoader
private static WeakReference<ThreadLocal<GroovyScriptEngine.LocalData>>	localData
private final ClassLoader	parentLoader
private final ResourceConnector	rc
private final URL[]	roots
private final Map<String, GroovyScriptEngine.ScriptCacheEntry>	scriptCache

Access	Constructor and Description
private	GroovyScriptEngine(URL[] This an array of URLs where Groovy scripts will be stored. They should be laid out using their package structure like Java classes roots, ClassLoader parent, ResourceConnector rc) The groovy script engine will run groovy scripts and reload them and their dependencies when they are modified.
public	GroovyScriptEngine(URL[] roots)
public	GroovyScriptEngine(URL[] roots, ClassLoader parentClassLoader)
public	GroovyScriptEngine(String[] urls)
public	GroovyScriptEngine(String[] urls, ClassLoader parentClassLoader)
public	GroovyScriptEngine(String url)
public	GroovyScriptEngine(String url, ClassLoader parentClassLoader)
public	GroovyScriptEngine(ResourceConnector rc)
public	GroovyScriptEngine(ResourceConnector rc, ClassLoader parentClassLoader)

Method Summary

Modifier and Type	Method and Description
private static URL[]	createRoots(String[] urls)
public Script	Returns: the script object createScript(String name of the script to run scriptName, Binding the binding to pass to the script binding) Creates a Script with a given scriptName and binding.
private static void	forceClose(URLConnection the `URLConnection` to be "closed" to close the underlying file descriptors. urlConnection) This method closes a `URLConnection` by getting its `InputStream` and calling the `InputStream#close()` method on it.
public CompilerConfiguration	Returns: a non null compiler configuration getConfig()
protected long	getCurrentTime()
public GroovyClassLoader	Returns: the GroovyClassLoader getGroovyClassLoader() Returns the GroovyClassLoader associated with this script engine instance.
private long	getLastModified(String scriptName)
private static synchronized ThreadLocal<GroovyScriptEngine.LocalData>	getLocalData()
public ClassLoader	Returns: the parent classloader used to load scripts getParentClassLoader() Get the `ClassLoader` that will serve as the parent ClassLoader of the `GroovyClassLoader` in which scripts will be executed.
public URLConnection	Returns: a URLConnection to the resource getResourceConnection(String name of the resource to be retrieved resourceName) Implements groovy.util.ResourceConnector.getResourceConnection. Get a resource connection as a `URLConnection` to retrieve a script from the `ResourceConnector`.
private GroovyClassLoader	Returns: the parent classloader used to load scripts initGroovyLoader() Initialize a new GroovyClassLoader with a default or constructor-supplied parentClassLoader.
protected boolean	isSourceNewer(GroovyScriptEngine.ScriptCacheEntry entry)
public Class<T>	Returns: the loaded scriptName as a compiled class loadScriptByName(String resource name pointing to the script scriptName) Get the class of the scriptName in question, so that you can instantiate Groovy objects with caching and reloading.
public static void	main(String[] an array of URLs urls) Simple testing harness for the GSE.
private static URLConnection	openConnection(URL scriptURL)
public String	Returns: a `toString()` representation of the result of the execution of the script run(String name of the script to run scriptName, String a single argument passed as a variable named `arg` in the binding argument) Run a script identified by name with a single argument.
public Object	Returns: an object run(String name of the script to run scriptName, Binding the binding to pass to the script binding) Run a script identified by name with a given binding.
public void	setConfig(CompilerConfiguration - the compiler configuration config) sets a compiler configuration
private static void	verifyInputStream(URLConnection urlConnection)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CL_STUB	back to summary
private static final ClassLoader CL_STUB

config	back to summary
private CompilerConfiguration config

EMPTY_URL_ARRAY	back to summary
private static final URL[] EMPTY_URL_ARRAY

groovyLoader	back to summary
private GroovyClassLoader groovyLoader

localData	back to summary
private static WeakReference<ThreadLocal<GroovyScriptEngine.LocalData>> localData

parentLoader	back to summary
private final ClassLoader parentLoader

rc	back to summary
private final ResourceConnector rc

roots	back to summary
private final URL[] roots

scriptCache	back to summary
private final Map<String, GroovyScriptEngine.ScriptCacheEntry> scriptCache

Constructor Detail

GroovyScriptEngine	back to summary
private GroovyScriptEngine(URL[] roots, ClassLoader parent, ResourceConnector rc) The groovy script engine will run groovy scripts and reload them and their dependencies when they are modified. This is useful for embedding groovy in other containers like games and application servers. Parameters roots:URL[] This an array of URLs where Groovy scripts will be stored. They should be laid out using their package structure like Java classes

GroovyScriptEngine

back to summary

private GroovyScriptEngine(URL[] roots, ClassLoader parent, ResourceConnector rc)

The groovy script engine will run groovy scripts and reload them and their dependencies when they are modified. This is useful for embedding groovy in other containers like games and application servers.

Parameters

roots:URL[]: This an array of URLs where Groovy scripts will be stored. They should be laid out using their package structure like Java classes

GroovyScriptEngine	back to summary
public GroovyScriptEngine(URL[] roots)

GroovyScriptEngine	back to summary
public GroovyScriptEngine(URL[] roots, ClassLoader parentClassLoader)

GroovyScriptEngine	back to summary
public GroovyScriptEngine(String[] urls) throws IOException

GroovyScriptEngine	back to summary
public GroovyScriptEngine(String[] urls, ClassLoader parentClassLoader) throws IOException

GroovyScriptEngine	back to summary
public GroovyScriptEngine(String url) throws IOException

GroovyScriptEngine	back to summary
public GroovyScriptEngine(String url, ClassLoader parentClassLoader) throws IOException

GroovyScriptEngine	back to summary
public GroovyScriptEngine(ResourceConnector rc)

GroovyScriptEngine	back to summary
public GroovyScriptEngine(ResourceConnector rc, ClassLoader parentClassLoader)

Method Detail

createRoots	back to summary
private static URL[] createRoots(String[] urls) throws MalformedURLException

createScript	back to summary
public Script createScript(String scriptName, Binding binding) throws ResourceException, ScriptException Creates a Script with a given scriptName and binding. Parameters scriptName:String name of the script to run binding:Binding the binding to pass to the script Returns:Script the script object Exceptions ResourceException: if there is a problem accessing the script ScriptException: if there is a problem parsing the script

createScript

back to summary

public Script createScript(String scriptName, Binding binding) throws ResourceException, ScriptException

Creates a Script with a given scriptName and binding.

Parameters

scriptName:String: name of the script to run
binding:Binding: the binding to pass to the script

Returns:Script

the script object

Exceptions

ResourceException:: if there is a problem accessing the script
ScriptException:: if there is a problem parsing the script

forceClose back to summary

forceClose	back to summary
private static void forceClose(URLConnection urlConnection) This method closes a `URLConnection` by getting its `InputStream` and calling the `InputStream#close()` method on it. The `URLConnection` doesn't have a close() method and relies on garbage collection to close the underlying connection to the file. Relying on garbage collection could lead to the application exhausting the number of files the user is allowed to have open at any one point in time and cause the application to crash (`java.io.FileNotFoundException` (Too many open files)). Hence the need for this method to explicitly close the underlying connection to the file. Parameters urlConnection:URLConnection the `URLConnection` to be "closed" to close the underlying file descriptors.

private static void forceClose(URLConnection urlConnection)

This method closes a URLConnection by getting its InputStream and calling the InputStream#close() method on it. The URLConnection doesn't have a close() method and relies on garbage collection to close the underlying connection to the file. Relying on garbage collection could lead to the application exhausting the number of files the user is allowed to have open at any one point in time and cause the application to crash (java.io.FileNotFoundException (Too many open files)). Hence the need for this method to explicitly close the underlying connection to the file.

Parameters

urlConnection:URLConnection: the URLConnection to be "closed" to close the underlying file descriptors.

getConfig	back to summary
public CompilerConfiguration getConfig() Returns:CompilerConfiguration a non null compiler configuration

getCurrentTime	back to summary
protected long getCurrentTime()

getGroovyClassLoader	back to summary
public GroovyClassLoader getGroovyClassLoader() Returns the GroovyClassLoader associated with this script engine instance. Useful if you need to pass the class loader to another library. Returns:GroovyClassLoader the GroovyClassLoader

getGroovyClassLoader

back to summary

public GroovyClassLoader getGroovyClassLoader()

Returns the GroovyClassLoader associated with this script engine instance. Useful if you need to pass the class loader to another library.

Returns:GroovyClassLoader: the GroovyClassLoader

getLastModified	back to summary
private long getLastModified(String scriptName) throws ResourceException

getLocalData	back to summary
private static synchronized ThreadLocal<GroovyScriptEngine.LocalData> getLocalData()

getParentClassLoader back to summary

getParentClassLoader	back to summary
public ClassLoader getParentClassLoader() Get the `ClassLoader` that will serve as the parent ClassLoader of the `GroovyClassLoader` in which scripts will be executed. By default, this is the ClassLoader that loaded the `GroovyScriptEngine` class. Returns:ClassLoader the parent classloader used to load scripts

public ClassLoader getParentClassLoader()

Get the ClassLoader that will serve as the parent ClassLoader of the GroovyClassLoader in which scripts will be executed. By default, this is the ClassLoader that loaded the GroovyScriptEngine class.

Returns:ClassLoader: the parent classloader used to load scripts

getResourceConnection back to summary

getResourceConnection	back to summary
public URLConnection getResourceConnection(String resourceName) throws ResourceException Implements groovy.util.ResourceConnector.getResourceConnection. Get a resource connection as a `URLConnection` to retrieve a script from the `ResourceConnector`. Parameters resourceName:String name of the resource to be retrieved Returns:URLConnection a URLConnection to the resource

public URLConnection getResourceConnection(String resourceName) throws ResourceException

Implements groovy.util.ResourceConnector.getResourceConnection.

Get a resource connection as a URLConnection to retrieve a script from the ResourceConnector.

Parameters

resourceName:String: name of the resource to be retrieved

Returns:URLConnection

a URLConnection to the resource

initGroovyLoader	back to summary
private GroovyClassLoader initGroovyLoader() Initialize a new GroovyClassLoader with a default or constructor-supplied parentClassLoader. Returns:GroovyClassLoader the parent classloader used to load scripts

initGroovyLoader

back to summary

private GroovyClassLoader initGroovyLoader()

Initialize a new GroovyClassLoader with a default or constructor-supplied parentClassLoader.

Returns:GroovyClassLoader: the parent classloader used to load scripts

isSourceNewer	back to summary
protected boolean isSourceNewer(GroovyScriptEngine.ScriptCacheEntry entry)

loadScriptByName	back to summary
public Class<T> loadScriptByName(String scriptName) throws ResourceException, ScriptException Get the class of the scriptName in question, so that you can instantiate Groovy objects with caching and reloading. Parameters scriptName:String resource name pointing to the script Returns:Class<T> the loaded scriptName as a compiled class Exceptions ResourceException: if there is a problem accessing the script ScriptException: if there is a problem parsing the script

loadScriptByName

back to summary

public Class<T> loadScriptByName(String scriptName) throws ResourceException, ScriptException

Get the class of the scriptName in question, so that you can instantiate Groovy objects with caching and reloading.

Parameters

scriptName:String: resource name pointing to the script

Returns:Class<T>

the loaded scriptName as a compiled class

Exceptions

ResourceException:: if there is a problem accessing the script
ScriptException:: if there is a problem parsing the script

main	back to summary
public static void main(String[] urls) throws Exception Simple testing harness for the GSE. Enter script roots as arguments and then input script names to run them. Parameters urls:String[] an array of URLs Exceptions Exception: if something goes wrong

main

back to summary

public static void main(String[] urls) throws Exception

Simple testing harness for the GSE. Enter script roots as arguments and then input script names to run them.

Parameters

urls:String[]: an array of URLs

Exceptions

Exception:: if something goes wrong

openConnection	back to summary
private static URLConnection openConnection(URL scriptURL) throws IOException

run back to summary

run	back to summary
public String run(String scriptName, String argument) throws ResourceException, ScriptException Run a script identified by name with a single argument. Parameters scriptName:String name of the script to run argument:String a single argument passed as a variable named `arg` in the binding Returns:String a `toString()` representation of the result of the execution of the script Exceptions ResourceException: if there is a problem accessing the script ScriptException: if there is a problem parsing the script

public String run(String scriptName, String argument) throws ResourceException, ScriptException

Run a script identified by name with a single argument.

Parameters

scriptName:String: name of the script to run
argument:String: a single argument passed as a variable named arg in the binding

Returns:String

a toString() representation of the result of the execution of the script

Exceptions

ResourceException:: if there is a problem accessing the script
ScriptException:: if there is a problem parsing the script

run	back to summary
public Object run(String scriptName, Binding binding) throws ResourceException, ScriptException Run a script identified by name with a given binding. Parameters scriptName:String name of the script to run binding:Binding the binding to pass to the script Returns:Object an object Exceptions ResourceException: if there is a problem accessing the script ScriptException: if there is a problem parsing the script

run

back to summary

public Object run(String scriptName, Binding binding) throws ResourceException, ScriptException

Run a script identified by name with a given binding.

Parameters

scriptName:String: name of the script to run
binding:Binding: the binding to pass to the script

Returns:Object

an object

Exceptions

ResourceException:: if there is a problem accessing the script
ScriptException:: if there is a problem parsing the script

setConfig	back to summary
public void setConfig(CompilerConfiguration config) sets a compiler configuration Parameters config:CompilerConfiguration - the compiler configuration Exceptions NullPointerException: if config is null

setConfig

back to summary

public void setConfig(CompilerConfiguration config)

sets a compiler configuration

Parameters

config:CompilerConfiguration: - the compiler configuration

Exceptions

NullPointerException:: if config is null

verifyInputStream	back to summary
private static void verifyInputStream(URLConnection urlConnection) throws IOException

groovy.util back to summary

private Class GroovyScriptEngine.LocalData

Class Inheritance

extends Object

java.lang.Object
groovy.util.GroovyScriptEngine.LocalData

Field Summary

Modifier and Type	Field and Description
pack-priv CompilationUnit	cu
pack-priv final StringSetMap	dependencyCache
pack-priv final Map<String, String>	precompiledEntries

Constructor Summary

Access	Constructor and Description
private	LocalData()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cu	back to summary
pack-priv CompilationUnit cu

dependencyCache	back to summary
pack-priv final StringSetMap dependencyCache

precompiledEntries	back to summary
pack-priv final Map<String, String> precompiledEntries

Constructor Detail

LocalData	back to summary
private LocalData()

groovy.util back to summary

private Class GroovyScriptEngine.ScriptCacheEntry

Class Inheritance

extends Object

java.lang.Object
groovy.util.GroovyScriptEngine.ScriptCacheEntry

Field Summary

Modifier and Type	Field and Description
private final Set<String>	dependencies
private final long	lastCheck
private final long	lastModified
private final Class<T>	scriptClass
private final boolean	sourceNewer

Constructor Summary

Access	Constructor and Description
public	ScriptCacheEntry(Class<T> clazz, long modified, long lastCheck, Set<String> depend, boolean sourceNewer)
public	ScriptCacheEntry(GroovyScriptEngine.ScriptCacheEntry old, long lastCheck, boolean sourceNewer)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dependencies	back to summary
private final Set<String> dependencies

lastCheck	back to summary
private final long lastCheck

lastModified	back to summary
private final long lastModified

scriptClass	back to summary
private final Class<T> scriptClass

sourceNewer	back to summary
private final boolean sourceNewer

Constructor Detail

ScriptCacheEntry	back to summary
public ScriptCacheEntry(Class<T> clazz, long modified, long lastCheck, Set<String> depend, boolean sourceNewer)

ScriptCacheEntry	back to summary
public ScriptCacheEntry(GroovyScriptEngine.ScriptCacheEntry old, long lastCheck, boolean sourceNewer)

groovy.util back to summary

private Class GroovyScriptEngine.ScriptClassLoader

Class Inheritance

extends GroovyClassLoader

java.lang.Object
java.lang.ClassLoader
java.security.SecureClassLoader
java.net.URLClassLoader
groovy.lang.GroovyClassLoader
groovy.util.GroovyScriptEngine.ScriptClassLoader

Field Summary

Inherited from groovy.lang.GroovyClassLoader:: classCache sourceCache

Constructor Summary

Access	Constructor and Description
public	ScriptClassLoader(GroovyClassLoader loader)
public	ScriptClassLoader(ClassLoader loader, CompilerConfiguration config)

Method Summary

Modifier and Type	Method and Description
private Set<String>	convertToPaths(Set<String> orig, Map<String, String> precompiledEntries)
protected CompilationUnit	createCompilationUnit(CompilerConfiguration the compiler configuration, usually the same as for this class loader configuration, CodeSource the source containing the initial file to compile, more files may follow during compilation source) Overrides groovy.lang.GroovyClassLoader.createCompilationUnit. creates a new CompilationUnit.
private Class<?>	doParseClass(GroovyCodeSource codeSource) Hides groovy.lang.GroovyClassLoader.doParseClass.
private String	getPath(Class<T> clazz, Map<String, String> precompiledEntries)
public Class<T>	parseClass(GroovyCodeSource codeSource, boolean if true then the generated class will be stored in the source cache shouldCacheSource) Overrides groovy.lang.GroovyClassLoader.parseClass. Parses the given code source into a Java class.
private void	setResLoader()
private void	updateLocalDependencyCache(GroovyCodeSource codeSource, GroovyScriptEngine.LocalData localData)
private void	updateScriptCache(GroovyScriptEngine.LocalData localData)

Constructor Detail

ScriptClassLoader	back to summary
public ScriptClassLoader(GroovyClassLoader loader)

ScriptClassLoader	back to summary
public ScriptClassLoader(ClassLoader loader, CompilerConfiguration config)

Method Detail

convertToPaths	back to summary
private Set<String> convertToPaths(Set<String> orig, Map<String, String> precompiledEntries)

createCompilationUnit

back to summary

protected CompilationUnit createCompilationUnit(CompilerConfiguration configuration, CodeSource source)

Overrides groovy.lang.GroovyClassLoader.createCompilationUnit.

Doc from groovy.lang.GroovyClassLoader.createCompilationUnit.

creates a new CompilationUnit. If you want to add additional phase operations to the CompilationUnit (for example to inject additional methods, variables, fields), then you should overwrite this method.

Parameters

configuration:CompilerConfiguration: the compiler configuration, usually the same as for this class loader
source:CodeSource: the source containing the initial file to compile, more files may follow during compilation

Returns:CompilationUnit

the CompilationUnit

Annotations

@Override

doParseClass	back to summary
private Class<?> doParseClass(GroovyCodeSource codeSource) Hides groovy.lang.GroovyClassLoader.doParseClass.

getPath	back to summary
private String getPath(Class<T> clazz, Map<String, String> precompiledEntries)

parseClass

back to summary

public Class<T> parseClass(GroovyCodeSource codeSource, boolean shouldCacheSource) throws CompilationFailedException

Overrides groovy.lang.GroovyClassLoader.parseClass.

Doc from groovy.lang.GroovyClassLoader.parseClass.

Parses the given code source into a Java class. If there is a class file for the given code source, then no parsing is done, instead the cached class is returned.

Parameters

shouldCacheSource:boolean: if true then the generated class will be stored in the source cache

Returns:Class<T>

the main class defined in the given script

Annotations

@Override

setResLoader	back to summary
private void setResLoader()

updateLocalDependencyCache	back to summary
private void updateLocalDependencyCache(GroovyCodeSource codeSource, GroovyScriptEngine.LocalData localData)

updateScriptCache	back to summary
private void updateScriptCache(GroovyScriptEngine.LocalData localData)

public Class GroovyScriptEngine

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class GroovyScriptEngine.LocalData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class GroovyScriptEngine.ScriptCacheEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class GroovyScriptEngine.ScriptClassLoader

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail