org.forgerock.script.engine

Interface ScriptEngineFactory

All Known Implementing Classes:

GroovyScriptEngineFactory, RhinoScriptEngineFactory

public interface ScriptEngineFactory

ScriptEngineFactory is used to describe and instantiate ScriptEngines.

Each class implementing ScriptEngine has a corresponding factory that exposes metadata describing the engine class.

The ScriptEngineManager uses the service provider mechanism described in the Jar File Specification to obtain instances of all ScriptEngineFactories available in the current ClassLoader.

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.

Method Detail

getEngineName

String getEngineName()

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

Returns:

The name of the engine implementation.

getEngineVersion

String getEngineVersion()

Returns the version of the ScriptEngine.

Returns:

The ScriptEngine implementation version.

getExtensions

List<String> getExtensions()

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.

Returns:

The list of extensions.

getMimeTypes

List<String> getMimeTypes()

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.

Returns:

The list of mime types.

getNames

List<String> getNames()

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"}.

getLanguageName

String getLanguageName()

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

Returns:

The name of the supported language.

getLanguageVersion

String getLanguageVersion()

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

Returns:

The version of the supported language.

getScriptEngine

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

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

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.