Package org.craftercms.engine.scripting.impl

Class FolderBasedScriptJobResolver

java.lang.Object

org.craftercms.engine.scripting.impl.FolderBasedScriptJobResolver

All Implemented Interfaces:

ScriptJobResolver, org.springframework.beans.factory.Aware, org.springframework.web.context.ServletContextAware

public class FolderBasedScriptJobResolver
extends Object
implements ScriptJobResolver, org.springframework.web.context.ServletContextAware

Folder based ScriptJobResolver, which resolves all scripts under a certain folder, and creates a trigger to run them using a specific cron expression. For example, a resolver for the folder name daily can return scripts that need to be run every day at 12:00 am.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected String	cronExpression
protected boolean	disableVariableRestrictions
protected String	folderUrl
protected String	scriptSuffix
protected jakarta.servlet.ServletContext	servletContext

Constructor Summary

Constructors

Constructor	Description
FolderBasedScriptJobResolver(String scriptSuffix, String folderUrl, String cronExpression)

Method Summary

Modifier and Type	Method	Description
List<JobContext>	resolveJobs(SiteContext siteContext)	Resolves any number of script jobs to be scheduled and executed.
void	setDisableVariableRestrictions(boolean disableVariableRestrictions)
void	setServletContext(jakarta.servlet.ServletContext servletContext)

Methods inherited from class java.lang.Object

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

Field Details

folderUrl

protected String folderUrl

cronExpression

protected String cronExpression

scriptSuffix

protected String scriptSuffix

servletContext

protected jakarta.servlet.ServletContext servletContext

disableVariableRestrictions

protected boolean disableVariableRestrictions

Constructor Details

FolderBasedScriptJobResolver

public FolderBasedScriptJobResolver(String scriptSuffix,
 String folderUrl,
 String cronExpression)

Method Details

setServletContext

public void setServletContext(jakarta.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

setDisableVariableRestrictions

public void setDisableVariableRestrictions(boolean disableVariableRestrictions)

resolveJobs

public List<JobContext> resolveJobs(SiteContext siteContext)
                             throws SchedulingException

Description copied from interface: ScriptJobResolver

Resolves any number of script jobs to be scheduled and executed.

Specified by:

resolveJobs in interface ScriptJobResolver

Parameters:

siteContext - the context used to look up for the scripts

Returns:

the details of the jobs to be scheduled

Throws:

SchedulingException