Package org.craftercms.engine.scripting.impl

Class ScriptUrlTemplateScannerImpl

java.lang.Object

org.craftercms.engine.scripting.impl.ScriptUrlTemplateScannerImpl

All Implemented Interfaces:

ScriptUrlTemplateScanner

public class ScriptUrlTemplateScannerImpl
extends Object
implements ScriptUrlTemplateScanner

Default implementation of ScriptUrlTemplateScanner, which retrieves all the Groovy scripts at the specified scriptsFolder path, and then looks for those that have the URL variable placeholder in them.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_URL_VARIABLE_PLACEHOLDER_PATTERN
protected String	scriptsFolder
protected Pattern	urlVariablePlaceholderPattern

Constructor Summary

Constructors

Constructor	Description
ScriptUrlTemplateScannerImpl(String scriptsFolder)

Method Summary

Modifier and Type	Method	Description
void	findScripts(org.craftercms.core.service.Context context, org.craftercms.core.service.ContentStoreService storeService, ScriptFactory scriptFactory, String folder, List<String> scriptUrls)
List<org.springframework.web.util.UriTemplate>	scan(SiteContext siteContext)	Scans the site context at a certain path to discover script URL templates.
void	setUrlVariablePlaceholderPattern(String urlVariablePlaceholderPattern)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_URL_VARIABLE_PLACEHOLDER_PATTERN

public static final String DEFAULT_URL_VARIABLE_PLACEHOLDER_PATTERN

See Also:

• Constant Field Values

urlVariablePlaceholderPattern

protected Pattern urlVariablePlaceholderPattern

scriptsFolder

protected String scriptsFolder

Constructor Details

ScriptUrlTemplateScannerImpl

public ScriptUrlTemplateScannerImpl(String scriptsFolder)

Method Details

setUrlVariablePlaceholderPattern

public void setUrlVariablePlaceholderPattern(String urlVariablePlaceholderPattern)

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

findScripts

public void findScripts(org.craftercms.core.service.Context context,
 org.craftercms.core.service.ContentStoreService storeService,
 ScriptFactory scriptFactory,
 String folder,
 List<String> scriptUrls)