org.quartz.SchedulerListener Maven / Gradle / Ivy
/*
* All content copyright Terracotta, Inc., unless otherwise indicated. All rights reserved.
*
* 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 of major
* {@link Scheduler}
events.
*
* @see Scheduler
* @see JobListener
* @see TriggerListener
*
* @author James House
*/
public interface SchedulerListener {
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Interface.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/**
*
* Called by the {@link Scheduler}
when a {@link org.quartz.JobDetail}
* is scheduled.
*
*/
void jobScheduled(Trigger trigger);
/**
*
* Called by the {@link Scheduler}
when a {@link org.quartz.JobDetail}
* is unscheduled.
*
*
* @see SchedulerListener#schedulingDataCleared()
*/
void jobUnscheduled(TriggerKey triggerKey);
/**
*
* Called by the {@link Scheduler}
when a {@link Trigger}
* has reached the condition in which it will never fire again.
*
*/
void triggerFinalized(Trigger trigger);
/**
*
* Called by the {@link Scheduler}
when a {@link Trigger}
* has been paused.
*
*/
void triggerPaused(TriggerKey triggerKey);
/**
*
* Called by the {@link Scheduler}
when a
* group of {@link Trigger}s
has been paused.
*
*
* If all groups were paused then triggerGroup will be null
*
* @param triggerGroup the paused group, or null if all were paused
*/
void triggersPaused(String triggerGroup);
/**
*
* Called by the {@link Scheduler}
when a {@link Trigger}
* has been un-paused.
*
*/
void triggerResumed(TriggerKey triggerKey);
/**
*
* Called by the {@link Scheduler}
when a
* group of {@link Trigger}s
has been un-paused.
*
*/
void triggersResumed(String triggerGroup);
/**
*
* Called by the {@link Scheduler}
when a {@link org.quartz.JobDetail}
* has been added.
*
*/
void jobAdded(JobDetail jobDetail);
/**
*
* Called by the {@link Scheduler}
when a {@link org.quartz.JobDetail}
* has been deleted.
*
*/
void jobDeleted(JobKey jobKey);
/**
*
* Called by the {@link Scheduler}
when a {@link org.quartz.JobDetail}
* has been paused.
*
*/
void jobPaused(JobKey jobKey);
/**
*
* Called by the {@link Scheduler}
when a
* group of {@link org.quartz.JobDetail}s
has been paused.
*
*
* @param jobGroup the paused group, or null if all were paused
*/
void jobsPaused(String jobGroup);
/**
*
* Called by the {@link Scheduler}
when a {@link org.quartz.JobDetail}
* has been un-paused.
*
*/
void jobResumed(JobKey jobKey);
/**
*
* Called by the {@link Scheduler}
when a
* group of {@link org.quartz.JobDetail}s
has been un-paused.
*
*/
void jobsResumed(String jobGroup);
/**
*
* Called by the {@link Scheduler}
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.
*
*/
void schedulerError(String msg, SchedulerException cause);
/**
*
* Called by the {@link Scheduler}
to inform the listener
* that it has move to standby mode.
*
*/
void schedulerInStandbyMode();
/**
*
* Called by the {@link Scheduler}
to inform the listener
* that it has started.
*
*/
void schedulerStarted();
/**
*
* Called by the {@link Scheduler}
to inform the listener
* that it is starting.
*
*/
void schedulerStarting();
/**
*
* Called by the {@link Scheduler}
to inform the listener
* that it has shutdown.
*
*/
void schedulerShutdown();
/**
*
* Called by the {@link Scheduler}
to inform the listener
* that it has begun the shutdown sequence.
*
*/
void schedulerShuttingdown();
/**
* Called by the {@link Scheduler}
to inform the listener
* that all jobs, triggers and calendars were deleted.
*/
void schedulingDataCleared();
}