Package org.quartz.listeners

Class BroadcastSchedulerListener

java.lang.Object

org.quartz.listeners.BroadcastSchedulerListener

All Implemented Interfaces:

SchedulerListener

public class BroadcastSchedulerListener
extends java.lang.Object
implements SchedulerListener

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

This 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(org.quartz.SchedulerListener), removeListener(org.quartz.SchedulerListener)

Constructor Summary

Constructors

Constructor	Description
BroadcastSchedulerListener()
BroadcastSchedulerListener(java.util.List<SchedulerListener> listeners)	Construct an instance with the given List of listeners.

Method Summary

Modifier and Type	Method	Description
void	addListener(SchedulerListener listener)
java.util.List<SchedulerListener>	getListeners()
void	jobAdded(JobDetail jobDetail)	Called by the Scheduler when a JobDetail has been added.
void	jobDeleted(JobKey jobKey)	Called by the Scheduler when a JobDetail has been deleted.
void	jobPaused(JobKey key)	Called by the Scheduler when a JobDetail has been paused.
void	jobResumed(JobKey key)	Called by the Scheduler when a JobDetail has been un-paused.
void	jobScheduled(Trigger trigger)	Called by the Scheduler when a JobDetail is scheduled.
void	jobsPaused(java.lang.String jobGroup)	Called by the Scheduler when a group of JobDetails has been paused.
void	jobsResumed(java.lang.String jobGroup)	Called by the Scheduler when a group of JobDetails has been un-paused.
void	jobUnscheduled(TriggerKey triggerKey)	Called by the Scheduler when a JobDetail is unscheduled.
boolean	removeListener(SchedulerListener listener)
void	schedulerError(java.lang.String msg, SchedulerException cause)	Called by the Scheduler when a serious error has occurred within the scheduler - such as repeated failures in the JobStore, or the inability to instantiate a Job instance when its Trigger has fired.
void	schedulerInStandbyMode()	Called by the Scheduler to inform the listener that it has move to standby mode.
void	schedulerShutdown()	Called by the Scheduler to inform the listener that it has shutdown.
void	schedulerShuttingdown()	Called by the Scheduler to inform the listener that it has begun the shutdown sequence.
void	schedulerStarted()	Called by the Scheduler to inform the listener that it has started.
void	schedulerStarting()	Called by the Scheduler to inform the listener that it is starting.
void	schedulingDataCleared()	Called by the Scheduler to inform the listener that all jobs, triggers and calendars were deleted.
void	triggerFinalized(Trigger trigger)	Called by the Scheduler when a Trigger has reached the condition in which it will never fire again.
void	triggerPaused(TriggerKey key)	Called by the Scheduler when a Trigger has been paused.
void	triggerResumed(TriggerKey key)	Called by the Scheduler when a Trigger has been un-paused.
void	triggersPaused(java.lang.String triggerGroup)	Called by the Scheduler when a group of Triggers has been paused.
void	triggersResumed(java.lang.String triggerGroup)	Called by the Scheduler when a group of Triggers has been un-paused.

Methods inherited from class java.lang.Object

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

Constructor Detail

BroadcastSchedulerListener

public BroadcastSchedulerListener()

BroadcastSchedulerListener

public BroadcastSchedulerListener(java.util.List<SchedulerListener> listeners)

Construct an instance with the given List of listeners.

Parameters:

listeners - the initial List of SchedulerListeners to broadcast to.

Method Detail

addListener

public void addListener(SchedulerListener listener)

removeListener

public boolean removeListener(SchedulerListener listener)

getListeners

public java.util.List<SchedulerListener> getListeners()

jobAdded

public void jobAdded(JobDetail jobDetail)

Description copied from interface: SchedulerListener

Called by the Scheduler when a JobDetail has been added.

Specified by:

jobAdded in interface SchedulerListener

jobDeleted

public void jobDeleted(JobKey jobKey)

Description copied from interface: SchedulerListener

Called by the Scheduler when a JobDetail has been deleted.

Specified by:

jobDeleted in interface SchedulerListener

jobScheduled

public void jobScheduled(Trigger trigger)

Description copied from interface: SchedulerListener

Called by the Scheduler when a JobDetail is scheduled.

Specified by:

jobScheduled in interface SchedulerListener

jobUnscheduled

