org.jahia.utils

Class ScriptEngineUtils

java.lang.Object

org.jahia.utils.ScriptEngineUtils

public class ScriptEngineUtils
extends Object

ScriptEngine provider class.

Since:

JAHIA 6.5 Created : 27/01/11

Author:

rincevent

Method Summary

Modifier and Type	Method and Description
static boolean	canFactoryForExtensionProcessViews(String extension, Dictionary<String,String> headers) Determines whether the ScriptEngineFactory associated with the specified extension supports at least one of the script names declared by the given OSGi headers assuming they provide a value for the BundleScriptingConfigurationConstants.JAHIA_MODULE_SCRIPTING_VIEWS header.
static boolean	canFactoryProcessViews(ScriptEngineFactory scriptFactory, Dictionary<String,String> headers) Determines whether the specified ScriptEngineFactory supports at least one of the script names declared by the given OSGi headers assuming they provide a value for the BundleScriptingConfigurationConstants.JAHIA_MODULE_SCRIPTING_VIEWS header.
ScriptEngine	getEngineByName(String name) Returns an instance of a ScriptEngine by its name.
static ScriptEngineUtils	getInstance()
ScriptEngine	scriptEngine(String extension) Returns an instance of a ScriptEngine by its file extension.

Methods inherited from class java.lang.Object

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

Method Detail

canFactoryForExtensionProcessViews

public static boolean canFactoryForExtensionProcessViews(String extension,
                                                         Dictionary<String,String> headers)

Determines whether the ScriptEngineFactory associated with the specified extension supports at least one of the script names declared by the given OSGi headers assuming they provide a value for the BundleScriptingConfigurationConstants.JAHIA_MODULE_SCRIPTING_VIEWS header.

Parameters:

extension - the extension associated with the factory whose support for views defined in the specified bundle is to be determined

headers - the OSGi headers to be checked if declared view technologies defined by the BundleScriptingConfigurationConstants.JAHIA_MODULE_SCRIPTING_VIEWS OSGI header are supported by the specified ScriptEngineFactory

Returns:

true if the specified ScriptEngineFactory can handle at least one of the specified script names, false otherwise. Note that if the headers contain the BundleScriptingConfigurationConstants.JAHIA_MODULE_HAS_VIEWS header with a "no" value, we won't look at other headers since the module has indicated that it shouldn't contain any views so the factory shouldn't attempt to process any it might find.

canFactoryProcessViews

public static boolean canFactoryProcessViews(ScriptEngineFactory scriptFactory,
                                             Dictionary<String,String> headers)

Determines whether the specified ScriptEngineFactory supports at least one of the script names declared by the given OSGi headers assuming they provide a value for the BundleScriptingConfigurationConstants.JAHIA_MODULE_SCRIPTING_VIEWS header.

Parameters:

scriptFactory - the ScriptEngineFactory whose support for views defined in the specified bundle is to be determined

headers - the OSGi headers to be checked if declared view technologies defined by the BundleScriptingConfigurationConstants.JAHIA_MODULE_SCRIPTING_VIEWS OSGI header are supported by the specified ScriptEngineFactory

Returns:

true if the specified ScriptEngineFactory can handle at least one of the specified script names, false otherwise. Note that if the headers contain the BundleScriptingConfigurationConstants.JAHIA_MODULE_HAS_VIEWS header with a "no" value, we won't look at other headers since the module has indicated that it shouldn't contain any views so the factory shouldn't attempt to process any it might find.

getInstance

public static ScriptEngineUtils getInstance()

getEngineByName

public ScriptEngine getEngineByName(String name)
                             throws ScriptException

Returns an instance of a ScriptEngine by its name.

Parameters:

name - the name of the script engine to look for

Returns:

an instance of a ScriptEngine by its name

Throws:

ScriptException - in case of a script engine initialization error

scriptEngine

public ScriptEngine scriptEngine(String extension)
                          throws ScriptException

Returns an instance of a ScriptEngine by its file extension.

Parameters:

extension - the extension of the script engine to look for

Returns:

an instance of a ScriptEngine by its name

Throws:

ScriptException - in case of a script engine initialization error