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 String
CRON_EXPRESSION_KEY
protected boolean
disableVariableRestrictions
static String
JOB_FOLDER_KEY
static String
JOB_KEY
static String
PATH_KEY
protected String
scriptSuffix
protected javax.servlet.ServletContext
servletContext
-
Constructor Summary
Constructors Constructor Description ConfigurationScriptJobResolver()
-
Method Summary
All Methods Instance Methods Concrete Methods 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
setScriptSuffix(String scriptSuffix)
void
setServletContext(javax.servlet.ServletContext servletContext)
-
-
-
Field Detail
-
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 javax.servlet.ServletContext servletContext
-
disableVariableRestrictions
protected boolean disableVariableRestrictions
-
-
Method Detail
-
setScriptSuffix
public void setScriptSuffix(String scriptSuffix)
-
setServletContext
public void setServletContext(javax.servlet.ServletContext servletContext)
- Specified by:
setServletContext
in interfaceorg.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 interfaceScriptJobResolver
- 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)
-
-