Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.quartz.listeners
Class TriggerListenerSupport

    java.lang.Object
      org.quartz.listeners.TriggerListenerSupport

All Implemented Interfaces:
  TriggerListener

    public abstract class TriggerListenerSupport

extends Object
implements TriggerListener

A helpful abstract base class for implementors of ``TriggerListener``.

The methods in this class are empty so you only need to override the subset for the ``TriggerListener`` events you care about.

You are required to implement ``TriggerListener.getName()`` to return the unique name of your `TriggerListener`.

See Also:
  `TriggerListener`

Constructor Summary
`TriggerListenerSupport()`

Method Summary
`protected org.slf4j.Logger` | `getLog()` Get the ``Logger`` for this class's category.
`void` | `triggerComplete(Trigger trigger, JobExecutionContext context, Trigger.CompletedExecutionInstruction triggerInstructionCode)` Called by the ``Scheduler`` when a ``Trigger`` has fired, it's associated ``JobDetail`` has been executed, and it's `triggered(xx)` method has been called.
`void` | `triggerFired(Trigger trigger, JobExecutionContext context)` Called by the ``Scheduler`` when a ``Trigger`` has fired, and it's associated ``JobDetail`` is about to be executed.
`void` | `triggerMisfired(Trigger trigger)` Called by the ``Scheduler`` when a ``Trigger`` has misfired.
`boolean` | `vetoJobExecution(Trigger trigger, JobExecutionContext context)` Called by the ``Scheduler`` when a ``Trigger`` has fired, and it's associated ``JobDetail`` is about to be executed.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.quartz.TriggerListener
`getName`

Constructor Detail

### TriggerListenerSupport

    public TriggerListenerSupport()

Method Detail

### getLog

    protected org.slf4j.Logger getLog()

  Get the ``Logger`` for this class's category. This should be used by subclasses for logging.

### triggerFired

    public void triggerFired(Trigger trigger,
                             JobExecutionContext context)

  Description copied from interface: `TriggerListener`

  Called by the ``Scheduler`` when a ``Trigger`` has fired, and it's associated ``JobDetail`` is about to be executed.

  It is called before the `vetoJobExecution(..)` method of this interface.

  Specified by:
    `triggerFired` in interface `TriggerListener`
  Parameters:
    `trigger` - The `Trigger` that has fired.
    `context` - The `JobExecutionContext` that will be passed to the `Job`'s`execute(xx)` method.

### vetoJobExecution

    public boolean vetoJobExecution(Trigger trigger,
                                    JobExecutionContext context)

  Description copied from interface: `TriggerListener`

  Called by the ``Scheduler`` when a ``Trigger`` has fired, and it's associated ``JobDetail`` is about to be executed. If the implementation vetos the execution (via returning `true`), the job's execute method will not be called.

  It is called after the `triggerFired(..)` method of this interface.

  Specified by:
    `vetoJobExecution` in interface `TriggerListener`
  Parameters:
    `trigger` - The `Trigger` that has fired.
    `context` - The `JobExecutionContext` that will be passed to the `Job`'s`execute(xx)` method.

### triggerMisfired

    public void triggerMisfired(Trigger trigger)

  Description copied from interface: `TriggerListener`

  Called by the ``Scheduler`` when a ``Trigger`` has misfired.

  Consideration should be given to how much time is spent in this method, as it will affect all triggers that are misfiring. If you have lots of triggers misfiring at once, it could be an issue it this method does a lot.

  Specified by:
    `triggerMisfired` in interface `TriggerListener`
  Parameters:
    `trigger` - The `Trigger` that has misfired.

### triggerComplete

    public void triggerComplete(Trigger trigger,
                                JobExecutionContext context,
                                Trigger.CompletedExecutionInstruction triggerInstructionCode)

  Description copied from interface: `TriggerListener`

  Called by the ``Scheduler`` when a ``Trigger`` has fired, it's associated ``JobDetail`` has been executed, and it's `triggered(xx)` method has been called.

  Specified by:
    `triggerComplete` in interface `TriggerListener`
  Parameters:
    `trigger` - The `Trigger` that was fired.
    `context` - The `JobExecutionContext` that was passed to the `Job`'s`execute(xx)` method.
    `triggerInstructionCode` - the result of the call on the `Trigger`'s`triggered(xx)` method.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2001-2016, Terracotta, Inc.