BroadcastSchedulerListener (ph-mini-quartz 4.2.0 API)

java.lang.Object
- com.helger.quartz.listeners.BroadcastSchedulerListener

All Implemented Interfaces:

ISchedulerListener
```
public class BroadcastSchedulerListener
extends Object
implements ISchedulerListener
```
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(com.helger.quartz.ISchedulerListener), removeListener(com.helger.quartz.ISchedulerListener)

Constructor Summary

Constructors
Constructor and Description
`BroadcastSchedulerListener()`
`BroadcastSchedulerListener(Iterable<? extends ISchedulerListener> listeners)` Construct an instance with the given List of listeners.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(ISchedulerListener listener)`
`com.helger.commons.collection.impl.ICommonsList<ISchedulerListener>`	`getListeners()`
`void`	`jobAdded(IJobDetail jobDetail)` Called by the `IScheduler` when a `IJobDetail` has been added.
`void`	`jobDeleted(JobKey jobKey)` Called by the `IScheduler` when a `IJobDetail` has been deleted.
`void`	`jobPaused(JobKey key)` Called by the `IScheduler` when a `IJobDetail` has been paused.
`void`	`jobResumed(JobKey key)` Called by the `IScheduler` when a `IJobDetail` has been un-paused.
`void`	`jobScheduled(ITrigger trigger)` Called by the `IScheduler` when a `IJobDetail` is scheduled.
`void`	`jobsPaused(String jobGroup)` Called by the `IScheduler` when a group of `IJobDetails` has been paused.
`void`	`jobsResumed(String jobGroup)` Called by the `IScheduler` when a group of `IJobDetails` has been un-paused.
`void`	`jobUnscheduled(TriggerKey triggerKey)` Called by the `IScheduler` when a `IJobDetail` is unscheduled.
`boolean`	`removeListener(ISchedulerListener listener)`
`void`	`schedulerError(String msg, SchedulerException cause)` Called by the `IScheduler` 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 `IScheduler` to inform the listener that it has move to standby mode.
`void`	`schedulerShutdown()` Called by the `IScheduler` to inform the listener that it has shutdown.
`void`	`schedulerShuttingdown()` Called by the `IScheduler` to inform the listener that it has begun the shutdown sequence.
`void`	`schedulerStarted()` Called by the `IScheduler` to inform the listener that it has started.
`void`	`schedulerStarting()` Called by the `IScheduler` to inform the listener that it is starting.
`void`	`schedulingDataCleared()` Called by the `IScheduler` to inform the listener that all jobs, triggers and calendars were deleted.
`void`	`triggerFinalized(ITrigger trigger)` Called by the `IScheduler` when a `ITrigger` has reached the condition in which it will never fire again.
`void`	`triggerPaused(TriggerKey key)` Called by the `IScheduler` when a `ITrigger` has been paused.
`void`	`triggerResumed(TriggerKey key)` Called by the `IScheduler` when a `ITrigger` has been un-paused.
`void`	`triggersPaused(String triggerGroup)` Called by the `IScheduler` when a group of `ITriggers` has been paused.
`void`	`triggersResumed(String triggerGroup)` Called by the `IScheduler` when a group of `ITriggers` 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(Iterable<? extends ISchedulerListener> 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(@Nonnull
                        ISchedulerListener listener)
```
  - removeListener
```
public boolean removeListener(ISchedulerListener listener)
```
  - getListeners
```
@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<ISchedulerListener> getListeners()
```
  - jobAdded
```
public void jobAdded(IJobDetail jobDetail)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a IJobDetail has been added.
    
    Specified by:
    
    jobAdded in interface ISchedulerListener
  - jobDeleted
```
public void jobDeleted(JobKey jobKey)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a IJobDetail has been deleted.
    
    Specified by:
    
    jobDeleted in interface ISchedulerListener
  - jobScheduled
