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 Details

    • folderUrl

      protected String folderUrl

    • cronExpression

      protected String cronExpression

    • scriptSuffix

      protected String scriptSuffix

    • servletContext

      protected javax.servlet.ServletContext servletContext

    • disableVariableRestrictions

      protected boolean disableVariableRestrictions

  • Constructor Details

    • FolderBasedScriptJobResolver

      public FolderBasedScriptJobResolver()

  • Method Details

    • setFolderUrl

      public void setFolderUrl(String folderUrl)

    • setCronExpression

      public void setCronExpression(String cronExpression)

    • setScriptSuffix

      public void setScriptSuffix(String scriptSuffix)

    • setServletContext

      public void setServletContext(javax.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