introduced JobDetail/CronTrigger/SimpleTriggerFactoryBean variants for Quartz 2.0/2.1 support (SPR-8275?)

Author: jhoeller

org.springframework.context.support/src/main/java/org/springframework/scheduling/quartz/AdaptableJobFactory.java

@@ -30,7 +30,7 @@
  * JobFactory implementation that supports {@link java.lang.Runnable}
  * objects as well as standard Quartz {@link org.quartz.Job} instances.
  *
- * <p>Compatible with Quartz 1.5+ as well as Quartz 2.0, as of Spring 3.1.
+ * <p>Compatible with Quartz 1.5+ as well as Quartz 2.0/2.1, as of Spring 3.1.
  *
  * @author Juergen Hoeller
  * @since 2.0

org.springframework.context.support/src/main/java/org/springframework/scheduling/quartz/CronTriggerBean.java

@@ -33,7 +33,7 @@
  * Convenience subclass of Quartz's {@link org.quartz.CronTrigger} class,
  * making bean-style usage easier.
  *
- * <p>CronTrigger itself is already a JavaBean but lacks sensible defaults.
+ * <p><code>CronTrigger</code> itself is already a JavaBean but lacks sensible defaults.
  * This class uses the Spring bean name as job name, the Quartz default group
  * ("DEFAULT") as job group, the current time as start time, and indefinite
  * repetition, if not specified.
@@ -44,8 +44,10 @@
  * instead of registering the JobDetail separately.
  *
  * <p><b>NOTE: This convenience subclass does not work against Quartz 2.0.</b>
- * Use Quartz 2.0's native <code>CronTriggerImpl</code> class or the new
- * Quartz 2.0 builder API instead.
+ * Use Quartz 2.0's native <code>JobDetailImpl</code> class or the new Quartz 2.0
+ * builder API instead. Alternatively, switch to Spring's {@link CronTriggerFactoryBean}
+ * which largely is a drop-in replacement for this class and its properties and
+ * consistently works against Quartz 1.x as well as Quartz 2.0/2.1.
  *
  * @author Juergen Hoeller
  * @since 18.02.2004
@@ -72,6 +74,7 @@ public class CronTriggerBean extends CronTrigger
 
 	private long startDelay;
 
+
 	/**
 	 * Register objects in the JobDataMap via a given Map.
 	 * <p>These objects will be available to this Trigger only,
@@ -80,7 +83,7 @@ public class CronTriggerBean extends CronTrigger
 	 * (for example Spring-managed beans)
 	 * @see JobDetailBean#setJobDataAsMap
 	 */
-	public void setJobDataAsMap(Map jobDataAsMap) {
+	public void setJobDataAsMap(Map<String, ?> jobDataAsMap) {
 		getJobDataMap().putAll(jobDataAsMap);
 	}
 
@@ -110,6 +113,19 @@ public void setTriggerListenerNames(String[] names) {
 		}
 	}
 
+	/**
+	 * Set the start delay in milliseconds.
+	 * <p>The start delay is added to the current system time (when the bean starts)
+	 * to control the {@link #setStartTime start time} of the trigger.
+	 * <p>If the start delay is non-zero, it will <strong>always</strong>
+	 * take precedence over start time.
+	 * @param startDelay the start delay, in milliseconds
+	 */
+	public void setStartDelay(long startDelay) {
+		Assert.state(startDelay >= 0, "Start delay cannot be negative.");
+		this.startDelay = startDelay;
+	}
+
 	/**
 	 * Set the JobDetail that this trigger should be associated with.
 	 * <p>This is typically used with a bean reference if the JobDetail
@@ -122,20 +138,6 @@ public void setJobDetail(JobDetail jobDetail) {
 		this.jobDetail = jobDetail;
 	}
 
-	/**
-	 * Set the start delay in milliseconds.
-	 * <p>The start delay is added to the current system time
-	 * (when the bean starts) to control the {@link #setStartTime start time}
-	 * of the trigger.
-	 * <p>If the start delay is non-zero it will <strong>always</strong>
-	 * take precedence over start time.
-	 * @param startDelay the start delay, in milliseconds.
-	 */
-	public void setStartDelay(long startDelay) {
-		Assert.state(startDelay >= 0, "Start delay cannot be negative.");
-		this.startDelay = startDelay;
-	}
-
 	public JobDetail getJobDetail() {
 		return this.jobDetail;
 	}
