Class SimpleScheduler

java.lang.Object

com.kingsrook.qqq.backend.core.scheduler.simple.SimpleScheduler

All Implemented Interfaces:

QSchedulerInterface

public class SimpleScheduler
extends Object
implements QSchedulerInterface

QQQ Service (Singleton) that starts up repeating, scheduled jobs within QQQ. These include: - Automation providers (which require polling) - Queue pollers - Scheduled processes. All of these jobs run using a "system session" - as defined by the sessionSupplier.

Field Summary

Fields

Modifier and Type	Field	Description
protected Supplier<QSession>	sessionSupplier

Method Summary

Modifier and Type	Method	Description
List<StandardScheduledExecutor>	getExecutors()	Getter for managedExecutors
static SimpleScheduler	getInstance(QInstance qInstance)	Singleton accessor
String	getSchedulerName()	Getter for schedulerName
Supplier<QSession>	getSessionSupplier()	Getter for sessionSupplier
boolean	isScheduled(BasicSchedulableIdentity schedulableIdentity, SchedulableType schedulableType)
void	setSchedulerName(String schedulerName)	Setter for schedulerName
void	setSessionSupplier(Supplier<QSession> sessionSupplier)	Setter for sessionSupplier
void	setupSchedulable(SchedulableIdentity schedulableIdentity, SchedulableType schedulableType, Map<String,Serializable> parameters, QScheduleMetaData schedule, boolean allowedToStart)
void	start()
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)
SimpleScheduler	withSchedulerName(String schedulerName)	Fluent setter for schedulerName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.scheduler.QSchedulerInterface

doNotStart, endOfSetupSchedules, startOfSetupSchedules

Field Details

sessionSupplier

protected Supplier<QSession> sessionSupplier

Method Details

getInstance

public static SimpleScheduler getInstance(QInstance qInstance)

Singleton accessor

start

public void start()

Specified by:

start in interface QSchedulerInterface

stopAsync

public void stopAsync()

Specified by:

stopAsync in interface QSchedulerInterface

stop

public void stop()

Specified by:

stop 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

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

setSessionSupplier

public void setSessionSupplier(Supplier<QSession> sessionSupplier)

Setter for sessionSupplier

getSessionSupplier

public Supplier<QSession> getSessionSupplier()

Getter for sessionSupplier

getExecutors

public List<StandardScheduledExecutor> getExecutors()

Getter for managedExecutors

getSchedulerName

public String getSchedulerName()

Getter for schedulerName

Specified by:

getSchedulerName in interface QSchedulerInterface

setSchedulerName

public void setSchedulerName(String schedulerName)

Setter for schedulerName

withSchedulerName

public SimpleScheduler withSchedulerName(String schedulerName)

Fluent setter for schedulerName

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