com.helger.quartz

Interface ITriggerListener

All Known Implementing Classes:

BroadcastTriggerListener, LoggingTriggerHistoryPlugin

public interface ITriggerListener

The interface to be implemented by classes that want to be informed when a ITrigger fires. In general, applications that use a Scheduler will not have use for this mechanism.

Author:

James House

See Also:

IListenerManager.addTriggerListener(ITriggerListener, IMatcher), IMatcher, ITrigger, IJobListener, IJobExecutionContext

Method Summary

Modifier and Type	Method and Description
String	getName() Get the name of the TriggerListener.
default void	triggerComplete(ITrigger trigger, IJobExecutionContext context, ITrigger.ECompletedExecutionInstruction triggerInstructionCode) Called by the IScheduler when a ITrigger has fired, it's associated IJobDetail has been executed, and it's triggered(xx) method has been called.
default void	triggerFired(ITrigger trigger, IJobExecutionContext context) Called by the IScheduler when a ITrigger has fired, and it's associated IJobDetail is about to be executed.
default void	triggerMisfired(ITrigger trigger) Called by the IScheduler when a ITrigger has misfired.
default boolean	vetoJobExecution(ITrigger trigger, IJobExecutionContext context) Called by the IScheduler when a ITrigger has fired, and it's associated IJobDetail is about to be executed.

Method Detail

getName

String getName()

Get the name of the TriggerListener.

triggerFired

default void triggerFired(ITrigger trigger,
                          IJobExecutionContext context)

Called by the IScheduler when a ITrigger has fired, and it's associated IJobDetail is about to be executed.

It is called before the vetoJobExecution(..) method of this interface.

Parameters:

trigger - The Trigger that has fired.

context - The JobExecutionContext that will be passed to the Job'sexecute(xx) method.

vetoJobExecution

default boolean vetoJobExecution(ITrigger trigger,
                                 IJobExecutionContext context)

Called by the IScheduler when a ITrigger has fired, and it's associated IJobDetail is about to be executed. If the implementation vetos the execution (via returning true), the job's execute method will not be called.

It is called after the triggerFired(..) method of this interface.

Parameters:

trigger - The Trigger that has fired.

context - The JobExecutionContext that will be passed to the Job'sexecute(xx) method.

triggerMisfired

default void triggerMisfired(ITrigger trigger)

Called by the IScheduler when a ITrigger has misfired.

Consideration should be given to how much time is spent in this method, as it will affect all triggers that are misfiring. If you have lots of triggers misfiring at once, it could be an issue it this method does a lot.

Parameters:

trigger - The Trigger that has misfired.

triggerComplete

default void triggerComplete(ITrigger trigger,
                             IJobExecutionContext context,
                             ITrigger.ECompletedExecutionInstruction triggerInstructionCode)

Called by the IScheduler when a ITrigger has fired, it's associated IJobDetail has been executed, and it's triggered(xx) method has been called.

Parameters:

trigger - The Trigger that was fired.

context - The JobExecutionContext that was passed to the Job'sexecute(xx) method.

triggerInstructionCode - the result of the call on the Trigger'striggered(xx) method.