@@ -146,7 +148,7 @@ public void setBeanName(String beanName) {
 
 
 	public void afterPropertiesSet() throws Exception {
-		if(this.startDelay > 0) {
+		if (this.startDelay > 0) {
 			setStartTime(new Date(System.currentTimeMillis() + this.startDelay));
 		}
 

org.springframework.context.support/src/main/java/org/springframework/scheduling/quartz/CronTriggerFactoryBean.java

@@ -0,0 +1,283 @@
+/*
+ * Copyright 2002-2011 the original author or authors.
+ *
+ * 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.springframework.scheduling.quartz;
+
+import java.lang.reflect.Method;
+import java.util.Date;
+import java.util.Map;
+import java.util.TimeZone;
+
+import org.quartz.CronTrigger;
+import org.quartz.JobDataMap;
+import org.quartz.JobDetail;
+import org.quartz.Scheduler;
+
+import org.springframework.beans.BeanWrapper;
+import org.springframework.beans.BeanWrapperImpl;
+import org.springframework.beans.MutablePropertyValues;
+import org.springframework.beans.factory.BeanNameAware;
+import org.springframework.beans.factory.FactoryBean;
+import org.springframework.beans.factory.InitializingBean;
+import org.springframework.core.Constants;
+import org.springframework.util.Assert;
+import org.springframework.util.ReflectionUtils;
+
+/**
+ * A Spring {@link FactoryBean} for creating a Quartz {@link org.quartz.CronTrigger}
+ * instance, supporting bean-style usage for trigger configuration.
+ *
+ * <p><code>CronTrigger(Impl)</code> itself is already a JavaBean but lacks sensible defaults.
+ * This class uses the Spring bean name as job name, the Quartz default group ("DEFAULT")
+ * as job group, the current time as start time, and indefinite repetition, if not specified.
+ *
+ * <p>This class will also register the trigger with the job name and group of
+ * a given {@link org.quartz.JobDetail}. This allows {@link SchedulerFactoryBean}
+ * to automatically register a trigger for the corresponding JobDetail,
+ * instead of registering the JobDetail separately.
+ *
+ * <p><b>NOTE:</b> This FactoryBean works against both Quartz 1.x and Quartz 2.0/2.1,
+ * in contrast to the older {@link CronTriggerBean} class.
+ *
+ * @author Juergen Hoeller
+ * @since 3.1
+ * @see #setName
+ * @see #setGroup
+ * @see #setStartTime
+ * @see #setJobName
+ * @see #setJobGroup
+ * @see #setJobDetail
+ * @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setTriggers
+ * @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setJobDetails
+ * @see org.springframework.scheduling.quartz.SimpleTriggerBean
+ */
+public class CronTriggerFactoryBean implements FactoryBean<CronTrigger>, BeanNameAware, InitializingBean {
+
+	/** Constants for the CronTrigger class */
+	private static final Constants constants = new Constants(CronTrigger.class);
+
+
+	private String name;
+
+	private String group;
+
+	private JobDetail jobDetail;
+
+	private JobDataMap jobDataMap = new JobDataMap();
+
+	private Date startTime;
+
+	private long startDelay;
+
+	private String cronExpression;
+
+	private TimeZone timeZone;
+
+	private int priority;
+
+	private int misfireInstruction;
+
+	private String beanName;
+
+	private CronTrigger cronTrigger;
+
+
+	/**
+	 * Specify the trigger's name.
+	 */
+	public void setName(String name) {
+		this.name = name;
+	}
+
+	/**
+	 * Specify the trigger's group.
+	 */
+	public void setGroup(String group) {
+		this.group = group;
+	}
+
+	/**
+	 * Set the JobDetail that this trigger should be associated with.
+	 */
+	public void setJobDetail(JobDetail jobDetail) {
+		this.jobDetail = jobDetail;
+	}
+
+	/**
+	 * Set the trigger's JobDataMap.
+	 * @see #setJobDataAsMap
+	 */
+	public void setJobDataMap(JobDataMap jobDataMap) {
+		this.jobDataMap = jobDataMap;
+	}
+
+	/**
+	 * Return the trigger's JobDataMap.
+	 */
+	public JobDataMap getJobDataMap() {
+		return this.jobDataMap;
+	}
+
+	/**
+	 * Register objects in the JobDataMap via a given Map.
+	 * <p>These objects will be available to this Trigger only,
+	 * in contrast to objects in the JobDetail's data map.
+	 * @param jobDataAsMap Map with String keys and any objects as values
+	 * (for example Spring-managed beans)
+	 * @see org.springframework.scheduling.quartz.JobDetailBean#setJobDataAsMap
+	 */
+	public void setJobDataAsMap(Map<String, ?> jobDataAsMap) {
+		this.jobDataMap.putAll(jobDataAsMap);
+	}
+
+	/**
+	 * Set the start delay in milliseconds.
+	 * <p>The start delay is added to the current system time (when the bean starts)
+	 * to control the start time of the trigger.
+	 * @param startDelay the start delay, in milliseconds
+	 */
+	public void setStartDelay(long startDelay) {
+		Assert.state(startDelay >= 0, "Start delay cannot be negative.");
+		this.startDelay = startDelay;
+	}
+
+	/**
+	 * Specify the cron expression for this trigger.
+	 */
+	public void setCronExpression(String cronExpression) {
+		this.cronExpression = cronExpression;
+	}
+
+	/**
+	 * Specify the time zone for this trigger's cron expression.
+	 */
+	public void setTimeZone(TimeZone timeZone) {
+		this.timeZone = timeZone;
+	}
+
+	/**
+	 * Specify the priority of this trigger.
+	 */
+	public void setPriority(int priority) {
+		this.priority = priority;
+	}
+
+	/**
+	 * Specify a misfire instruction for this trigger.
+	 */
+	public void setMisfireInstruction(int misfireInstruction) {
+		this.misfireInstruction = misfireInstruction;
+	}
+
+	/**
+	 * Set the misfire instruction via the name of the corresponding
+	 * constant in the {@link org.quartz.CronTrigger} class.
+	 * Default is <code>MISFIRE_INSTRUCTION_SMART_POLICY</code>.
+	 * @see org.quartz.CronTrigger#MISFIRE_INSTRUCTION_FIRE_ONCE_NOW
+	 * @see org.quartz.CronTrigger#MISFIRE_INSTRUCTION_DO_NOTHING
+	 * @see org.quartz.Trigger#MISFIRE_INSTRUCTION_SMART_POLICY
+	 */
+	public void setMisfireInstructionName(String constantName) {
+		this.misfireInstruction = constants.asNumber(constantName).intValue();
+	}
+
+	public void setBeanName(String beanName) {
+		this.beanName = beanName;
+	}
+
+
+	public void afterPropertiesSet() {
+		if (this.name == null) {
+			this.name = this.beanName;
+		}
+		if (this.group == null) {
+			this.group = Scheduler.DEFAULT_GROUP;
+		}
+		if (this.jobDetail != null) {
+			this.jobDataMap.put(JobDetailAwareTrigger.JOB_DETAIL_KEY, this.jobDetail);
+		}
+		if (this.startDelay > 0) {
+			this.startTime = new Date(System.currentTimeMillis() + this.startDelay);
+		}
+		else if (this.startTime == null) {
+			this.startTime = new Date();
+		}
+		if (this.timeZone == null) {
+			this.timeZone = TimeZone.getDefault();
+		}
+
+		/*
+		CronTriggerImpl cti = new CronTriggerImpl();
+		cti.setName(this.name);
+		cti.setGroup(this.group);
+		cti.setJobKey(this.jobDetail.getKey());
+		cti.setJobDataMap(this.jobDataMap);
+		cti.setStartTime(this.startTime);
+		cti.setCronExpression(this.cronExpression);
+		cti.setTimeZone(this.timeZone);
+		cti.setPriority(this.priority);
+		cti.setMisfireInstruction(this.misfireInstruction);
+		this.cronTrigger = cti;
+		*/
+
+		Class cronTriggerClass;
+		Method jobKeyMethod;
+		try {
+			cronTriggerClass = getClass().getClassLoader().loadClass("org.quartz.impl.triggers.CronTriggerImpl");
+			jobKeyMethod = JobDetail.class.getMethod("getKey");
+		}
+		catch (ClassNotFoundException ex) {
+			cronTriggerClass = CronTrigger.class;
+			jobKeyMethod = null;
+		}
+		catch (NoSuchMethodException ex) {
+			throw new IllegalStateException("Incompatible Quartz version");
+		}
+		BeanWrapper bw = new BeanWrapperImpl(cronTriggerClass);
+		MutablePropertyValues pvs = new MutablePropertyValues();
+		pvs.add("name", this.name);
+		pvs.add("group", this.group);
+		if (jobKeyMethod != null) {
+			pvs.add("jobKey", ReflectionUtils.invokeMethod(jobKeyMethod, this.jobDetail));
+		}
+		else {
+			pvs.add("jobName", this.jobDetail.getName());
+			pvs.add("jobGroup", this.jobDetail.getGroup());
+		}
+		pvs.add("jobDataMap", this.jobDataMap);
+		pvs.add("startTime", this.startTime);
+		pvs.add("cronExpression", this.cronExpression);
+		pvs.add("timeZone", this.timeZone);
+		pvs.add("priority", this.priority);
+		pvs.add("misfireInstruction", this.misfireInstruction);
+		bw.setPropertyValues(pvs);
+		this.cronTrigger = (CronTrigger) bw.getWrappedInstance();
+	}
+
+
+	public CronTrigger getObject() {
+		return this.cronTrigger;
+	}
+
+	public Class<?> getObjectType() {
+		return CronTrigger.class;
+	}
+
+	public boolean isSingleton() {
+		return true;
+	}
+
+}