001: /*
002: * Copyright 2002-2007 the original author or authors.
003: *
004: * Licensed under the Apache License, Version 2.0 (the "License");
005: * you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at
007: *
008: * http://www.apache.org/licenses/LICENSE-2.0
009: *
010: * Unless required by applicable law or agreed to in writing, software
011: * distributed under the License is distributed on an "AS IS" BASIS,
012: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013: * See the License for the specific language governing permissions and
014: * limitations under the License.
015: */
016:
017: package org.springframework.scheduling.quartz;
018:
019: import java.text.ParseException;
020: import java.util.Date;
021: import java.util.Map;
022:
023: import org.quartz.JobDetail;
024: import org.quartz.Scheduler;
025: import org.quartz.SimpleTrigger;
026:
027: import org.springframework.beans.factory.BeanNameAware;
028: import org.springframework.beans.factory.InitializingBean;
029: import org.springframework.core.Constants;
030:
031: /**
032: * Convenience subclass of Quartz's {@link org.quartz.SimpleTrigger}
033: * class, making bean-style usage easier.
034: *
035: * <p>SimpleTrigger itself is already a JavaBean but lacks sensible defaults.
036: * This class uses the Spring bean name as job name, the Quartz default group
037: * ("DEFAULT") as job group, the current time as start time, and indefinite
038: * repetition, if not specified.
039: *
040: * <p>This class will also register the trigger with the job name and group of
041: * a given {@link org.quartz.JobDetail}. This allows {@link SchedulerFactoryBean}
042: * to automatically register a trigger for the corresponding JobDetail,
043: * instead of registering the JobDetail separately.
044: *
045: * <p><b>NOTE:</b> This convenience subclass does not work with trigger
046: * persistence in Quartz 1.6, due to a change in Quartz's trigger handling.
047: * Use Quartz 1.5 if you rely on trigger persistence based on this class,
048: * or the standard Quartz {@link org.quartz.SimpleTrigger} class instead.
049: *
050: * @author Juergen Hoeller
051: * @since 18.02.2004
052: * @see #setName
053: * @see #setGroup
054: * @see #setStartTime
055: * @see #setJobName
056: * @see #setJobGroup
057: * @see #setJobDetail
058: * @see SchedulerFactoryBean#setTriggers
059: * @see SchedulerFactoryBean#setJobDetails
060: * @see CronTriggerBean
061: */
062: public class SimpleTriggerBean extends SimpleTrigger implements
063: JobDetailAwareTrigger, BeanNameAware, InitializingBean {
064:
065: /** Constants for the SimpleTrigger class */
066: private static final Constants constants = new Constants(
067: SimpleTrigger.class);
068:
069: private long startDelay = 0;
070:
071: private JobDetail jobDetail;
072:
073: private String beanName;
074:
075: public SimpleTriggerBean() {
076: setRepeatCount(REPEAT_INDEFINITELY);
077: }
078:
079: /**
080: * Register objects in the JobDataMap via a given Map.
081: * <p>These objects will be available to this Trigger only,
082: * in contrast to objects in the JobDetail's data map.
083: * @param jobDataAsMap Map with String keys and any objects as values
084: * (for example Spring-managed beans)
085: * @see JobDetailBean#setJobDataAsMap
086: */
087: public void setJobDataAsMap(Map jobDataAsMap) {
088: getJobDataMap().putAll(jobDataAsMap);
089: }
090:
091: /**
092: * Set the misfire instruction via the name of the corresponding
093: * constant in the {@link org.quartz.SimpleTrigger} class.
094: * Default is <code>MISFIRE_INSTRUCTION_SMART_POLICY</code>.
095: * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_FIRE_NOW
096: * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_EXISTING_COUNT
097: * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT
098: * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_EXISTING_REPEAT_COUNT
099: * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT
100: * @see org.quartz.Trigger#MISFIRE_INSTRUCTION_SMART_POLICY
101: */
102: public void setMisfireInstructionName(String constantName) {
103: setMisfireInstruction(constants.asNumber(constantName)
104: .intValue());
105: }
106:
107: /**
108: * Set a list of TriggerListener names for this job, referring to
109: * non-global TriggerListeners registered with the Scheduler.
110: * <p>A TriggerListener name always refers to the name returned
111: * by the TriggerListener implementation.
112: * @see SchedulerFactoryBean#setTriggerListeners
113: * @see org.quartz.TriggerListener#getName
114: */
115: public void setTriggerListenerNames(String[] names) {
116: for (int i = 0; i < names.length; i++) {
117: addTriggerListener(names[i]);
118: }
119: }
120:
121: /**
122: * Set the delay before starting the job for the first time.
123: * The given number of milliseconds will be added to the current
124: * time to calculate the start time. Default is 0.
125: * <p>This delay will just be applied if no custom start time was
126: * specified. However, in typical usage within a Spring context,
127: * the start time will be the container startup time anyway.
128: * Specifying a relative delay is appropriate in that case.
129: * @see #setStartTime
130: */
131: public void setStartDelay(long startDelay) {
132: this .startDelay = startDelay;
133: }
134:
135: /**
136: * Set the JobDetail that this trigger should be associated with.
137: * <p>This is typically used with a bean reference if the JobDetail
138: * is a Spring-managed bean. Alternatively, the trigger can also
139: * be associated with a job by name and group.
140: * @see #setJobName
141: * @see #setJobGroup
142: */
143: public void setJobDetail(JobDetail jobDetail) {
144: this .jobDetail = jobDetail;
145: }
146:
147: public JobDetail getJobDetail() {
148: return this .jobDetail;
149: }
150:
151: public void setBeanName(String beanName) {
152: this .beanName = beanName;
153: }
154:
155: public void afterPropertiesSet() throws ParseException {
156: if (getName() == null) {
157: setName(this .beanName);
158: }
159: if (getGroup() == null) {
160: setGroup(Scheduler.DEFAULT_GROUP);
161: }
162: if (getStartTime() == null) {
163: setStartTime(new Date(System.currentTimeMillis()
164: + this.startDelay));
165: }
166: if (this.jobDetail != null) {
167: setJobName(this.jobDetail.getName());
168: setJobGroup(this.jobDetail.getGroup());
169: }
170: }
171:
172: }
|