Package de.xima.fc.timing

Class ScheduleManager

  • public class ScheduleManager
extends Object
    Manager-class for starting, stopping and removing schedules jobs
    Author:
    XIMA MEDIA GmbH

    • Constructor Detail

      • ScheduleManager

        public ScheduleManager()

    • Method Detail

      • addJob

        public static void addJob​(IJobWrapper job,
                          org.quartz.Trigger trigger)
        Attempt to add a job to the scheduler. If the job could not be added, logs an error. Prefer addJobIfPossible(IJobWrapper, Trigger) if you need to check whether the job was successfully added.
        Parameters:
        job - The data for the job to add.
        trigger - The trigger that controls the execution time of the job.

      • addJobIfPossible

        public static boolean addJobIfPossible​(IJobWrapper job,
                                       org.quartz.Trigger trigger)
        Attempt to add a job to the scheduler. If the job could not be added, logs an error and returns false.
        Parameters:
        job - The data for the job to add.
        trigger - The trigger that controls the execution time of the job.
        Returns:
        true if the job was successfully added, false otherwise.

      • getDefaultProperties

        public static Properties getDefaultProperties()
        Method to get the default Properties to start the scheduler with
        Returns:
        Properties to start the scheduler with

      • getJob

        public static org.quartz.JobDetail getJob​(org.quartz.JobKey key)
        Method to get a scheduled job by his key
        Parameters:
        key - JobKey to search the job with
        Returns:
        JobDetail the found job or null

      • getJobs

        public static Set<org.quartz.JobKey> getJobs​(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> groupMatcher)
        Finds all jobs that belong to the given groups.
        Parameters:
        groupMatcher - Details on the groups to match.
        Returns:
        All jobs that belong to a group matching the given matcher.

      • getJobs

        public static Set<org.quartz.JobKey> getJobs​(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> groupMatcher,
                                             NameMatcher<org.quartz.JobKey> nameMatcher)
        Finds all jobs with a certain name in the given groups.
        Parameters:
        groupMatcher - Details on the group to match.
        nameMatcher - Details on the name to match.
        Returns:
        All jobs with a name that matches the given name matcher that also belongs to a group matching the given group matcher.

      • getJobs

        public static Set<org.quartz.JobKey> getJobs​(NameMatcher<org.quartz.JobKey> nameMatcher)
        Finds all quartz jobs with a certain name.
        Parameters:
        nameMatcher - Details on the name to match.
        Returns:
        All jobs with a name that match the given matcher.

      • getScheduler

        public static org.quartz.Scheduler getScheduler()
        Returns:
        The current quartz scheduler. When quartz is not active, this returns null.

      • getTrigger

        public static org.quartz.Trigger getTrigger​(org.quartz.TriggerKey key)
        Method to get a trigger by its key
        Parameters:
        key - The trigger key to search the trigger for
        Returns:
        The trigger if found, or null otherwise.

      • getTriggers

        public static Set<org.quartz.TriggerKey> getTriggers​(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> groupMatcher)
        Finds all triggers that belong to the given groups.
        Parameters:
        groupMatcher - Details on the groups to match.
        Returns:
        All triggers that belong to a group matching the given matcher.

      • getTriggers

        public static Set<org.quartz.TriggerKey> getTriggers​(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> groupMatcher,
                                                     NameMatcher<org.quartz.TriggerKey> nameMatcher)
        Finds all triggers with a certain name in the given groups.
        Parameters:
        groupMatcher - Details on the group to match.
        nameMatcher - Details on the name to match.
        Returns:
        All triggers with a name that matches the given name matcher that also belongs to a group matching the given group matcher.

      • getTriggers

        public static Set<org.quartz.TriggerKey> getTriggers​(NameMatcher<org.quartz.TriggerKey> nameMatcher)
        Finds all quartz triggers with a certain name.
        Parameters:
        nameMatcher - Details on the name to match.
        Returns:
        All triggers with a name that match the given matcher.

      • initialize

        @Deprecated
public static void initialize()
        Deprecated.
        Scheduler lifecycle is now managed by SchedulerProviderImpl, this method does not have any effect anymore.
        Initializes the schedule manager. Checks whether all preconditions are met (database running etc.)

      • removeJob

        public static void removeJob​(org.quartz.JobKey key)
        Method to remove a job by his key
        Parameters:
        key - JobKey to find the job to remove

      • removeJobs

        public static void removeJobs​(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> groupMatcher)
        Removes all job that match the given group.
        Parameters:
        groupMatcher - Groups of jobs to remove.

      • removeJobs

        public static void removeJobs​(Set<org.quartz.JobKey> jobKeys)
        Removes all jobs that match the given job keys.
        Parameters:
        jobKeys - JobKeys of jobs to remove.

      • removeJobs

        public static void removeJobs​(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> groupMatcher,
                              NameMatcher<org.quartz.JobKey> nameMatcher)
        Removes all job that match the given group and name.
        Parameters:
        groupMatcher - Groups of jobs to remove.
        nameMatcher - Name of jobs to remove.

      • removeStartupListener

        public static void removeStartupListener​(IBaseNotificationListener listener)
        Deprecated.
        Use observer with SchedulerStartedEvent
        Parameters:
        listener - Listener not to invoke anymore when the scheduler is started.

      • setCustomProperties

        @Deprecated(forRemoval=true)
public static void setCustomProperties​(Properties properties)
        Deprecated, for removal: This API element is subject to removal in a future version.
        will be removed, does not have any effect anymore.
        Method to override the default properties
        Parameters:
        properties - Properties to start the scheduler with

      • shutdown

        public static void shutdown()
        Method to shut down the scheduler

      • start

        public static void start()
        Method to start the scheduler

      • standBy

        public static void standBy()

      • createUnstartedScheduler

        @Deprecated
public static org.quartz.Scheduler createUnstartedScheduler()
        Deprecated.

      • getQuartzDeletionExecutor

        public static ExecutorService getQuartzDeletionExecutor()