Package io.mangoo.scheduler

Class Scheduler

java.lang.Object

io.mangoo.scheduler.Scheduler

public class Scheduler
extends Object

Convenient class for interacting with the quartz scheduler

Author:

svenkubiak

Constructor Summary

Constructors

Constructor	Description
Scheduler(Config config)

Method Summary

Modifier and Type	Method	Description
void	changeState(String jobName)	Changes the state of a normally running job from pause to resume or resume to pause
void	deleteJob(String name)	Delete a job by a given name
void	executeJob(String jobName)	Executes a single Quartz Scheduler job right away only once
List<org.quartz.JobKey>	getAllJobKeys()	Retrieves a list of all JobKeys from the Quartz Scheduler
List<Job>	getAllJobs()	Retrieves a list of all jobs and their current status
org.quartz.JobKey	getJobKey(String name)	Retrieves a JobKey by it given name
org.quartz.Scheduler	getQuartzScheduler()	Returns the current quartz scheduler instance
void	initialize()	Initializes the scheduler by booting up Quartz
boolean	isInitialize()	Checks if the scheduler has been initialized
boolean	isStarted()	Checks if the scheduler is initialized and started
void	pauseJob(String name)	Pauses a job by a given name
void	resumeJob(String name)	Resume a job by a given name
void	schedule(org.quartz.JobDetail jobDetail, org.quartz.Trigger trigger)	Adds a new job with a given JobDetail and Trigger to the scheduler
void	shutdown()
void	standby()
void	start()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Scheduler

@Inject
public Scheduler(Config config)

Method Detail

initialize

public void initialize()

Initializes the scheduler by booting up Quartz

isInitialize

public boolean isInitialize()

Checks if the scheduler has been initialized

Returns:

True if the scheduler has been initializes, false otherwise

isStarted

public boolean isStarted()
                  throws MangooSchedulerException

Checks if the scheduler is initialized and started

Returns:

true if the scheduler is started, false otherwise

Throws:

MangooSchedulerException - if an error occurred accessing the scheduler

getQuartzScheduler

public org.quartz.Scheduler getQuartzScheduler()

Returns the current quartz scheduler instance

Returns:

Scheduler instance, null if scheduler is not initialize or started

start

public void start()
           throws MangooSchedulerException

Throws:

MangooSchedulerException

shutdown

public void shutdown()
              throws MangooSchedulerException

Throws:

MangooSchedulerException

standby

public void standby()
             throws MangooSchedulerException

Throws:

MangooSchedulerException

schedule

public void schedule(org.quartz.JobDetail jobDetail,
                     org.quartz.Trigger trigger)
              throws MangooSchedulerException

Adds a new job with a given JobDetail and Trigger to the scheduler

Parameters:

jobDetail - The JobDetail for the Job

trigger - The Trigger for the job

Throws:

MangooSchedulerException - when accessing the scheduler results in an error

getAllJobs

public List<Job> getAllJobs()
                     throws MangooSchedulerException

Retrieves a list of all jobs and their current status

Returns:

List of io.mangoo.models.Job objects

Throws:

MangooSchedulerException - if an error occurs during access to the Quartz Scheduler

pauseJob

public void pauseJob(String name)
              throws MangooSchedulerException

Pauses a job by a given name

Parameters:

name - The name of the job to pause

Throws:

MangooSchedulerException - when pausing fails

resumeJob

public void resumeJob(String name)
               throws MangooSchedulerException

Resume a job by a given name

Parameters:

name - The name of the job to resume

Throws:

MangooSchedulerException - if resuming fails

deleteJob

public void deleteJob(String name)
               throws MangooSchedulerException

Delete a job by a given name

Parameters:

name - The name of the job to delete

Throws:

MangooSchedulerException - if deletion fails

getJobKey

public org.quartz.JobKey getJobKey(String name)
                            throws MangooSchedulerException

Retrieves a JobKey by it given name

Parameters:

name - The name of the Job in the Scheduler

Returns:

Optional of JobKey

Throws:

MangooSchedulerException - if retrieving the job fails

executeJob

public void executeJob(String jobName)
                throws MangooSchedulerException

Executes a single Quartz Scheduler job right away only once

Parameters:

jobName - The name of the job to execute

Throws:

MangooSchedulerException - if an error occurs during execution of the job

getAllJobKeys

public List<org.quartz.JobKey> getAllJobKeys()
                                      throws MangooSchedulerException

Retrieves a list of all JobKeys from the Quartz Scheduler

Returns:

List of all JobKey objects

Throws:

MangooSchedulerException - if an errors occurs during access to the scheduler

changeState

public void changeState(String jobName)
                 throws MangooSchedulerException

Changes the state of a normally running job from pause to resume or resume to pause

Parameters:

jobName - The name of the job

Throws:

MangooSchedulerException - if an error occurs during access to the quartz scheduler