KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > springframework > scheduling > quartz > SimpleTriggerBean


1 /*
2  * Copyright 2002-2007 the original author or authors.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.springframework.scheduling.quartz;
18
19 import java.text.ParseException JavaDoc;
20 import java.util.Date JavaDoc;
21 import java.util.Map JavaDoc;
22
23 import org.quartz.JobDetail;
24 import org.quartz.Scheduler;
25 import org.quartz.SimpleTrigger;
26
27 import org.springframework.beans.factory.BeanNameAware;
28 import org.springframework.beans.factory.InitializingBean;
29 import org.springframework.core.Constants;
30
31 /**
32  * Convenience subclass of Quartz's {@link org.quartz.SimpleTrigger}
33  * class, making bean-style usage easier.
34  *
35  * <p>SimpleTrigger itself is already a JavaBean but lacks sensible defaults.
36  * This class uses the Spring bean name as job name, the Quartz default group
37  * ("DEFAULT") as job group, the current time as start time, and indefinite
38  * repetition, if not specified.
39  *
40  * <p>This class will also register the trigger with the job name and group of
41  * a given {@link org.quartz.JobDetail}. This allows {@link SchedulerFactoryBean}
42  * to automatically register a trigger for the corresponding JobDetail,
43  * instead of registering the JobDetail separately.
44  *
45  * <p><b>NOTE:</b> This convenience subclass does not work with trigger
46  * persistence in Quartz 1.6, due to a change in Quartz's trigger handling.
47  * Use Quartz 1.5 if you rely on trigger persistence based on this class,
48  * or the standard Quartz {@link org.quartz.SimpleTrigger} class instead.
49  *
50  * @author Juergen Hoeller
51  * @since 18.02.2004
52  * @see #setName
53  * @see #setGroup
54  * @see #setStartTime
55  * @see #setJobName
56  * @see #setJobGroup
57  * @see #setJobDetail
58  * @see SchedulerFactoryBean#setTriggers
59  * @see SchedulerFactoryBean#setJobDetails
60  * @see CronTriggerBean
61  */
62 public class SimpleTriggerBean extends SimpleTrigger
63     implements JobDetailAwareTrigger, BeanNameAware, InitializingBean {
64
65     /** Constants for the SimpleTrigger class */
66     private static final Constants constants = new Constants(SimpleTrigger.class);
67
68
69     private long startDelay = 0;
70
71     private JobDetail jobDetail;
72
73     private String JavaDoc beanName;
74
75
76     public SimpleTriggerBean() {
77         setRepeatCount(REPEAT_INDEFINITELY);
78     }
79
80     /**
81      * Register objects in the JobDataMap via a given Map.
82      * <p>These objects will be available to this Trigger only,
83      * in contrast to objects in the JobDetail's data map.
84      * @param jobDataAsMap Map with String keys and any objects as values
85      * (for example Spring-managed beans)
86      * @see JobDetailBean#setJobDataAsMap
87      */
88     public void setJobDataAsMap(Map JavaDoc jobDataAsMap) {
89         getJobDataMap().putAll(jobDataAsMap);
90     }
91
92     /**
93      * Set the misfire instruction via the name of the corresponding
94      * constant in the {@link org.quartz.SimpleTrigger} class.
95      * Default is <code>MISFIRE_INSTRUCTION_SMART_POLICY</code>.
96      * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_FIRE_NOW
97      * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_EXISTING_COUNT
98      * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT
99      * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_EXISTING_REPEAT_COUNT
100      * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT
101      * @see org.quartz.Trigger#MISFIRE_INSTRUCTION_SMART_POLICY
102      */
103     public void setMisfireInstructionName(String JavaDoc constantName) {
104         setMisfireInstruction(constants.asNumber(constantName).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 JavaDoc[] 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 JavaDoc beanName) {
152         this.beanName = beanName;
153     }
154
155
156     public void afterPropertiesSet() throws ParseException JavaDoc {
157         if (getName() == null) {
158             setName(this.beanName);
159         }
160         if (getGroup() == null) {
161             setGroup(Scheduler.DEFAULT_GROUP);
162         }
163         if (getStartTime() == null) {
164             setStartTime(new Date JavaDoc(System.currentTimeMillis() + this.startDelay));
165         }
166         if (this.jobDetail != null) {
167             setJobName(this.jobDetail.getName());
168             setJobGroup(this.jobDetail.getGroup());
169         }
170     }
171
172 }
173
Popular Tags