com.helger.quartz.listeners

Class BroadcastTriggerListener

java.lang.Object

com.helger.quartz.listeners.BroadcastTriggerListener

All Implemented Interfaces:

ITriggerListener

public class BroadcastTriggerListener
extends Object
implements ITriggerListener

Holds a List of references to TriggerListener instances and broadcasts all events to them (in order).

The broadcasting behavior of this listener to delegate listeners may be more convenient than registering all of the listeners directly with the Scheduler, and provides the flexibility of easily changing which listeners get notified.

Author:

James House (jhouse AT revolition DOT net)

See Also:

addListener(com.helger.quartz.ITriggerListener), removeListener(com.helger.quartz.ITriggerListener)

Constructor Summary

Constructors

Constructor and Description
BroadcastTriggerListener(String name) Construct an instance with the given name.
BroadcastTriggerListener(String name, Iterable<? extends ITriggerListener> listeners) Construct an instance with the given name, and List of listeners.

Method Summary

Modifier and Type	Method and Description
void	addListener(ITriggerListener listener)
com.helger.commons.collection.impl.ICommonsList<ITriggerListener>	getListeners()
String	getName() Get the name of the TriggerListener.
boolean	removeListener(ITriggerListener listener)
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.
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.
void	triggerMisfired(ITrigger trigger) Called by the IScheduler when a ITrigger has misfired.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BroadcastTriggerListener

public BroadcastTriggerListener(@Nonnull
                                String name)

Construct an instance with the given name. (Remember to add some delegate listeners!)

Parameters:

name - the name of this instance

BroadcastTriggerListener

public BroadcastTriggerListener(@Nonnull
                                String name,
                                Iterable<? extends ITriggerListener> listeners)

Construct an instance with the given name, and List of listeners.

Parameters:

name - the name of this instance

listeners - the initial List of TriggerListeners to broadcast to.

Method Detail

getName

@Nonnull
public String getName()

Description copied from interface: ITriggerListener

Get the name of the TriggerListener.

Specified by:

getName in interface ITriggerListener

addListener

public void addListener(@Nonnull
                        ITriggerListener listener)

removeListener

public boolean removeListener(ITriggerListener listener)

getListeners

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<ITriggerListener> getListeners()

triggerFired

public void triggerFired(ITrigger trigger,
                         IJobExecutionContext context)

Description copied from interface: ITriggerListener

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.

Specified by:

triggerFired in interface ITriggerListener

Parameters:

trigger - The Trigger that has fired.

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

vetoJobExecution

public boolean vetoJobExecution(ITrigger trigger,
                                IJobExecutionContext context)

Description copied from interface: ITriggerListener

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.

Specified by:

vetoJobExecution in interface ITriggerListener

Parameters:

trigger - The Trigger that has fired.

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

triggerMisfired

public void triggerMisfired(ITrigger trigger)

Description copied from interface: ITriggerListener

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.

Specified by:

triggerMisfired in interface ITriggerListener

Parameters:

trigger - The Trigger that has misfired.

triggerComplete

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

Description copied from interface: ITriggerListener

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.

Specified by:

triggerComplete in interface ITriggerListener

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.