org.mule.modules.schedulers.cron.CronScheduler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mule-module-schedulers Show documentation
There is a newer version: 3.9.0
Show newest version
/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.modules.schedulers.cron;

import static org.mule.modules.schedulers.i18n.SchedulerMessages.couldNotCreateScheduler;
import static org.mule.modules.schedulers.i18n.SchedulerMessages.couldNotPauseSchedulers;
import static org.mule.modules.schedulers.i18n.SchedulerMessages.couldNotScheduleJob;
import static org.mule.modules.schedulers.i18n.SchedulerMessages.couldNotShutdownScheduler;
import static org.quartz.CronScheduleBuilder.cronSchedule;
import static org.quartz.JobBuilder.newJob;
import static org.quartz.TriggerBuilder.newTrigger;

import org.mule.api.DefaultMuleException;
import org.mule.api.MuleContext;
import org.mule.api.MuleException;
import org.mule.api.context.MuleContextAware;
import org.mule.api.lifecycle.InitialisationException;
import org.mule.transport.PollingReceiverWorker;
import org.mule.transport.polling.schedule.PollScheduler;

import java.util.Properties;
import java.util.TimeZone;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.quartz.CronTrigger;
import org.quartz.JobDataMap;
import org.quartz.JobDetail;
import org.quartz.JobKey;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SchedulerFactory;
import org.quartz.TriggerKey;
import org.quartz.impl.StdSchedulerFactory;

/**
 * 
 * Cron {@link org.mule.api.schedule.Scheduler} implemented with Quartz.
 * 
 *
 * @since 3.5.0
 */
public class CronScheduler extends PollScheduler implements MuleContextAware
{

    protected transient Log logger = LogFactory.getLog(getClass());

    public static final String THREAD_POLL_CLASS_PROPERTY = "org.quartz.threadPool.class";
    public static final String THREAD_POLL_CLASS = "org.quartz.simpl.SimpleThreadPool";
    public static final String THREAD_POOL_COUNT_PROPERTY = "org.quartz.threadPool.threadCount";
    public static final String POLL_CRON_SCHEDULER_JOB = "poll.scheduler.job";
    public static final String QUARTZ_INSTANCE_NAME_PROPERTY = "org.quartz.scheduler.instanceName";

    /**
     * 
     * The Quartz scheduler. The {@link CronScheduler} is a wrapper of this instance.
     * 
     */
    private org.quartz.Scheduler quartzScheduler;

    /**
     * 
     * {@link MuleContext} used to define the thread poll size of the quartz scheduler
     * 
     */
    private MuleContext context;

    /**
     * 
     * The quartz expression written in the scheduler configuration
     * 
     */
    private String cronExpression;

    /**
     * 
     * The {@link TimeZone} in which the {@code cronExpression} will be based
     * 
     */
    private TimeZone timeZone;

    /**
     * 
     * The poll job name created in the initialization phase. (This is used to tell quartz which is the job that we are
     * managing)
     * 
     */
    private String jobName;

    /**
     * 
     * The poll job name created in the initialization phase. (This is used to tell quartz which is the job that
     * we are managing)
     * 
     */
    private String groupName;

    public CronScheduler(String name, PollingReceiverWorker job, String cronExpression, TimeZone timeZone)
    {
        super(name, job);

        this.cronExpression = cronExpression;
        this.timeZone = timeZone;
    }

    @Override
    public void schedule() throws Exception
    {
        quartzScheduler.triggerJob(JobKey.jobKey(jobName, groupName));
    }

    @Override
    public void dispose()
    {
        try
        {
            quartzScheduler.shutdown();
        }
        catch (SchedulerException e)
        {
            logger.error(couldNotShutdownScheduler(), e);
        }
    }

    @Override
    public void initialise() throws InitialisationException
    {
        try
        {
            quartzScheduler = createScheduler();

            jobName = job.getReceiver().getReceiverKey();
            groupName = job.getReceiver().getEndpoint().getName();

            quartzScheduler.addJob(jobDetail(jobName, groupName, job), true);

            quartzScheduler.start();
        }
        catch (SchedulerException e)
        {
            throw new InitialisationException(couldNotCreateScheduler(), e, this);
        }

    }

    @Override
    public void start() throws MuleException
    {
        try
        {
            if (quartzScheduler.isStarted())
            {
                if (quartzScheduler.getTrigger(TriggerKey.triggerKey(getName(), groupName)) == null)
                {
                    CronTrigger cronTrigger = newTrigger()
                        .withIdentity(getName(), groupName)
                        .forJob(jobName, groupName)
                        .withSchedule(cronSchedule(cronExpression).inTimeZone(timeZone))
                        .build();
                    quartzScheduler.scheduleJob(cronTrigger);
                }
                else
                {
                    quartzScheduler.resumeAll();
                }
            }

        }
        catch (SchedulerException e)
        {
            throw new DefaultMuleException(couldNotScheduleJob(), e);
        }
    }

    @Override
    public void stop() throws MuleException
    {
        try
        {
            quartzScheduler.pauseAll();
        }
        catch (SchedulerException e)
        {
            throw new DefaultMuleException(couldNotPauseSchedulers(), e);
        }
    }

    public String getCronExpression()
    {
        return cronExpression;
    }

    /**
     * @return the {@link TimeZone} in which the {@code cronExpression} will be based.
     */
    public TimeZone getTimeZone()
    {
        return timeZone;
    }

    @Override
    public void setMuleContext(MuleContext context)
    {
        this.context = context;
    }

    private JobDetail jobDetail(String jobName, String groupName, PollingReceiverWorker job)
    {
        JobDataMap jobDataMap = new JobDataMap();
        jobDataMap.put(POLL_CRON_SCHEDULER_JOB, job);
        return newJob(CronJob.class)
                .storeDurably()
                .withIdentity(jobName, groupName)
                .usingJobData(jobDataMap)
                .build();
    }


    private Scheduler createScheduler() throws SchedulerException
    {
        SchedulerFactory factory = new StdSchedulerFactory(withFactoryProperties());

        return factory.getScheduler();
    }

    private Properties withFactoryProperties()
    {
        Properties factoryProperties = new Properties();

        factoryProperties.setProperty(QUARTZ_INSTANCE_NAME_PROPERTY, context.getConfiguration().getId() + "-" + name);
        factoryProperties.setProperty(THREAD_POLL_CLASS_PROPERTY, THREAD_POLL_CLASS);
        factoryProperties.setProperty(THREAD_POOL_COUNT_PROPERTY, String.valueOf(context.getDefaultMessageReceiverThreadingProfile().getMaxThreadsActive()));
        return factoryProperties;
    }

}