Package org.craftercms.engine.scripting.impl

Class ConfigurationScriptJobResolver

java.lang.Object

org.craftercms.engine.scripting.impl.ConfigurationScriptJobResolver

All Implemented Interfaces:

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

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

ScriptJobResolver that resolves job based on configuration mappings, like the following:

     <jobs>
         <jobFolder>
             <path>/scripts/jobs/every15mins</path>
             <cronExpression>0 0/15 * * * ?</cronExpression>
         </jobFolder>
         <job>
             <path>/scripts/jobs/myJob.groovy</path>
             <cronExpression>0 0/15 * * * ?</cronExpression>
         </job>
     </jobs>
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CRON_EXPRESSION_KEY
protected boolean	disableVariableRestrictions
static final String	JOB_FOLDER_KEY
static final String	JOB_KEY
static final String	PATH_KEY
protected String	scriptSuffix
protected jakarta.servlet.ServletContext	servletContext

Constructor Summary

Constructors

Constructor	Description
ConfigurationScriptJobResolver(String scriptSuffix)

Method Summary

Modifier and Type	Method	Description
protected JobContext	getJob(SiteContext siteContext, org.apache.commons.configuration2.HierarchicalConfiguration jobConfig)
protected List<JobContext>	getJobsUnderFolder(SiteContext siteContext, org.apache.commons.configuration2.HierarchicalConfiguration jobFolderConfig)
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

JOB_FOLDER_KEY

public static final String JOB_FOLDER_KEY

See Also:

• Constant Field Values

JOB_KEY

public static final String JOB_KEY

See Also:

• Constant Field Values

PATH_KEY

public static final String PATH_KEY

See Also:

• Constant Field Values

CRON_EXPRESSION_KEY

public static final String CRON_EXPRESSION_KEY

See Also:

• Constant Field Values

scriptSuffix

protected String scriptSuffix

servletContext

protected jakarta.servlet.ServletContext servletContext

disableVariableRestrictions

protected boolean disableVariableRestrictions

Constructor Details

ConfigurationScriptJobResolver

public ConfigurationScriptJobResolver(String scriptSuffix)

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

getJobsUnderFolder

protected List<JobContext> getJobsUnderFolder(SiteContext siteContext,
 org.apache.commons.configuration2.HierarchicalConfiguration jobFolderConfig)

getJob

protected JobContext getJob(SiteContext siteContext,
 org.apache.commons.configuration2.HierarchicalConfiguration jobConfig)