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 and Description
BroadcastSchedulerListener()
BroadcastSchedulerListener(java.util.List listeners) Construct an instance with the given List of listeners.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(SchedulerListener listener)
java.util.List	getListeners()
void	jobScheduled(Trigger trigger) Called by the Scheduler when a JobDetail is scheduled.
void	jobsPaused(java.lang.String jobName, java.lang.String jobGroup) Called by the Scheduler when a JobDetail or group of JobDetails has been paused.
void	jobsResumed(java.lang.String jobName, java.lang.String jobGroup) Called by the Scheduler when a JobDetail or group of JobDetails has been un-paused.
void	jobUnscheduled(java.lang.String triggerName, java.lang.String triggerGroup) 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 occured within the scheduler - such as repeated failures in the JobStore, or the inability to instantiate a Job instance when its Trigger has fired.
void	schedulerShutdown() Called by the Scheduler to inform the listener that it has shutdown.
void	triggerFinalized(Trigger trigger) Called by the Scheduler when a Trigger has reached the condition in which it will never fire again.
void	triggersPaused(java.lang.String triggerName, java.lang.String triggerGroup) Called by the Scheduler when a Trigger or group of Triggers has been paused.
void	triggersResumed(java.lang.String triggerName, java.lang.String triggerGroup) Called by the Scheduler when a Trigger or group of Triggers has been un-paused.

Methods inherited from class java.lang.Object

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

Constructor Detail

BroadcastSchedulerListener

public BroadcastSchedulerListener()

BroadcastSchedulerListener

public BroadcastSchedulerListener(java.util.List 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 getListeners()

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(java.lang.String triggerName,
                  java.lang.String triggerGroup)

Description copied from interface: SchedulerListener

Called by the Scheduler when a JobDetail is unscheduled.

Specified by:

jobUnscheduled in interface SchedulerListener

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

triggersPaused

public void triggersPaused(java.lang.String triggerName,
                  java.lang.String triggerGroup)

Description copied from interface: SchedulerListener

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

If a group was paused, then the triggerName parameter will be null.

Specified by:

triggersPaused in interface SchedulerListener

triggersResumed

public void triggersResumed(java.lang.String triggerName,
                   java.lang.String triggerGroup)

Description copied from interface: SchedulerListener

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

If a group was resumed, then the triggerName parameter will be null.

Specified by:

triggersResumed in interface SchedulerListener

jobsPaused

public void jobsPaused(java.lang.String jobName,
              java.lang.String jobGroup)

Description copied from interface: SchedulerListener

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

If a group was paused, then the jobName parameter will be null. If all jobs were paused, then both parameters will be null.

Specified by:

jobsPaused in interface SchedulerListener

jobsResumed

public void jobsResumed(java.lang.String jobName,
               java.lang.String jobGroup)

Description copied from interface: SchedulerListener

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

If a group was resumed, then the jobName parameter will be null. If all jobs were paused, then both parameters will be null.

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 occured 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

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