/*
* Copyright 2004-2005 OpenSymphony
*
* 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.
*
*/
/*
* Previously Copyright (c) 2001-2004 James House
*/
package org.quartz.impl;
import java.util.Date;
import java.util.List;
import java.util.Set;
import org.quartz.Calendar;
import org.quartz.JobDataMap;
import org.quartz.JobDetail;
import org.quartz.JobListener;
import org.quartz.Scheduler;
import org.quartz.SchedulerContext;
import org.quartz.SchedulerException;
import org.quartz.SchedulerListener;
import org.quartz.SchedulerMetaData;
import org.quartz.Trigger;
import org.quartz.TriggerListener;
import org.quartz.UnableToInterruptJobException;
import org.quartz.core.QuartzScheduler;
import org.quartz.core.SchedulingContext;
import org.quartz.spi.JobFactory;
/**
* <p>
* An implementation of the <code>Scheduler</code> interface that directly
* proxies all method calls to the equivalent call on a given <code>QuartzScheduler</code>
* instance.
* </p>
*
* @see org.quartz.Scheduler
* @see org.quartz.core.QuartzScheduler
* @see org.quartz.core.SchedulingContext
*
* @author James House
*/
public class StdScheduler implements Scheduler {
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Data members.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
private QuartzScheduler sched;
private SchedulingContext schedCtxt;
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Constructors.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/**
* <p>
* Construct a <code>StdScheduler</code> instance to proxy the given
* <code>QuartzScheduler</code> instance, and with the given <code>SchedulingContext</code>.
* </p>
*/
public StdScheduler(QuartzScheduler sched, SchedulingContext schedCtxt) {
this.sched = sched;
this.schedCtxt = schedCtxt;
}
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Interface.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/**
* <p>
* Returns the name of the <code>Scheduler</code>.
* </p>
*/
public String getSchedulerName() {
return sched.getSchedulerName();
}
/**
* <p>
* Returns the instance Id of the <code>Scheduler</code>.
* </p>
*/
public String getSchedulerInstanceId() {
return sched.getSchedulerInstanceId();
}
public SchedulerMetaData getMetaData() {
return new SchedulerMetaData(getSchedulerName(),
getSchedulerInstanceId(), getClass(), false, isStarted(),
isInStandbyMode(), isShutdown(), sched.runningSince(),
sched.numJobsExecuted(), sched.getJobStoreClass(),
sched.supportsPersistence(), sched.getThreadPoolClass(),
sched.getThreadPoolSize(), sched.getVersion());
}
/**
* <p>
* Returns the <code>SchedulerContext</code> of the <code>Scheduler</code>.
* </p>
*/
public SchedulerContext getContext() throws SchedulerException {
return sched.getSchedulerContext();
}
///////////////////////////////////////////////////////////////////////////
///
/// Schedululer State Management Methods
///
///////////////////////////////////////////////////////////////////////////
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public void start() throws SchedulerException {
sched.start();
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public void startDelayed(int seconds) throws SchedulerException {
sched.startDelayed(seconds);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*
* @deprecated
* @see #standby()
*/
public void pause() {
this.standby();
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public void standby() {
sched.standby();
}
/**
* Whether the scheduler has been started.
*
* <p>
* Note: This only reflects whether <code>{@link #start()}</code> has ever
* been called on this Scheduler, so it will return <code>true</code> even
* if the <code>Scheduler</code> is currently in standby mode or has been
* since shutdown.
* </p>
*
* @see #start()
* @see #isShutdown()
* @see #isInStandbyMode()
*/
public boolean isStarted() {
return (sched.runningSince() != null);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public boolean isInStandbyMode() {
return sched.isInStandbyMode();
}
/**
* @deprecated
*/
public boolean isPaused() {
return isInStandbyMode();
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public void shutdown() {
sched.shutdown();
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public void shutdown(boolean waitForJobsToComplete) {
sched.shutdown(waitForJobsToComplete);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public boolean isShutdown() {
return sched.isShutdown();
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public List getCurrentlyExecutingJobs() {
return sched.getCurrentlyExecutingJobs();
}
///////////////////////////////////////////////////////////////////////////
///
/// Scheduling-related Methods
///
///////////////////////////////////////////////////////////////////////////
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public Date scheduleJob(JobDetail jobDetail, Trigger trigger)
throws SchedulerException {
return sched.scheduleJob(schedCtxt, jobDetail, trigger);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public Date scheduleJob(Trigger trigger) throws SchedulerException {
return sched.scheduleJob(schedCtxt, trigger);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void addJob(JobDetail jobDetail, boolean replace)
throws SchedulerException {
sched.addJob(schedCtxt, jobDetail, replace);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public boolean deleteJob(String jobName, String groupName)
throws SchedulerException {
return sched.deleteJob(schedCtxt, jobName, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public boolean unscheduleJob(String triggerName, String groupName)
throws SchedulerException {
return sched.unscheduleJob(schedCtxt, triggerName, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public Date rescheduleJob(String triggerName,
String groupName, Trigger newTrigger) throws SchedulerException {
return sched.rescheduleJob(schedCtxt, triggerName, groupName, newTrigger);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void triggerJob(String jobName, String groupName)
throws SchedulerException {
triggerJob(jobName, groupName, null);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void triggerJob(String jobName, String groupName, JobDataMap data)
throws SchedulerException {
sched.triggerJob(schedCtxt, jobName, groupName, data);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void triggerJobWithVolatileTrigger(String jobName, String groupName)
throws SchedulerException {
triggerJobWithVolatileTrigger(jobName, groupName, null);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void triggerJobWithVolatileTrigger(String jobName, String groupName, JobDataMap data)
throws SchedulerException {
sched.triggerJobWithVolatileTrigger(schedCtxt, jobName, groupName, data);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void pauseTrigger(String triggerName, String groupName)
throws SchedulerException {
sched.pauseTrigger(schedCtxt, triggerName, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void pauseTriggerGroup(String groupName) throws SchedulerException {
sched.pauseTriggerGroup(schedCtxt, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void pauseJob(String jobName, String groupName)
throws SchedulerException {
sched.pauseJob(schedCtxt, jobName, groupName);
}
/**
* @see org.quartz.Scheduler#getPausedTriggerGroups()
*/
public Set getPausedTriggerGroups() throws SchedulerException {
return sched.getPausedTriggerGroups(schedCtxt);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void pauseJobGroup(String groupName) throws SchedulerException {
sched.pauseJobGroup(schedCtxt, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void resumeTrigger(String triggerName, String groupName)
throws SchedulerException {
sched.resumeTrigger(schedCtxt, triggerName, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void resumeTriggerGroup(String groupName) throws SchedulerException {
sched.resumeTriggerGroup(schedCtxt, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void resumeJob(String jobName, String groupName)
throws SchedulerException {
sched.resumeJob(schedCtxt, jobName, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void resumeJobGroup(String groupName) throws SchedulerException {
sched.resumeJobGroup(schedCtxt, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void pauseAll() throws SchedulerException {
sched.pauseAll(schedCtxt);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void resumeAll() throws SchedulerException {
sched.resumeAll(schedCtxt);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public String[] getJobGroupNames() throws SchedulerException {
return sched.getJobGroupNames(schedCtxt);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public Trigger[] getTriggersOfJob(String jobName, String groupName)
throws SchedulerException {
return sched.getTriggersOfJob(schedCtxt, jobName, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public String[] getJobNames(String groupName) throws SchedulerException {
return sched.getJobNames(schedCtxt, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public String[] getTriggerGroupNames() throws SchedulerException {
return sched.getTriggerGroupNames(schedCtxt);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public String[] getTriggerNames(String groupName) throws SchedulerException {
return sched.getTriggerNames(schedCtxt, groupName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public JobDetail getJobDetail(String jobName, String jobGroup)
throws SchedulerException {
return sched.getJobDetail(schedCtxt, jobName, jobGroup);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public Trigger getTrigger(String triggerName, String triggerGroup)
throws SchedulerException {
return sched.getTrigger(schedCtxt, triggerName, triggerGroup);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public int getTriggerState(String triggerName, String triggerGroup)
throws SchedulerException {
return sched.getTriggerState(schedCtxt, triggerName, triggerGroup);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public void addCalendar(String calName, Calendar calendar, boolean replace, boolean updateTriggers)
throws SchedulerException {
sched.addCalendar(schedCtxt, calName, calendar, replace, updateTriggers);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public boolean deleteCalendar(String calName) throws SchedulerException {
return sched.deleteCalendar(schedCtxt, calName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public Calendar getCalendar(String calName) throws SchedulerException {
return sched.getCalendar(schedCtxt, calName);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>,
* passing the <code>SchedulingContext</code> associated with this
* instance.
* </p>
*/
public String[] getCalendarNames() throws SchedulerException {
return sched.getCalendarNames(schedCtxt);
}
///////////////////////////////////////////////////////////////////////////
///
/// Listener-related Methods
///
///////////////////////////////////////////////////////////////////////////
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public void addGlobalJobListener(JobListener jobListener) {
sched.addGlobalJobListener(jobListener);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public void addJobListener(JobListener jobListener) {
sched.addJobListener(jobListener);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
* @deprecated Use <code>{@link #removeGlobalJobListener(String)}</code>
*/
public boolean removeGlobalJobListener(JobListener jobListener) {
return sched.removeGlobalJobListener(
(jobListener == null) ? null : jobListener.getName());
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public boolean removeGlobalJobListener(String name) {
return sched.removeGlobalJobListener(name);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public boolean removeJobListener(String name) {
return sched.removeJobListener(name);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public List getGlobalJobListeners() {
return sched.getGlobalJobListeners();
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public Set getJobListenerNames() {
return sched.getJobListenerNames();
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public JobListener getGlobalJobListener(String name) {
return sched.getGlobalJobListener(name);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public JobListener getJobListener(String name) {
return sched.getJobListener(name);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public void addGlobalTriggerListener(TriggerListener triggerListener) {
sched.addGlobalTriggerListener(triggerListener);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public void addTriggerListener(TriggerListener triggerListener) {
sched.addTriggerListener(triggerListener);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*
* @deprecated Use <code>{@link #removeGlobalTriggerListener(String)}</code>
*/
public boolean removeGlobalTriggerListener(TriggerListener triggerListener) {
return sched.removeGlobalTriggerListener(
(triggerListener == null) ? null : triggerListener.getName());
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public boolean removeGlobalTriggerListener(String name) {
return sched.removeGlobalTriggerListener(name);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public boolean removeTriggerListener(String name) {
return sched.removeTriggerListener(name);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public List getGlobalTriggerListeners() {
return sched.getGlobalTriggerListeners();
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public Set getTriggerListenerNames() {
return sched.getTriggerListenerNames();
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public TriggerListener getGlobalTriggerListener(String name) {
return sched.getGlobalTriggerListener(name);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public TriggerListener getTriggerListener(String name) {
return sched.getTriggerListener(name);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public void addSchedulerListener(SchedulerListener schedulerListener) {
sched.addSchedulerListener(schedulerListener);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public boolean removeSchedulerListener(SchedulerListener schedulerListener) {
return sched.removeSchedulerListener(schedulerListener);
}
/**
* <p>
* Calls the equivalent method on the 'proxied' <code>QuartzScheduler</code>.
* </p>
*/
public List getSchedulerListeners() {
return sched.getSchedulerListeners();
}
public boolean interrupt(String jobName, String groupName) throws UnableToInterruptJobException {
return sched.interrupt(schedCtxt, jobName, groupName);
}
/**
* @see org.quartz.Scheduler#setJobFactory(org.quartz.spi.JobFactory)
*/
public void setJobFactory(JobFactory factory) throws SchedulerException {
sched.setJobFactory(factory);
}
}