org.forgerock.script.groovy

Class GroovyScriptEngineFactory

java.lang.Object

org.forgerock.script.groovy.GroovyScriptEngineFactory

All Implemented Interfaces:

ScriptEngineFactory

public class GroovyScriptEngineFactory
extends Object
implements ScriptEngineFactory

A NAME does ...

Field Summary

Fields

Modifier and Type	Field and Description
static String	LANGUAGE_NAME

Constructor Summary

Constructors

Constructor and Description
GroovyScriptEngineFactory()

Method Summary

Modifier and Type	Method and Description
String	getEngineName() Returns the full name of the ScriptEngine.
String	getEngineVersion() Returns the version of the ScriptEngine.
List<String>	getExtensions() Returns an immutable list of filename extensions, which generally identify scripts written in the language supported by this ScriptEngine.
String	getLanguageName() Returns the name of the scripting langauge supported by this ScriptEngine.
String	getLanguageVersion() Returns the version of the scripting language supported by this ScriptEngine.
List<String>	getMimeTypes() Returns an immutable list of mimetypes, associated with scripts that can be executed by the engine.
List<String>	getNames() Returns an immutable list of short names for the ScriptEngine, which may be used to identify the ScriptEngine by the ScriptEngineManager.
ScriptEngine	getScriptEngine(Map<String,Object> configuration, Collection<SourceContainer> sourceContainers, ClassLoader registryLevelClassLoader) Returns an instance of the ScriptEngine associated with this ScriptEngineFactory.

Methods inherited from class java.lang.Object

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

Field Detail

LANGUAGE_NAME

public static final String LANGUAGE_NAME

See Also:

Constant Field Values

Constructor Detail

GroovyScriptEngineFactory

public GroovyScriptEngineFactory()

Method Detail

getEngineName

public String getEngineName()

Description copied from interface: ScriptEngineFactory

Returns the full name of the ScriptEngine. For instance an implementation based on the Mozilla Rhino Javascript engine might return Rhino Mozilla Javascript Engine.

Specified by:

getEngineName in interface ScriptEngineFactory

Returns:

The name of the engine implementation.

getEngineVersion

public String getEngineVersion()

Description copied from interface: ScriptEngineFactory

Returns the version of the ScriptEngine.

Specified by:

getEngineVersion in interface ScriptEngineFactory

Returns:

The ScriptEngine implementation version.

getExtensions

public List<String> getExtensions()

Description copied from interface: ScriptEngineFactory

Returns an immutable list of filename extensions, which generally identify scripts written in the language supported by this ScriptEngine. The array is used by the ScriptEngineManager to implement its getEngineByExtension method.

Specified by:

getExtensions in interface ScriptEngineFactory

Returns:

The list of extensions.

getMimeTypes

public List<String> getMimeTypes()

Description copied from interface: ScriptEngineFactory

Returns an immutable list of mimetypes, associated with scripts that can be executed by the engine. The list is used by the ScriptEngineManager class to implement its getEngineByMimetype method.

Specified by:

getMimeTypes in interface ScriptEngineFactory

Returns:

The list of mime types.

getNames

public List<String> getNames()

Description copied from interface: ScriptEngineFactory

Returns an immutable list of short names for the ScriptEngine, which may be used to identify the ScriptEngine by the ScriptEngineManager. For instance, an implementation based on the Mozilla Rhino Javascript engine might return list containing {"javascript", "rhino"}.

Specified by:

getNames in interface ScriptEngineFactory

getLanguageName

public String getLanguageName()

Description copied from interface: ScriptEngineFactory

Returns the name of the scripting langauge supported by this ScriptEngine.

Specified by:

getLanguageName in interface ScriptEngineFactory

Returns:

The name of the supported language.

getLanguageVersion

public String getLanguageVersion()

Description copied from interface: ScriptEngineFactory

Returns the version of the scripting language supported by this ScriptEngine.

Specified by:

getLanguageVersion in interface ScriptEngineFactory

Returns:

The version of the supported language.

getScriptEngine

public ScriptEngine getScriptEngine(Map<String,Object> configuration,
                                    Collection<SourceContainer> sourceContainers,
                                    ClassLoader registryLevelClassLoader)

Description copied from interface: ScriptEngineFactory

Returns an instance of the ScriptEngine associated with this ScriptEngineFactory. A new ScriptEngine is generally returned, but implementations may pool, share or reuse engines.

Specified by:

getScriptEngine in interface ScriptEngineFactory

Parameters:

configuration - script engine configuration

sourceContainers - a collection of SourceContainers used to locate scripts

registryLevelClassLoader - the ScriptRegistry's class loader

Returns:

A new ScriptEngine instance.