org.quartz.JobListener Maven / Gradle / Ivy


/* 
 * Copyright 2001-2009 Terracotta, Inc. 
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 
 * use this file except in compliance with the License. You may obtain a copy 
 * of the License at 
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0 
 *   
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 
 * License for the specific language governing permissions and limitations 
 * under the License.
 * 
 */

package org.quartz;

/**
 * The interface to be implemented by classes that want to be informed when a
 * {@link org.quartz.JobDetail} executes. In general,
 * applications that use a Scheduler will not have use for this
 * mechanism.
 * 
 * @see ListenerManager#addJobListener(JobListener, Matcher)
 * @see Matcher
 * @see Job
 * @see JobExecutionContext
 * @see JobExecutionException
 * @see TriggerListener
 * 
 * @author James House
 */
public interface JobListener {

    /*
     * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     * 
     * Interface.
     * 
     * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     */

    /**
     * 
     * Get the name of the JobListener.
     * 
     */
    String getName();

    /**
     * 
     * Called by the {@link Scheduler} when a {@link org.quartz.JobDetail}
     * is about to be executed (an associated {@link Trigger}
     * has occurred).
     * 
     * 
     * 
     * This method will not be invoked if the execution of the Job was vetoed
     * by a {@link TriggerListener}.
     * 
     * 
     * @see #jobExecutionVetoed(JobExecutionContext)
     */
    void jobToBeExecuted(JobExecutionContext context);

    /**
     * 
     * Called by the {@link Scheduler} when a {@link org.quartz.JobDetail}
     * was about to be executed (an associated {@link Trigger}
     * has occurred), but a {@link TriggerListener} vetoed it's 
     * execution.
     * 
     * 
     * @see #jobToBeExecuted(JobExecutionContext)
     */
    void jobExecutionVetoed(JobExecutionContext context);

    
    /**
     * 
     * Called by the {@link Scheduler} after a {@link org.quartz.JobDetail}
     * has been executed, and be for the associated Trigger's
     * triggered(xx) method has been called.
     * 
     */
    void jobWasExecuted(JobExecutionContext context,
            JobExecutionException jobException);

}