All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.springframework.scheduling.quartz.CronTriggerBean Maven / Gradle / Ivy

There is a newer version: 5.3.39
Show newest version
/*
 * Copyright 2002-2007 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.text.ParseException;
import java.util.Date;
import java.util.Map;
import java.util.TimeZone;

import org.quartz.CronTrigger;
import org.quartz.JobDetail;
import org.quartz.Scheduler;

import org.springframework.beans.factory.BeanNameAware;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.core.Constants;

/**
 * Convenience subclass of Quartz's {@link org.quartz.CronTrigger}
 * class, making bean-style usage easier.
 *
 * 

CronTrigger 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. * *

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. * *

NOTE: This convenience subclass does not work with trigger * persistence in Quartz 1.6, due to a change in Quartz's trigger handling. * Use Quartz 1.5 if you rely on trigger persistence based on this class, * or the standard Quartz {@link org.quartz.CronTrigger} class instead. * * @author Juergen Hoeller * @since 18.02.2004 * @see #setName * @see #setGroup * @see #setStartTime * @see #setJobName * @see #setJobGroup * @see #setJobDetail * @see SchedulerFactoryBean#setTriggers * @see SchedulerFactoryBean#setJobDetails * @see SimpleTriggerBean */ public class CronTriggerBean extends CronTrigger implements JobDetailAwareTrigger, BeanNameAware, InitializingBean { /** Constants for the CronTrigger class */ private static final Constants constants = new Constants(CronTrigger.class); private JobDetail jobDetail; private String beanName; /** * Register objects in the JobDataMap via a given Map. *

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 JobDetailBean#setJobDataAsMap */ public void setJobDataAsMap(Map jobDataAsMap) { getJobDataMap().putAll(jobDataAsMap); } /** * Set the misfire instruction via the name of the corresponding * constant in the {@link org.quartz.CronTrigger} class. * Default is MISFIRE_INSTRUCTION_SMART_POLICY. * @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) { setMisfireInstruction(constants.asNumber(constantName).intValue()); } /** * Set a list of TriggerListener names for this job, referring to * non-global TriggerListeners registered with the Scheduler. *

A TriggerListener name always refers to the name returned * by the TriggerListener implementation. * @see SchedulerFactoryBean#setTriggerListeners * @see org.quartz.TriggerListener#getName */ public void setTriggerListenerNames(String[] names) { for (int i = 0; i < names.length; i++) { addTriggerListener(names[i]); } } /** * Set the JobDetail that this trigger should be associated with. *

This is typically used with a bean reference if the JobDetail * is a Spring-managed bean. Alternatively, the trigger can also * be associated with a job by name and group. * @see #setJobName * @see #setJobGroup */ public void setJobDetail(JobDetail jobDetail) { this.jobDetail = jobDetail; } public JobDetail getJobDetail() { return this.jobDetail; } public void setBeanName(String beanName) { this.beanName = beanName; } public void afterPropertiesSet() throws ParseException { if (getName() == null) { setName(this.beanName); } if (getGroup() == null) { setGroup(Scheduler.DEFAULT_GROUP); } if (getStartTime() == null) { setStartTime(new Date()); } if (getTimeZone() == null) { setTimeZone(TimeZone.getDefault()); } if (this.jobDetail != null) { setJobName(this.jobDetail.getName()); setJobGroup(this.jobDetail.getGroup()); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy