com.helger.quartz.listeners

Class BroadcastJobListener

java.lang.Object

com.helger.quartz.listeners.BroadcastJobListener

All Implemented Interfaces:

IJobListener

public class BroadcastJobListener
extends Object
implements IJobListener

Holds a List of references to JobListener 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.IJobListener), removeListener(com.helger.quartz.IJobListener)

Constructor Summary

Constructors

Constructor and Description
BroadcastJobListener(String name) Construct an instance with the given name.
BroadcastJobListener(String name, List<IJobListener> listeners) Construct an instance with the given name, and List of listeners.

Method Summary

Modifier and Type	Method and Description
void	addListener(IJobListener listener)
com.helger.commons.collection.impl.ICommonsList<IJobListener>	getListeners()
String	getName() Get the name of the JobListener.
void	jobExecutionVetoed(IJobExecutionContext context) Called by the IScheduler when a IJobDetail was about to be executed (an associated ITrigger has occurred), but a ITriggerListener vetoed it's execution.
void	jobToBeExecuted(IJobExecutionContext context) Called by the IScheduler when a IJobDetail is about to be executed (an associated ITrigger has occurred).
void	jobWasExecuted(IJobExecutionContext context, JobExecutionException jobException) Called by the IScheduler after a IJobDetail has been executed, and be for the associated Trigger's triggered(xx) method has been called.
boolean	removeListener(IJobListener listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

BroadcastJobListener

public BroadcastJobListener(@Nonnull
                            String name)

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

Parameters:

name - the name of this instance

BroadcastJobListener

public BroadcastJobListener(@Nonnull
                            String name,
                            List<IJobListener> listeners)

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

Parameters:

name - the name of this instance

listeners - the initial List of JobListeners to broadcast to.

Method Detail

getName

@Nonnull
public String getName()

Description copied from interface: IJobListener

Get the name of the JobListener.

Specified by:

getName in interface IJobListener

addListener

public void addListener(IJobListener listener)

removeListener

public boolean removeListener(IJobListener listener)

getListeners

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

jobToBeExecuted

public void jobToBeExecuted(IJobExecutionContext context)

Description copied from interface: IJobListener

Called by the IScheduler when a IJobDetail is about to be executed (an associated ITrigger has occurred).

This method will not be invoked if the execution of the Job was vetoed by a ITriggerListener.

Specified by:

jobToBeExecuted in interface IJobListener

See Also:

IJobListener.jobExecutionVetoed(IJobExecutionContext)

jobExecutionVetoed

public void jobExecutionVetoed(IJobExecutionContext context)

Description copied from interface: IJobListener

Called by the IScheduler when a IJobDetail was about to be executed (an associated ITrigger has occurred), but a ITriggerListener vetoed it's execution.

Specified by:

jobExecutionVetoed in interface IJobListener

See Also:

IJobListener.jobToBeExecuted(IJobExecutionContext)

jobWasExecuted

public void jobWasExecuted(IJobExecutionContext context,
                           JobExecutionException jobException)

Description copied from interface: IJobListener

Called by the IScheduler after a IJobDetail has been executed, and be for the associated Trigger's triggered(xx) method has been called.

Specified by:

jobWasExecuted in interface IJobListener