Package com.broadleafcommerce.scheduledjob.service

Interface SchedulerService

All Known Implementing Classes:
DefaultSchedulerService
public interface SchedulerService
Uses quartz scheduling to schedule quartz jobs.
Author:
Chad Harchar (charchar), Jeff Fischer

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<org.quartz.JobDetail>
    processJob(ScheduledJob job)
    Review a ScheduledJob and add scheduling and trigger information to the running quartz instance, if it's not already there.
    void
    schedule(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Initiates the quartz scheduler to create, update, and delete quartz jobs according to the Scheduled Jobs defined in the database.
    void
    unschedule(@NonNull ScheduledJob job, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Delete the ScheduledJob from the Scheduler - and any associated Triggers.

  • Method Details

    • schedule

      void schedule(@Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Initiates the quartz scheduler to create, update, and delete quartz jobs according to the Scheduled Jobs defined in the database.
      Parameters:
      contextInfo - context information surrounding multitenant state

    • unschedule

      void unschedule(@NonNull @NonNull ScheduledJob job, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) throws org.quartz.SchedulerException
      Delete the ScheduledJob from the Scheduler - and any associated Triggers.
      Parameters:
      job - The scheduled job entity
      contextInfo - context information surrounding multitenant state
      Throws:
      org.quartz.SchedulerException - Thrown if a problem occurs in Quartz during scheduling

    • processJob

      Optional<org.quartz.JobDetail> processJob(ScheduledJob job) throws org.quartz.SchedulerException
      Review a ScheduledJob and add scheduling and trigger information to the running quartz instance, if it's not already there.
      Parameters:
      job - The scheduled job entity
      Returns:
      The JobDetail resulting from Quartz scheduling, if the item was scheduled
      Throws:
      org.quartz.SchedulerException - Thrown if a problem occurs in Quartz during scheduling