org.apache.clerezza.platform.scripting

Class ScriptExecution

java.lang.Object

org.apache.clerezza.platform.scripting.ScriptExecution

public class ScriptExecution
extends Object

This class executes scripts, binds ScriptEngineFactoryies of installed ScriptEngines. It provides a facade to the installed ScriptEngines that implement javax.script.ScriptEngine. The services ContentGraphProvider, DiscobitsHandler, and TcManager are provided to the ScriptEngine's eval method through the parameter Bindings. In a script, they are accessible under the names contentGraphProvider, contentHandler, and tcManager respectively.

Author:

hasan, daniel

See Also:

ScriptEngineManager, ScriptEngine

Constructor Summary

Constructors

Constructor and Description
ScriptExecution()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	bindScriptEngineFactory(javax.script.ScriptEngineFactory factory) Binds a ScriptEngineFactory.
Object	execute(NonLiteral scriptResource)
Object	execute(NonLiteral scriptResource, javax.script.Bindings bindings) Executes the specified scriptResource.
Object	execute(String script, javax.script.Bindings bindings, String language, String languageVersion) Executes the specified script with the ScriptEngine that is registered for language and languageVersion.
Iterator<ScriptLanguageDescription>	getInstalledScriptLanguages() Returns all installed script language descriptions.
protected void	unbindScriptEngineFactory(javax.script.ScriptEngineFactory factory) Unbinds a ScriptEngineFactory.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptExecution

public ScriptExecution()

Method Detail

execute

public Object execute(NonLiteral scriptResource)
               throws javax.script.ScriptException,
                      NoEngineException

Throws:

javax.script.ScriptException

NoEngineException

See Also:

execute(org.apache.clerezza.rdf.core.NonLiteral, javax.script.Bindings)

execute

public Object execute(NonLiteral scriptResource,
             javax.script.Bindings bindings)
               throws javax.script.ScriptException,
                      NoEngineException

Executes the specified scriptResource. The output is either a GraphNode or a response with the media type specified by the producedType property of the associated script. GraphNodes can be rendered by Renderlets registered for the type of the GraphNode.

Parameters:

scriptResource - The resource (URI).

bindings - Name/Value pairs of Java Objects made accessible to script

Returns:

The value returned from the execution of the script. Either a GraphNode or a Response.

Throws:

javax.script.ScriptException - If an error occurrs in the script.

NoEngineException - If no engine can be found

See Also:

SCRIPT.Script, SCRIPT.producedType, Renderlet

execute

public Object execute(String script,
             javax.script.Bindings bindings,
             String language,
             String languageVersion)
               throws javax.script.ScriptException,
                      NoEngineException

Executes the specified script with the ScriptEngine that is registered for language and languageVersion.

The default ScriptContext for the ScriptEngine is used. It uses bindings as the ScriptContext.ENGINE_SCOPE Bindings of the ScriptEngine during the script execution. Three new attributes are added to the bindings: contentGraphProvider, contentHandler, and tcManager. The Reader, Writer and non-ENGINE_SCOPE Bindings of the default ScriptContext are used. The ENGINE_SCOPE Bindings of the ScriptEngine is not changed, and its mappings are unaltered by the script execution.

Parameters:

script - The script language source to be executed.

bindings - The Bindings of attributes to be used for script execution.

language - The script language. It is used to determine the ScriptEngine.

languageVersion - The version of the script language. It is used to determine the ScriptEngine.

Returns:

The value returned from the execution of script.

Throws:

javax.script.ScriptException - If an error occurrs in the script.

NoEngineException - If no engine can be found for the specified language

See Also:

ScriptEngine.eval(java.lang.String, javax.script.Bindings)

getInstalledScriptLanguages

public Iterator<ScriptLanguageDescription> getInstalledScriptLanguages()

Returns all installed script language descriptions.

Returns:

All script language descriptions of the currently installed script engines.

See Also:

ScriptLanguageDescription

bindScriptEngineFactory

protected void bindScriptEngineFactory(javax.script.ScriptEngineFactory factory)

Binds a ScriptEngineFactory. If script engine factories for the same language and/or language version already exist, they are shadowed.

Parameters:

factory - the script engine factory to bind

unbindScriptEngineFactory

protected void unbindScriptEngineFactory(javax.script.ScriptEngineFactory factory)

Unbinds a ScriptEngineFactory.

Parameters:

factory - the script engine factory to unbind