org.jahia.services.render.scripting.bundle

Class BundleScriptResolver

java.lang.Object

org.jahia.services.render.scripting.bundle.BundleScriptResolver

All Implemented Interfaces:

EventListener, ScriptResolver, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

public class BundleScriptResolver
extends Object
implements ScriptResolver, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

Constructor Summary

Constructors

Constructor and Description
BundleScriptResolver()

Method Summary

Modifier and Type	Method and Description
void	addBundleScript(org.osgi.framework.Bundle bundle, String path) Method for registering a new resource view for a bundle.
void	addBundleScripts(org.osgi.framework.Bundle bundle, List<URL> scripts) Callback for registering new resource views for a bundle.
static void	clearCaches() Utility method to clear all view caches
ScriptBundleObserver	getBundleObserver()
static BundleScriptResolver	getInstance()
ExtensionObserverRegistry	getObserverRegistry()
SortedSet<View>	getViewsSet(ExtendedNodeType nt, JCRSiteNode site, String templateType)
boolean	hasView(ExtendedNodeType nt, String key, JCRSiteNode site, String templateType)
void	onApplicationEvent(org.springframework.context.ApplicationEvent event)
void	register(ScriptEngineFactory scriptEngineFactory, org.osgi.framework.Bundle bundle) Registers the specified ScriptEngineFactory defined in the context of the specified starting Bundle.
void	registerObservers()
void	remove(ScriptEngineFactory factory, org.osgi.framework.Bundle bundle) Removes the specified ScriptEngineFactory from the known ones, deactivating any associated views from currently active bundles.
void	removeBundleScript(org.osgi.framework.Bundle bundle, String path) Method for unregistering a resource view for a bundle.
void	removeBundleScripts(org.osgi.framework.Bundle bundle, List<URL> scripts) Callback for unregistering resource views for a bundle.
Script	resolveScript(Resource resource, RenderContext renderContext)
void	setBundleScriptFactory(BundleJSR223ScriptFactory bundleScriptFactory)
void	setExtensionObserverRegistry(ExtensionObserverRegistry extensionObserverRegistry)
void	setIgnoredBundlePrefixes(Set<String> ignoredBundlePrefixes)
void	setScriptFactoryMap(Map<String,ScriptFactory> scriptFactoryMap)
void	setTemplateManagerService(JahiaTemplateManagerService templateManagerService)

Methods inherited from class java.lang.Object

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

Constructor Detail

BundleScriptResolver

public BundleScriptResolver()

Method Detail

setIgnoredBundlePrefixes

public void setIgnoredBundlePrefixes(Set<String> ignoredBundlePrefixes)

setExtensionObserverRegistry

public void setExtensionObserverRegistry(ExtensionObserverRegistry extensionObserverRegistry)

getObserverRegistry

public ExtensionObserverRegistry getObserverRegistry()

registerObservers

public void registerObservers()

getBundleObserver

public ScriptBundleObserver getBundleObserver()

getInstance

public static BundleScriptResolver getInstance()

setScriptFactoryMap

public void setScriptFactoryMap(Map<String,ScriptFactory> scriptFactoryMap)

register

public void register(ScriptEngineFactory scriptEngineFactory,
                     org.osgi.framework.Bundle bundle)

Registers the specified ScriptEngineFactory defined in the context of the specified starting Bundle. This results in registering the associated view extensions along with activating any existing views in active bundles. This registration operation also takes care of script extension re-ordering if necessary since bundles defining ScriptEngineFactories can do so.

Additionally, ScriptBundleURLScanner are also activated to look for any files with the newly registered extensions during future bundle deployments.

Parameters:

scriptEngineFactory - the ScriptEngineFactory instance we want to register

bundle - the starting bundle defining the given ScriptEngineFactory

remove

public void remove(ScriptEngineFactory factory,
                   org.osgi.framework.Bundle bundle)

Removes the specified ScriptEngineFactory from the known ones, deactivating any associated views from currently active bundles. This is called when a bundle declaring ScriptEngineFactories is stopping. Previously registered extension observers associated with the ScriptEngineFactory's supported extensions are also removed.

Parameters:

factory - the factory to be removed

bundle - the bundle which declared the factory and which is being stopped

addBundleScripts

public void addBundleScripts(org.osgi.framework.Bundle bundle,
                             List<URL> scripts)

Callback for registering new resource views for a bundle.

Parameters:

bundle - the bundle to register views for

scripts - the URLs of the views to register

addBundleScript

public void addBundleScript(org.osgi.framework.Bundle bundle,
                            String path)

Method for registering a new resource view for a bundle.

Parameters:

bundle - the bundle to register views for

path - the path of the view to register

removeBundleScripts

public void removeBundleScripts(org.osgi.framework.Bundle bundle,
                                List<URL> scripts)

Callback for unregistering resource views for a bundle.

Parameters:

bundle - the bundle to unregister views for

scripts - the URLs of the views to unregister

removeBundleScript

public void removeBundleScript(org.osgi.framework.Bundle bundle,
                               String path)

Method for unregistering a resource view for a bundle.

Parameters:

bundle - the bundle to unregister views for

path - the path of the view to unregister

resolveScript

public Script resolveScript(Resource resource,
                            RenderContext renderContext)
                     throws TemplateNotFoundException

Specified by:

resolveScript in interface ScriptResolver

Throws:

TemplateNotFoundException

hasView

public boolean hasView(ExtendedNodeType nt,
                       String key,
                       JCRSiteNode site,
                       String templateType)

Specified by:

hasView in interface ScriptResolver

getViewsSet

public SortedSet<View> getViewsSet(ExtendedNodeType nt,
                                   JCRSiteNode site,
                                   String templateType)

Specified by:

getViewsSet in interface ScriptResolver

setTemplateManagerService

public void setTemplateManagerService(JahiaTemplateManagerService templateManagerService)

onApplicationEvent

public void onApplicationEvent(org.springframework.context.ApplicationEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

clearCaches

public static void clearCaches()

Utility method to clear all view caches

setBundleScriptFactory

public void setBundleScriptFactory(BundleJSR223ScriptFactory bundleScriptFactory)