All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.opensingular.schedule.quartz.QuartzTriggerFactory Maven / Gradle / Ivy

    There is a newer version: 1.9.7
    Show newest version
    /*
 * Copyright (C) 2016 Singular Studios (a.k.a Atom Tecnologia) - www.opensingular.com
 *
 * 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.opensingular.schedule.quartz;

import java.util.function.Supplier;

import org.opensingular.lib.commons.lambda.ISupplier;
import org.opensingular.schedule.IScheduleData;
import org.opensingular.schedule.IScheduledJob;
import org.opensingular.schedule.ScheduledJob;
import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.SchedulerException;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;

/**
 * Classe para criação de triggers e jobs do Quartz usando as interfaces definidas.
 */
public class QuartzTriggerFactory {

    /**
     * O {@link Supplier} do job a ser criado.
     * @see IScheduledJob#run()
     */
    private ISupplier job;
    /**
     * Os dados do job.
     * @see IScheduledJob#getScheduleData()
     */
    private IScheduleData scheduleData = null;
    /**
     * O {@link JobBuilder} desta fábrica. Este é definido do tipo {@link QuartzScheduledJob}.
     */
    private JobBuilder    jobBuilder   = JobBuilder.newJob().ofType(QuartzScheduledJob.class).storeDurably();
    /**
     * O indicador de disparo imediato.
     */
    private boolean       startNow     = false;

    /**
     * Instancia uma nova fábrica de triggers.
     */
    private QuartzTriggerFactory() {
        /* CONSTRUTOR VAZIO */
    }

    /**
     * Inicia a criação de um novo trigger.
     *
     * @return uma nova instância desta fábrica.
     */
    public static QuartzTriggerFactory newTrigger() {
        return new QuartzTriggerFactory();
    }

    /**
     * Informa os dados do job a ser criado para o trigger.
     *
     * @param scheduleData os dados.
     * @return está fábrica.
     * @see IScheduledJob#getScheduleData()
     */
    public QuartzTriggerFactory withScheduleData(IScheduleData scheduleData) {
        this.scheduleData = scheduleData;
        return this;
    }

    /**
     * Define que a trigger terá um disparo imediato.
     *
     * @return está fábrica.
     */
    public QuartzTriggerFactory startNow() {
        this.startNow = true;
        return this;
    }

    /**
     * Define o nome e o grupo do job a ser criado para o trigger.
     *
     * @param name o nome do job.
     * @param group o grupo do job.
     * @return está fábrica.
     */
    public QuartzTriggerFactory withIdentity(String name, String group) {
        jobBuilder.withIdentity(name, group);
        return this;
    }

    /**
     * Define o identificador do job a ser criado para o trigger.
     *
     * @return está fábrica.
     * @see IScheduledJob#getId()
     */
    public QuartzTriggerFactory withIdentity(String name) {
        jobBuilder.withIdentity(name);
        return this;
    }

    /**
     * Define o {@link Supplier} do job a ser criado para o trigger.
     *
     * @param job o {@link Supplier} do job.
     * @return está fábrica.
     * @see IScheduledJob#run()
     */
    public QuartzTriggerFactory forJob(ISupplier job) {
        this.job = job;
        return this;
    }

    /**
     * Cria o trigger com as definições fornecidas.
     *
     * @return o trigger criado.
     * @throws SchedulerException caso ocorra algum erro do tipo {@link SchedulerException}.
     */
    public Trigger build() throws SchedulerException {
        JobDetail jobDetail = configureJob(jobBuilder.build(), scheduleData);
        TriggerBuilder triggerBuilder = TriggerBuilder.newTrigger().forJob(jobDetail);
        if (scheduleData != null && !scheduleData.getCronExpression().isEmpty()) {
            triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(scheduleData.getCronExpression()));
        }
        if (startNow) {
            triggerBuilder.startNow();
        }
        Trigger trigger = triggerBuilder.build();
        trigger.getJobDataMap().put(SingularSchedulerAccessor.SINGULAR_JOB_DETAIL_KEY, jobDetail);
        return trigger;
    }

    /**
     * Configura o job com as informações fornecidas.
     *
     * @param jobDetail os detalhes do job.
     * @param scheduleData os dados do job.
     * @return os detalhes do job com as informações extras adicionadas.
     */
    private JobDetail configureJob(JobDetail jobDetail, IScheduleData scheduleData) {
        jobDetail.getJobDataMap().put(QuartzJobFactory.JOB_KEY, new ScheduledJob(jobDetail.getKey().getName(), scheduleData, job));
        return jobDetail;
    }
}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy