Package org.forgerock.openig.script

Class GroovyScriptFactory

java.lang.Object

org.forgerock.openig.script.GroovyScriptFactory

All Implemented Interfaces:

ScriptFactory

public final class GroovyScriptFactory
extends Object
implements ScriptFactory

Provide support for scripts written in the Groovy language.

Groovy files must be UTF-8 encoded.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GROOVY_MIME_TYPE	The mime-type for Groovy scripts.

Constructor Summary

Constructors

Constructor	Description
GroovyScriptFactory(File basedir, File cacheDir)	Constructs a new factory given two runtime directories: basedir (the root directory where file scripts are stored) and cacheDir (where inlined scripts would be stored prior to execution).
GroovyScriptFactory(Environment environment)	Constructs a new factory based on the given runtime Environment.

Method Summary

Modifier and Type	Method	Description
Script	createInline(String... lines)	Build a new Script instance from the given lines representing the script content.
Script	createResource(String resource)	Build a new Script instance from a resource name.

Methods inherited from class java.lang.Object

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

Field Details

GROOVY_MIME_TYPE

public static final String GROOVY_MIME_TYPE

The mime-type for Groovy scripts.

See Also:

• Constant Field Values

Constructor Details

GroovyScriptFactory

public GroovyScriptFactory(Environment environment)
                    throws ScriptException

Constructs a new factory based on the given runtime Environment.

Parameters:

environment - where the IG instance lives

Throws:

ScriptException - if directories cannot be created, or engine cannot be initialized

GroovyScriptFactory

public GroovyScriptFactory(File basedir,
 File cacheDir)
                    throws ScriptException

Constructs a new factory given two runtime directories: basedir (the root directory where file scripts are stored) and cacheDir (where inlined scripts would be stored prior to execution).

Parameters:

basedir - the root directory where file scripts are stored

cacheDir - where inlined scripts would be stored prior to execution

Throws:

ScriptException - if engine cannot be initialized

Method Details

createResource

public Script createResource(String resource)
                      throws ScriptException

Description copied from interface: ScriptFactory

Build a new Script instance from a resource name.

The resource name can either:

• a relative path to the script base directory
• an absolute URL

Specified by:

createResource in interface ScriptFactory

Parameters:

resource - Script resource name

Returns:

a new Script instance

Throws:

ScriptException - if resource is not available or if any pre-validation failed

createInline

public Script createInline(String... lines)
                    throws ScriptException

Description copied from interface: ScriptFactory

Build a new Script instance from the given lines representing the script content.

Specified by:

createInline in interface ScriptFactory

Parameters:

lines - script content

Returns:

a new Script instance

Throws:

ScriptException - if any pre-validation failed