org.jahia.services.render.scripting.bundle

Class BundleScriptEngineManager

java.lang.Object

javax.script.ScriptEngineManager

org.jahia.services.render.scripting.bundle.BundleScriptEngineManager

public class BundleScriptEngineManager
extends ScriptEngineManager

A replacement for the JDK's ScriptEngineManager that properly deals with ScriptEngineFactory implementations provided in OSGi modules. In particular, bundles that provide a javax.script.ScriptEngineFactory file in their META-INF/services directory (Java Service Provider infrastructure) will be handled by this ScriptEngineManager, wrapping the provided ScriptEngineFactory implementation in a BundleScriptEngineFactory so that the appropriate class loader will be used to resolve views and associated resources. Additionally, provided script extensions will now be listened to and installed bundles will be scanned so that any installed module that provides views that can be handled by the newly installed ScriptEngineFactory will be now able to answer to view requests.

Additionally, if the provided ScriptEngineFactory implementations also implement Configurable, this BundleScriptEngineManager will call its methods so that additional set up / clean up can be performed when the bundle is started or stopped.

Method Summary

Modifier and Type	Method and Description
void	addScriptEngineFactoriesIfNeeded(org.osgi.framework.Bundle bundle) Register any ScriptEngineFactory instances defined in the context of the specified Bundle.
Object	get(String key)
Bindings	getBindings()
ScriptEngine	getEngineByExtension(String extension)
ScriptEngine	getEngineByMimeType(String mimeType)
ScriptEngine	getEngineByName(String shortName)
List<ScriptEngineFactory>	getEngineFactories()
ScriptEngineFactory	getFactoryForExtension(String extension)
static BundleScriptEngineManager	getInstance() Returns a singleton instance of this class.
void	put(String key, Object value)
void	registerEngineExtension(String extension, ScriptEngineFactory factory)
void	registerEngineMimeType(String type, ScriptEngineFactory factory)
void	registerEngineName(String name, ScriptEngineFactory factory)
void	removeScriptEngineFactoriesIfNeeded(org.osgi.framework.Bundle bundle) Removes the ScriptEngineFactory instances associated with the specified Bundle when it is stopped, making sure that the associated views are also made unavailable by calling BundleScriptResolver.remove(ScriptEngineFactory, Bundle).
void	setBindings(Bindings bindings)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static BundleScriptEngineManager getInstance()

Returns a singleton instance of this class.

Returns:

a singleton instance of this class

get

public Object get(String key)

Overrides:

get in class ScriptEngineManager

getBindings

public Bindings getBindings()

Overrides:

getBindings in class ScriptEngineManager

put

public void put(String key,
                Object value)

Overrides:

put in class ScriptEngineManager

setBindings

public void setBindings(Bindings bindings)

Overrides:

setBindings in class ScriptEngineManager

getEngineByExtension

public ScriptEngine getEngineByExtension(String extension)

Overrides:

getEngineByExtension in class ScriptEngineManager

getEngineByMimeType

public ScriptEngine getEngineByMimeType(String mimeType)

Overrides:

getEngineByMimeType in class ScriptEngineManager

getEngineByName

public ScriptEngine getEngineByName(String shortName)

Overrides:

getEngineByName in class ScriptEngineManager

getEngineFactories

public List<ScriptEngineFactory> getEngineFactories()

Overrides:

getEngineFactories in class ScriptEngineManager

registerEngineExtension

public void registerEngineExtension(String extension,
                                    ScriptEngineFactory factory)

Overrides:

registerEngineExtension in class ScriptEngineManager

registerEngineMimeType

public void registerEngineMimeType(String type,
                                   ScriptEngineFactory factory)

Overrides:

registerEngineMimeType in class ScriptEngineManager

registerEngineName

public void registerEngineName(String name,
                               ScriptEngineFactory factory)

Overrides:

registerEngineName in class ScriptEngineManager

removeScriptEngineFactoriesIfNeeded

public void removeScriptEngineFactoriesIfNeeded(org.osgi.framework.Bundle bundle)

Removes the ScriptEngineFactory instances associated with the specified Bundle when it is stopped, making sure that the associated views are also made unavailable by calling BundleScriptResolver.remove(ScriptEngineFactory, Bundle).

Parameters:

bundle - the stopping bundle for which we want to deactivate ScriptEngineFactories if needed

addScriptEngineFactoriesIfNeeded

public void addScriptEngineFactoriesIfNeeded(org.osgi.framework.Bundle bundle)

Register any ScriptEngineFactory instances defined in the context of the specified Bundle. Any ScriptEngineFactory implementation that is declared in the META-INF/services/javax.script.ScriptEngineFactory file of the Bundle is instantiated and configured. Additionally, the OSGi headers are examined to look for any Jahia-Scripting-Extensions-Priorities header value to configure ordering of scripting languages. If the declared ScriptEngineFactory implements Configurable, its method will be called when appropriate automatically. Finally, BundleScriptResolver.register(ScriptEngineFactory, Bundle) is called for each such configured ScriptEngineFactory in order to be notify it that new scripting languages are available and activate associated views if needed.

Parameters:

bundle - the starting bundle for which we want to activate ScriptEngineFactories if needed

getFactoryForExtension

public ScriptEngineFactory getFactoryForExtension(String extension)