```
public void jobScheduled(ITrigger trigger)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a IJobDetail is scheduled.
    
    Specified by:
    
    jobScheduled in interface ISchedulerListener
  - jobUnscheduled
```
public void jobUnscheduled(TriggerKey triggerKey)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a IJobDetail is unscheduled.
    
    Specified by:
    
    jobUnscheduled in interface ISchedulerListener
    
    See Also:
    
    ISchedulerListener.schedulingDataCleared()
  - triggerFinalized
```
public void triggerFinalized(ITrigger trigger)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a ITrigger has reached the condition in which it will never fire again.
    
    Specified by:
    
    triggerFinalized in interface ISchedulerListener
  - triggerPaused
```
public void triggerPaused(TriggerKey key)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a ITrigger has been paused.
    
    Specified by:
    
    triggerPaused in interface ISchedulerListener
  - triggersPaused
```
public void triggersPaused(String triggerGroup)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a group of ITriggers has been paused. If all groups were paused then triggerGroup will be null.
    
    Specified by:
    
    triggersPaused in interface ISchedulerListener
    
    Parameters:
    
    triggerGroup - the paused group, or null if all were paused
  - triggerResumed
```
public void triggerResumed(TriggerKey key)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a ITrigger has been un-paused.
    
    Specified by:
    
    triggerResumed in interface ISchedulerListener
  - triggersResumed
```
public void triggersResumed(String triggerGroup)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a group of ITriggers has been un-paused.
    
    Specified by:
    
    triggersResumed in interface ISchedulerListener
  - schedulingDataCleared
```
public void schedulingDataCleared()
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler to inform the listener that all jobs, triggers and calendars were deleted.
    
    Specified by:
    
    schedulingDataCleared in interface ISchedulerListener
  - jobPaused
```
public void jobPaused(JobKey key)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a IJobDetail has been paused.
    
    Specified by:
    
    jobPaused in interface ISchedulerListener
  - jobsPaused
```
public void jobsPaused(String jobGroup)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a group of IJobDetails has been paused.
    
    Specified by:
    
    jobsPaused in interface ISchedulerListener
    
    Parameters:
    
    jobGroup - the paused group, or null if all were paused
  - jobResumed
```
public void jobResumed(JobKey key)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a IJobDetail has been un-paused.
    
    Specified by:
    
    jobResumed in interface ISchedulerListener
  - jobsResumed
```
public void jobsResumed(String jobGroup)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler when a group of IJobDetails has been un-paused.
    
    Specified by:
    
    jobsResumed in interface ISchedulerListener
  - schedulerError
```
public void schedulerError(String msg,
                           SchedulerException cause)
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler 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 ISchedulerListener
  - schedulerStarted
```
public void schedulerStarted()
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler to inform the listener that it has started.
    
    Specified by:
    
    schedulerStarted in interface ISchedulerListener
  - schedulerStarting
```
public void schedulerStarting()
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler to inform the listener that it is starting.
    
    Specified by:
    
    schedulerStarting in interface ISchedulerListener
  - schedulerInStandbyMode
```
public void schedulerInStandbyMode()
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler to inform the listener that it has move to standby mode.
    
    Specified by:
    
    schedulerInStandbyMode in interface ISchedulerListener
  - schedulerShutdown
```
public void schedulerShutdown()
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler to inform the listener that it has shutdown.
    
    Specified by:
    
    schedulerShutdown in interface ISchedulerListener
  - schedulerShuttingdown
```
public void schedulerShuttingdown()
```
    Description copied from interface: ISchedulerListener
    
    Called by the IScheduler to inform the listener that it has begun the shutdown sequence.
    
    Specified by:
    
    schedulerShuttingdown in interface ISchedulerListener

Class BroadcastSchedulerListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BroadcastSchedulerListener

BroadcastSchedulerListener

Method Detail

addListener

removeListener

getListeners

jobAdded

jobDeleted

jobScheduled

jobUnscheduled

triggerFinalized

triggerPaused

triggersPaused

triggerResumed

triggersResumed

schedulingDataCleared

jobPaused

jobsPaused

jobResumed

jobsResumed

schedulerError

schedulerStarted

schedulerStarting

schedulerInStandbyMode

schedulerShutdown

schedulerShuttingdown