Class QuartzScheduler

java.lang.Object

com.kingsrook.qqq.backend.core.scheduler.quartz.QuartzScheduler

All Implemented Interfaces:

QSchedulerInterface

public class QuartzScheduler
extends Object
implements QSchedulerInterface

Singleton to provide access between QQQ and the quartz Scheduler system.

Method Summary

Modifier and Type	Method	Description
boolean	deleteJob(org.quartz.JobKey jobKey)
void	doNotStart()	called to indicate that the schedule manager is past its startup routine, but that the schedule should not actually be running in this process.
void	endOfSetupSchedules()	let the scheduler know when the schedule manager is at the end of setting up schedules.
static QuartzScheduler	getInstance()	Singleton accessor
QInstance	getQInstance()	Getter for qInstance
String	getSchedulerName()
Supplier<QSession>	getSessionSupplier()	Getter for sessionSupplier
static QuartzScheduler	initInstance(QInstance qInstance, String schedulerName, Properties quartzProperties, Supplier<QSession> sessionSupplier)	Singleton initiator - e.g., must be called to initially initialize the singleton before anyone else calls getInstance (they'll get an error if they call that first).
boolean	isScheduled(BasicSchedulableIdentity schedulableIdentity, SchedulableType schedulableType)
void	pauseAll()
void	pauseJob(String jobName, String groupName)
List<QuartzJobAndTriggerWrapper>	queryQuartz()
void	resumeAll()
void	resumeJob(String jobName, String groupName)
void	setupSchedulable(SchedulableIdentity schedulableIdentity, SchedulableType schedulableType, Map<String,Serializable> parameters, QScheduleMetaData schedule, boolean allowedToStart)
void	start()
void	startOfSetupSchedules()	let the scheduler know when the schedule manager is at the start of setting up schedules.
void	stop()
void	stopAsync()
void	unInit()	Handle a whole shutdown of the scheduler system (e.g., between unit tests).
void	unscheduleAll()
void	unscheduleSchedulable(SchedulableIdentity schedulableIdentity, SchedulableType schedulableType)

Methods inherited from class java.lang.Object

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

Method Details

initInstance

public static QuartzScheduler initInstance(QInstance qInstance,
 String schedulerName,
 Properties quartzProperties,
 Supplier<QSession> sessionSupplier)
                                    throws org.quartz.SchedulerException

Singleton initiator - e.g., must be called to initially initialize the singleton before anyone else calls getInstance (they'll get an error if they call that first).

Throws:

org.quartz.SchedulerException

getInstance

public static QuartzScheduler getInstance()

Singleton accessor

getSchedulerName

public String getSchedulerName()

Specified by:

getSchedulerName in interface QSchedulerInterface

start

public void start()

Specified by:

start in interface QSchedulerInterface

doNotStart

public void doNotStart()

Description copied from interface: QSchedulerInterface

called to indicate that the schedule manager is past its startup routine, but that the schedule should not actually be running in this process.

Specified by:

doNotStart in interface QSchedulerInterface

stop

public void stop()

Specified by:

stop in interface QSchedulerInterface

stopAsync

public void stopAsync()

Specified by:

stopAsync in interface QSchedulerInterface

setupSchedulable

public void setupSchedulable(SchedulableIdentity schedulableIdentity,
 SchedulableType schedulableType,
 Map<String,Serializable> parameters,
 QScheduleMetaData schedule,
 boolean allowedToStart)

Specified by:

setupSchedulable in interface QSchedulerInterface

startOfSetupSchedules

public void startOfSetupSchedules()

Description copied from interface: QSchedulerInterface

let the scheduler know when the schedule manager is at the start of setting up schedules.

Specified by:

startOfSetupSchedules in interface QSchedulerInterface

endOfSetupSchedules

public void endOfSetupSchedules()

Description copied from interface: QSchedulerInterface

let the scheduler know when the schedule manager is at the end of setting up schedules.

Specified by:

endOfSetupSchedules in interface QSchedulerInterface

unscheduleSchedulable

public void unscheduleSchedulable(SchedulableIdentity schedulableIdentity,
 SchedulableType schedulableType)

Specified by:

unscheduleSchedulable in interface QSchedulerInterface

isScheduled

public boolean isScheduled(BasicSchedulableIdentity schedulableIdentity,
 SchedulableType schedulableType)

Specified by:

isScheduled in interface QSchedulerInterface

unscheduleAll

public void unscheduleAll()
                   throws QException

Specified by:

unscheduleAll in interface QSchedulerInterface

Throws:

QException

deleteJob

public boolean deleteJob(org.quartz.JobKey jobKey)

getQInstance

public QInstance getQInstance()

Getter for qInstance

getSessionSupplier

public Supplier<QSession> getSessionSupplier()

Getter for sessionSupplier

pauseAll

public void pauseAll()
              throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

resumeAll

public void resumeAll()
               throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

pauseJob

public void pauseJob(String jobName,
 String groupName)
              throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

resumeJob

public void resumeJob(String jobName,
 String groupName)
               throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

queryQuartz

public List<QuartzJobAndTriggerWrapper> queryQuartz()
                                             throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

unInit

public void unInit()

Description copied from interface: QSchedulerInterface

Handle a whole shutdown of the scheduler system (e.g., between unit tests).

Specified by:

unInit in interface QSchedulerInterface