org.apache.deltaspike.scheduler.spi

Interface SchedulerControl

public interface SchedulerControl

This interface provides high-level controls for the scheduler. It allows to control the scheduler as a whole (isSchedulerEnabled()()) and on a per-job basis (vetoJobExecution(Class). The interface is meant to be implemented by a CDI bean.

Method Summary

Modifier and Type	Method and Description
default boolean	isSchedulerEnabled() Control whether or not the scheduler should be started.
default boolean	vetoJobExecution(Class<?> jobClass) Invoked each time a job is triggered, this controls whether the given job shall be started or not.

Method Detail

isSchedulerEnabled

default boolean isSchedulerEnabled()

Control whether or not the scheduler should be started.

Returns:

if true the scheduler will be started, else not.

vetoJobExecution

default boolean vetoJobExecution(Class<?> jobClass)

Invoked each time a job is triggered, this controls whether the given job shall be started or not. NOTE: This only applies if the scheduler is actually running (see isSchedulerEnabled()).

Parameters:

jobClass - the job which was triggered

Returns:

if false the job will be executed, else not.