IListenerManager (ph-mini-quartz 4.2.0 API)

All Known Implementing Classes:

ListenerManager
```
public interface IListenerManager
```
Client programs may be interested in the 'listener' interfaces that are available from Quartz. The IJobListener interface provides notifications of Job executions. The ITriggerListener interface provides notifications of Trigger firings. The ISchedulerListener interface provides notifications of Scheduler events and errors. Listeners can be associated with local schedulers through the IListenerManager interface.
Listener registration order is preserved, and hence notification of listeners will be in the order in which they were registered.

Since:

2.0 - previously listeners were managed directly on the Scheduler interface.

Author:

jhouse

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addJobListener(IJobListener jobListener)` Add the given `IJobListener` to the `Scheduler`, and register it to receive events for all Jobs.
`void`	`addJobListener(IJobListener jobListener, IMatcher<JobKey>... matchers)` Add the given `IJobListener` to the `Scheduler`, and register it to receive events for Jobs that are matched by ANY of the given Matchers.
`void`	`addJobListener(IJobListener jobListener, IMatcher<JobKey> matcher)` Add the given `IJobListener` to the `Scheduler`, and register it to receive events for Jobs that are matched by the given Matcher.
`void`	`addJobListener(IJobListener jobListener, List<IMatcher<JobKey>> matchers)` Add the given `IJobListener` to the `Scheduler`, and register it to receive events for Jobs that are matched by ANY of the given Matchers.
`boolean`	`addJobListenerMatcher(String listenerName, IMatcher<JobKey> matcher)` Add the given Matcher to the set of matchers for which the listener will receive events if ANY of the matchers match.
`void`	`addSchedulerListener(ISchedulerListener schedulerListener)` Register the given `ISchedulerListener` with the `Scheduler`.
`void`	`addTriggerListener(ITriggerListener triggerListener)` Add the given `ITriggerListener` to the `Scheduler`, and register it to receive events for all Triggers.
`void`	`addTriggerListener(ITriggerListener triggerListener, IMatcher<TriggerKey>... matchers)` Add the given `ITriggerListener` to the `Scheduler`, and register it to receive events for Triggers that are matched by ANY of the given Matchers.
`void`	`addTriggerListener(ITriggerListener triggerListener, IMatcher<TriggerKey> matcher)` Add the given `ITriggerListener` to the `Scheduler`, and register it to receive events for Triggers that are matched by the given Matcher.
`void`	`addTriggerListener(ITriggerListener triggerListener, List<IMatcher<TriggerKey>> matchers)` Add the given `ITriggerListener` to the `Scheduler`, and register it to receive events for Triggers that are matched by ANY of the given Matchers.
`boolean`	`addTriggerListenerMatcher(String listenerName, IMatcher<TriggerKey> matcher)` Add the given Matcher to the set of matchers for which the listener will receive events if ANY of the matchers match.
`IJobListener`	`getJobListener(String name)` Get the `IJobListener` that has the given name.
`com.helger.commons.collection.impl.ICommonsList<IMatcher<JobKey>>`	`getJobListenerMatchers(String listenerName)` Get the set of Matchers for which the listener will receive events if ANY of the matchers match.
`com.helger.commons.collection.impl.ICommonsList<IJobListener>`	`getJobListeners()` Get a List containing all of the `IJobListener`s in the `Scheduler`, in the order in which they were registered.
`com.helger.commons.collection.impl.ICommonsList<ISchedulerListener>`	`getSchedulerListeners()` Get a List containing all of the `ISchedulerListener`s registered with the `Scheduler`, in the order in which they were registered.
`ITriggerListener`	`getTriggerListener(String name)` Get the `ITriggerListener` that has the given name.
`com.helger.commons.collection.impl.ICommonsList<IMatcher<TriggerKey>>`	`getTriggerListenerMatchers(String listenerName)` Get the set of Matchers for which the listener will receive events if ANY of the matchers match.
`com.helger.commons.collection.impl.ICommonsList<ITriggerListener>`	`getTriggerListeners()` Get a List containing all of the `ITriggerListener`s in the `Scheduler`, in the order in which they were registered.
`boolean`	`removeJobListener(String name)` Remove the identified `IJobListener` from the `Scheduler`.
`boolean`	`removeJobListenerMatcher(String listenerName, IMatcher<JobKey> matcher)` Remove the given Matcher to the set of matchers for which the listener will receive events if ANY of the matchers match.
`boolean`	`removeSchedulerListener(ISchedulerListener schedulerListener)` Remove the given `ISchedulerListener` from the `Scheduler`.
`boolean`	`removeTriggerListener(String name)` Remove the identified `ITriggerListener` from the `Scheduler`.
`boolean`	`removeTriggerListenerMatcher(String listenerName, IMatcher<TriggerKey> matcher)` Remove the given Matcher to the set of matchers for which the listener will receive events if ANY of the matchers match.
`boolean`	`setJobListenerMatchers(String listenerName, List<IMatcher<JobKey>> matchers)` Set the set of Matchers for which the listener will receive events if ANY of the matchers match.
`boolean`	`setTriggerListenerMatchers(String listenerName, List<IMatcher<TriggerKey>> matchers)` Set the set of Matchers for which the listener will receive events if ANY of the matchers match.

- Method Detail
  - addJobListener
```
void addJobListener(IJobListener jobListener)
```
    Add the given IJobListener to the Scheduler, and register it to receive events for all Jobs. Because no matchers are provided, the EverythingMatcher will be used.
    
    See Also:
    
    IMatcher, EverythingMatcher
  - addJobListener
```
void addJobListener(IJobListener jobListener,
                    IMatcher<JobKey> matcher)
