Package org.craftercms.engine.scripting.impl

Class CachedScriptUrlTemplateScanner

java.lang.Object

org.craftercms.engine.scripting.impl.CachedScriptUrlTemplateScanner

All Implemented Interfaces:

EventListener, ScriptUrlTemplateScanner, org.springframework.context.ApplicationListener<SiteContextInitializedEvent>

public class CachedScriptUrlTemplateScanner
extends Object
implements ScriptUrlTemplateScanner, org.springframework.context.ApplicationListener<SiteContextInitializedEvent>

ScriptUrlTemplateScanner decorator that caches the result of an actual scan, and also pre-caches the URL templates on site context creation.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected ScriptUrlTemplateScanner	actualScanner
protected org.craftercms.core.util.cache.CacheTemplate	cacheTemplate
static final String	URL_TEMPLATES_CACHE_KEY_ELEM

Constructor Summary

Constructors

Constructor	Description
CachedScriptUrlTemplateScanner(org.craftercms.core.util.cache.CacheTemplate cacheTemplate, ScriptUrlTemplateScanner actualScanner)

Method Summary

Modifier and Type	Method	Description
void	onApplicationEvent(SiteContextInitializedEvent event)
List<org.springframework.web.util.UriTemplate>	scan(SiteContext siteContext)	Scans the site context at a certain path to discover script URL templates.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationListener

supportsAsyncExecution

Field Details

URL_TEMPLATES_CACHE_KEY_ELEM

public static final String URL_TEMPLATES_CACHE_KEY_ELEM

See Also:

• Constant Field Values

cacheTemplate

protected org.craftercms.core.util.cache.CacheTemplate cacheTemplate

actualScanner

protected ScriptUrlTemplateScanner actualScanner

Constructor Details

CachedScriptUrlTemplateScanner

public CachedScriptUrlTemplateScanner(org.craftercms.core.util.cache.CacheTemplate cacheTemplate,
 ScriptUrlTemplateScanner actualScanner)

Method Details

onApplicationEvent

public void onApplicationEvent(SiteContextInitializedEvent event)

Specified by:

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

scan

public List<org.springframework.web.util.UriTemplate> scan(SiteContext siteContext)

Description copied from interface: ScriptUrlTemplateScanner

Scans the site context at a certain path to discover script URL templates.

Specified by:

scan in interface ScriptUrlTemplateScanner

Parameters:

siteContext - the site context to scan

Returns:

the list of URL templates