Class JobSchedulerFacade

  • All Implemented Interfaces:
    JobScheduler

    public class JobSchedulerFacade
    extends Object
    implements JobScheduler
    A wrapper for instances of the JobScheduler interface that ensures that methods provides safe and sane return values and can deal with null values being passed in etc. Provides a measure of safety when using unknown implementations of the JobSchedulerStore which might not always do the right thing.
    • Method Detail

      • remove

        public void remove​(long time)
                    throws Exception
        Description copied from interface: JobScheduler
        remove all jobs scheduled to run at this time
        Specified by:
        remove in interface JobScheduler
        Parameters:
        time - The UTC time to use to remove a batch of scheduled Jobs.
        Throws:
        Exception
      • remove

        public void remove​(String jobId)
                    throws Exception
        Description copied from interface: JobScheduler
        remove a job with the matching jobId
        Specified by:
        remove in interface JobScheduler
        Parameters:
        jobId - The unique Job Id to search for and remove from the scheduled set of jobs.
        Throws:
        Exception - if an error occurs while removing the Job.
      • removeAllJobs

        public void removeAllJobs​(long start,
                                  long finish)
                           throws Exception
        Description copied from interface: JobScheduler
        remove all the Jobs from the scheduler that are due between the start and finish times
        Specified by:
        removeAllJobs in interface JobScheduler
        Parameters:
        start - time in milliseconds
        finish - time in milliseconds
        Throws:
        Exception
      • removeListener

        public void removeListener​(JobListener l)
                            throws Exception
        Description copied from interface: JobScheduler
        remove a JobListener that was previously registered. If the given listener is not in the registry this method has no effect.
        Specified by:
        removeListener in interface JobScheduler
        Parameters:
        l - The listener that should be removed from the listener registry.
        Throws:
        Exception
      • schedule

        public void schedule​(String jobId,
                             ByteSequence payload,
                             long delay)
                      throws Exception
        Description copied from interface: JobScheduler
        Add a job to be scheduled
        Specified by:
        schedule in interface JobScheduler
        Parameters:
        jobId - a unique identifier for the job
        payload - the message to be sent when the job is scheduled
        delay - the time in milliseconds before the job will be run
        Throws:
        Exception - if an error occurs while scheduling the Job.
      • schedule

        public void schedule​(String jobId,
                             ByteSequence payload,
                             String cronEntry,
                             long start,
                             long period,
                             int repeat)
                      throws Exception
        Description copied from interface: JobScheduler
        Add a job to be scheduled
        Specified by:
        schedule in interface JobScheduler
        Parameters:
        jobId - a unique identifier for the job
        payload - the message to be sent when the job is scheduled
        cronEntry - cron entry
        start - time in ms to wait before scheduling
        period - the time in milliseconds between successive executions of the Job
        repeat - the number of times to execute the job - less than 0 will be repeated forever
        Throws:
        Exception
      • schedule

        public void schedule​(String jobId,
                             ByteSequence payload,
                             String cronEntry)
                      throws Exception
        Description copied from interface: JobScheduler
        Add a job to be scheduled
        Specified by:
        schedule in interface JobScheduler
        Parameters:
        jobId - a unique identifier for the job
        payload - the message to be sent when the job is scheduled
        cronEntry - The cron entry to use to schedule this job.
        Throws:
        Exception - if an error occurs while scheduling the Job.
      • startDispatching

        public void startDispatching()
                              throws Exception
        Description copied from interface: JobScheduler
        Starts dispatch of scheduled Jobs to registered listeners. Any listener added after the start dispatch method can miss jobs so its important to register critical listeners before the start of job dispatching.
        Specified by:
        startDispatching in interface JobScheduler
        Throws:
        Exception