```
    Add the given IJobListener to the Scheduler, and register it to receive events for Jobs that are matched by the given Matcher. If no matchers are provided, the EverythingMatcher will be used.
    
    See Also:
    
    IMatcher, EverythingMatcher
  - addJobListener
```
void addJobListener(IJobListener jobListener,
                    IMatcher<JobKey>... matchers)
```
    Add the given IJobListener to the Scheduler, and register it to receive events for Jobs that are matched by ANY of the given Matchers. If no matchers are provided, the EverythingMatcher will be used.
    
    See Also:
    
    IMatcher, EverythingMatcher
  - addJobListener
```
void addJobListener(IJobListener jobListener,
                    List<IMatcher<JobKey>> matchers)
```
    Add the given IJobListener to the Scheduler, and register it to receive events for Jobs that are matched by ANY of the given Matchers. If no matchers are provided, the EverythingMatcher will be used.
    
    See Also:
    
    IMatcher, EverythingMatcher
  - addJobListenerMatcher
```
boolean addJobListenerMatcher(String listenerName,
                              IMatcher<JobKey> matcher)
```
    Add the given Matcher to the set of matchers for which the listener will receive events if ANY of the matchers match.
    
    Parameters:
    
    listenerName - the name of the listener to add the matcher to
    
    matcher - the additional matcher to apply for selecting events
    
    Returns:
    
    true if the identified listener was found and updated
  - removeJobListenerMatcher
```
boolean removeJobListenerMatcher(String listenerName,
                                 IMatcher<JobKey> matcher)
```
    Remove the given Matcher to the set of matchers for which the listener will receive events if ANY of the matchers match.
    
    Parameters:
    
    listenerName - the name of the listener to add the matcher to
    
    matcher - the additional matcher to apply for selecting events
    
    Returns:
    
    true if the given matcher was found and removed from the listener's list of matchers
  - setJobListenerMatchers
```
boolean setJobListenerMatchers(String listenerName,
                               List<IMatcher<JobKey>> matchers)
```
    Set the set of Matchers for which the listener will receive events if ANY of the matchers match.
    Removes any existing matchers for the identified listener!
    
    Parameters:
    
    listenerName - the name of the listener to add the matcher to
    
    matchers - the matchers to apply for selecting events
    
    Returns:
    
    true if the given matcher was found and removed from the listener's list of matchers
  - getJobListenerMatchers
```
com.helger.commons.collection.impl.ICommonsList<IMatcher<JobKey>> getJobListenerMatchers(String listenerName)
```
    Get the set of Matchers for which the listener will receive events if ANY of the matchers match.
    
    Parameters:
    
    listenerName - the name of the listener to add the matcher to
    
    Returns:
    
    the matchers registered for selecting events for the identified listener
  - removeJobListener
```
boolean removeJobListener(String name)
```
    Remove the identified IJobListener from the Scheduler.
    
    Returns:
    
    true if the identified listener was found in the list, and removed.
  - getJobListeners
```
com.helger.commons.collection.impl.ICommonsList<IJobListener> getJobListeners()
```
    Get a List containing all of the IJobListeners in the Scheduler, in the order in which they were registered.
  - getJobListener
```
IJobListener getJobListener(String name)
```
    Get the IJobListener that has the given name.
  - addTriggerListener
```
void addTriggerListener(ITriggerListener triggerListener)
```
    Add the given ITriggerListener to the Scheduler, and register it to receive events for all Triggers. Because no matcher is provided, the EverythingMatcher will be used.
    
    See Also:
    
    IMatcher, EverythingMatcher
  - addTriggerListener
```
void addTriggerListener(ITriggerListener triggerListener,
                        IMatcher<TriggerKey> matcher)
