com.saysth.commons.quartz.CronTriggerBean.java Source code

Java tutorial

Introduction

Here is the source code for com.saysth.commons.quartz.CronTriggerBean.java

Source

/*
 * Copyright 2002-2009 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 com.saysth.commons.quartz;

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.quartz.impl.triggers.CronTriggerImpl;
import org.springframework.beans.factory.BeanNameAware;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.core.Constants;
import org.springframework.util.Assert;

/**
 * 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. 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 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 CronTriggerImpl
        implements JobDetailAwareTrigger, BeanNameAware, InitializingBean {

    /**
     * 
     */
    private static final long serialVersionUID = 1L;

    /** Constants for the CronTrigger class */
    private static final Constants constants = new Constants(CronTrigger.class);

    private JobDetail jobDetail;

    private String beanName;

    private long startDelay;

    /**
     * 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 JobDetailBean#setJobDataAsMap
     */
    public void setJobDataAsMap(Map<? extends String, ? extends Object> jobDataAsMap) {
        getJobDataMap().putAll(jobDataAsMap);
    }

    /**
     * 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) {
        setMisfireInstruction(constants.asNumber(constantName).intValue());
    }

    /**
     * Set a list of TriggerListener names for this job, referring to non-global
     * TriggerListeners registered with the Scheduler.
     * <p>
     * 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++) {
            // TODO addTriggerListener
            // addTriggerListener(names[i]);
        }
    }

    /**
     * Set the JobDetail that this trigger should be associated with.
     * <p>
     * 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;
    }

    /**
     * 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;
    }

    public void setBeanName(String beanName) {
        this.beanName = beanName;
    }

    public void afterPropertiesSet() throws Exception {
        if (this.startDelay > 0) {
            setStartTime(new Date(System.currentTimeMillis() + this.startDelay));
        }

        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.getKey().getName());
            setJobGroup(this.jobDetail.getKey().getGroup());
        }
    }

}