public void jobUnscheduled(TriggerKey triggerKey)

Description copied from interface: SchedulerListener

Called by the Scheduler when a JobDetail is unscheduled.

Specified by:

jobUnscheduled in interface SchedulerListener

See Also:

SchedulerListener.schedulingDataCleared()

triggerFinalized

public void triggerFinalized(Trigger trigger)

Description copied from interface: SchedulerListener

Called by the Scheduler when a Trigger has reached the condition in which it will never fire again.

Specified by:

triggerFinalized in interface SchedulerListener

triggerPaused

public void triggerPaused(TriggerKey key)

Description copied from interface: SchedulerListener

Called by the Scheduler when a Trigger has been paused.

Specified by:

triggerPaused in interface SchedulerListener

triggersPaused

public void triggersPaused(java.lang.String triggerGroup)

Description copied from interface: SchedulerListener

Called by the Scheduler when a group of Triggers has been paused.

If all groups were paused then triggerGroup will be null

Specified by:

triggersPaused in interface SchedulerListener

Parameters:

triggerGroup - the paused group, or null if all were paused

triggerResumed

public void triggerResumed(TriggerKey key)

Description copied from interface: SchedulerListener

Called by the Scheduler when a Trigger has been un-paused.

Specified by:

triggerResumed in interface SchedulerListener

triggersResumed

public void triggersResumed(java.lang.String triggerGroup)

Description copied from interface: SchedulerListener

Called by the Scheduler when a group of Triggers has been un-paused.

Specified by:

triggersResumed in interface SchedulerListener

schedulingDataCleared

public void schedulingDataCleared()

Description copied from interface: SchedulerListener

Called by the Scheduler to inform the listener that all jobs, triggers and calendars were deleted.

Specified by:

schedulingDataCleared in interface SchedulerListener

jobPaused

public void jobPaused(JobKey key)

Description copied from interface: SchedulerListener

Called by the Scheduler when a JobDetail has been paused.

Specified by:

jobPaused in interface SchedulerListener

jobsPaused

public void jobsPaused(java.lang.String jobGroup)

Description copied from interface: SchedulerListener

Called by the Scheduler when a group of JobDetails has been paused.

Specified by:

jobsPaused in interface SchedulerListener

Parameters:

jobGroup - the paused group, or null if all were paused

jobResumed

public void jobResumed(JobKey key)

Description copied from interface: SchedulerListener

Called by the Scheduler when a JobDetail has been un-paused.

Specified by:

jobResumed in interface SchedulerListener

jobsResumed

public void jobsResumed(java.lang.String jobGroup)

Description copied from interface: SchedulerListener

Called by the Scheduler when a group of JobDetails has been un-paused.

Specified by:

jobsResumed in interface SchedulerListener

schedulerError

public void schedulerError(java.lang.String msg,
                           SchedulerException cause)

Description copied from interface: SchedulerListener

Called by the Scheduler when a serious error has occurred within the scheduler - such as repeated failures in the JobStore, or the inability to instantiate a Job instance when its Trigger has fired.

The getErrorCode() method of the given SchedulerException can be used to determine more specific information about the type of error that was encountered.

Specified by:

schedulerError in interface SchedulerListener

schedulerStarted

public void schedulerStarted()

Description copied from interface: SchedulerListener

Called by the Scheduler to inform the listener that it has started.

Specified by:

schedulerStarted in interface SchedulerListener

schedulerStarting

public void schedulerStarting()

Description copied from interface: SchedulerListener

Called by the Scheduler to inform the listener that it is starting.

Specified by:

schedulerStarting in interface SchedulerListener

schedulerInStandbyMode

public void schedulerInStandbyMode()

Description copied from interface: SchedulerListener

Called by the Scheduler to inform the listener that it has move to standby mode.

Specified by:

schedulerInStandbyMode in interface SchedulerListener

schedulerShutdown

public void schedulerShutdown()

Description copied from interface: SchedulerListener

Called by the Scheduler to inform the listener that it has shutdown.

Specified by:

schedulerShutdown in interface SchedulerListener

schedulerShuttingdown

public void schedulerShuttingdown()

Description copied from interface: SchedulerListener

Called by the Scheduler to inform the listener that it has begun the shutdown sequence.

Specified by:

schedulerShuttingdown in interface SchedulerListener