```
    Add the given ITriggerListener to the Scheduler, and register it to receive events for Triggers that are matched by the given Matcher. If no matcher is provided, the EverythingMatcher will be used.
    
    See Also:
    
    IMatcher, EverythingMatcher
  - addTriggerListener
```
void addTriggerListener(ITriggerListener triggerListener,
                        IMatcher<TriggerKey>... matchers)
```
    Add the given ITriggerListener to the Scheduler, and register it to receive events for Triggers that are matched by ANY of the given Matchers. If no matcher is provided, the EverythingMatcher will be used.
    
    See Also:
    
    IMatcher, EverythingMatcher
  - addTriggerListener
```
void addTriggerListener(ITriggerListener triggerListener,
                        List<IMatcher<TriggerKey>> matchers)
```
    Add the given ITriggerListener to the Scheduler, and register it to receive events for Triggers that are matched by ANY of the given Matchers. If no matcher is provided, the EverythingMatcher will be used.
    
    See Also:
    
    IMatcher, EverythingMatcher
  - addTriggerListenerMatcher
```
boolean addTriggerListenerMatcher(String listenerName,
                                  IMatcher<TriggerKey> matcher)
```
    Add the given Matcher to the set of matchers for which the listener will receive events if ANY of the matchers match.
    
    Parameters:
    
    listenerName - the name of the listener to add the matcher to
    
    matcher - the additional matcher to apply for selecting events
    
    Returns:
    
    true if the identified listener was found and updated
  - removeTriggerListenerMatcher
```
boolean removeTriggerListenerMatcher(String listenerName,
                                     IMatcher<TriggerKey> matcher)
```
    Remove the given Matcher to the set of matchers for which the listener will receive events if ANY of the matchers match.
    
    Parameters:
    
    listenerName - the name of the listener to add the matcher to
    
    matcher - the additional matcher to apply for selecting events
    
    Returns:
    
    true if the given matcher was found and removed from the listener's list of matchers
  - setTriggerListenerMatchers
```
boolean setTriggerListenerMatchers(String listenerName,
                                   List<IMatcher<TriggerKey>> matchers)
```
    Set the set of Matchers for which the listener will receive events if ANY of the matchers match.
    Removes any existing matchers for the identified listener!
    
    Parameters:
    
    listenerName - the name of the listener to add the matcher to
    
    matchers - the matchers to apply for selecting events
    
    Returns:
    
    true if the given matcher was found and removed from the listener's list of matchers
  - getTriggerListenerMatchers
```
com.helger.commons.collection.impl.ICommonsList<IMatcher<TriggerKey>> getTriggerListenerMatchers(String listenerName)
```
    Get the set of Matchers for which the listener will receive events if ANY of the matchers match.
    
    Parameters:
    
    listenerName - the name of the listener to add the matcher to
    
    Returns:
    
    the matchers registered for selecting events for the identified listener
  - removeTriggerListener
```
boolean removeTriggerListener(String name)
```
    Remove the identified ITriggerListener from the Scheduler.
    
    Returns:
    
    true if the identified listener was found in the list, and removed.
  - getTriggerListeners
```
com.helger.commons.collection.impl.ICommonsList<ITriggerListener> getTriggerListeners()
```
    Get a List containing all of the ITriggerListeners in the Scheduler, in the order in which they were registered.
  - getTriggerListener
```
ITriggerListener getTriggerListener(String name)
```
    Get the ITriggerListener that has the given name.
  - addSchedulerListener
```
void addSchedulerListener(ISchedulerListener schedulerListener)
```
    Register the given ISchedulerListener with the Scheduler.
  - removeSchedulerListener
```
boolean removeSchedulerListener(ISchedulerListener schedulerListener)
```
    Remove the given ISchedulerListener from the Scheduler.
    
    Returns:
    
    true if the identified listener was found in the list, and removed.
  - getSchedulerListeners
```
com.helger.commons.collection.impl.ICommonsList<ISchedulerListener> getSchedulerListeners()
```
    Get a List containing all of the ISchedulerListeners registered with the Scheduler, in the order in which they were registered.

Interface IListenerManager

Method Summary

Method Detail

addJobListener

addJobListener

addJobListener

addJobListener

addJobListenerMatcher

removeJobListenerMatcher

setJobListenerMatchers

getJobListenerMatchers

removeJobListener

getJobListeners

getJobListener

addTriggerListener

addTriggerListener

addTriggerListener

addTriggerListener

addTriggerListenerMatcher

removeTriggerListenerMatcher

setTriggerListenerMatchers

getTriggerListenerMatchers

removeTriggerListener

getTriggerListeners

getTriggerListener

addSchedulerListener

removeSchedulerListener

getSchedulerListeners