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<SiteContextCreatedEvent>

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

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 and Description
protected ScriptUrlTemplateScanner	actualScanner
protected org.craftercms.core.util.cache.CacheTemplate	cacheTemplate
static String	URL_TEMPLATES_CACHE_KEY_ELEM

Constructor Summary

Constructors

Constructor and Description
CachedScriptUrlTemplateScanner()

Method Summary

Modifier and Type	Method and Description
void	onApplicationEvent(SiteContextCreatedEvent event)
List<org.springframework.web.util.UriTemplate>	scan(SiteContext siteContext) Scans the site context at a certain path to discover script URL templates.
void	setActualScanner(ScriptUrlTemplateScanner actualScanner)
void	setCacheTemplate(org.craftercms.core.util.cache.CacheTemplate cacheTemplate)

Methods inherited from class java.lang.Object

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

Field Detail

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 Detail

CachedScriptUrlTemplateScanner

public CachedScriptUrlTemplateScanner()

Method Detail

setCacheTemplate

public void setCacheTemplate(org.craftercms.core.util.cache.CacheTemplate cacheTemplate)

setActualScanner

public void setActualScanner(ScriptUrlTemplateScanner actualScanner)

onApplicationEvent

public void onApplicationEvent(SiteContextCreatedEvent event)

Specified by:

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

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