com.github.kagkarlsson.scheduler.task.helper.RecurringTask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of db-scheduler Show documentation
Simple persistent scheduler for scheduled tasks, recurring or ad-hoc.
There is a newer version: 15.0.0
/**
 * Copyright (C) Gustav Karlsson
 *
 * 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.github.kagkarlsson.scheduler.task.helper;

import com.github.kagkarlsson.scheduler.Clock;
import com.github.kagkarlsson.scheduler.SchedulerClient;
import com.github.kagkarlsson.scheduler.task.*;
import com.github.kagkarlsson.scheduler.task.CompletionHandler.OnCompleteReschedule;
import com.github.kagkarlsson.scheduler.task.DeadExecutionHandler.ReviveDeadExecution;
import com.github.kagkarlsson.scheduler.task.schedule.Schedule;

import java.time.Instant;
import java.util.Optional;

public abstract class RecurringTask extends AbstractTask implements OnStartup {

    public static final String INSTANCE = "recurring";
    private final OnCompleteReschedule onComplete;
    private final Schedule schedule;
    private final ScheduleOnStartup scheduleOnStartup;

    public RecurringTask(String name, Schedule schedule, Class dataClass) {
        this(name, schedule, dataClass, new ScheduleRecurringOnStartup<>(INSTANCE, null, schedule), new FailureHandler.OnFailureReschedule(schedule), new ReviveDeadExecution<>());
    }

    public RecurringTask(String name, Schedule schedule, Class dataClass, FailureHandler failureHandler) {
        this(name, schedule, dataClass, new ScheduleRecurringOnStartup<>(INSTANCE, null, schedule), failureHandler, new ReviveDeadExecution<>());
    }

    public RecurringTask(String name, Schedule schedule, Class dataClass, T initialData) {
        this(name, schedule, dataClass, new ScheduleRecurringOnStartup<>(INSTANCE, initialData, schedule), new FailureHandler.OnFailureReschedule(schedule), new ReviveDeadExecution<>());
    }

    public RecurringTask(String name, Schedule schedule, Class dataClass, ScheduleRecurringOnStartup scheduleOnStartup, FailureHandler failureHandler, DeadExecutionHandler deadExecutionHandler) {
        super(name, dataClass, failureHandler, deadExecutionHandler);
        onComplete = new OnCompleteReschedule<>(schedule);
        this.schedule = schedule;
        this.scheduleOnStartup = scheduleOnStartup;
    }

    @Override
    public SchedulableInstance schedulableInstance(String id) {
        return new SchedulableTaskInstance<>(new TaskInstance<>(getName(), id), schedule::getInitialExecutionTime);
    }

    @Override
    public SchedulableInstance schedulableInstance(String id, T data) {
        return new SchedulableTaskInstance<>(new TaskInstance<>(getName(), id, data), schedule::getInitialExecutionTime);
    }

    @Override
    public void onStartup(SchedulerClient scheduler, Clock clock) {
        if (scheduleOnStartup != null) {
            scheduleOnStartup.apply(scheduler, clock, this);
        }
    }

    @Override
    public CompletionHandler execute(TaskInstance taskInstance, ExecutionContext executionContext) {
        executeRecurringly(taskInstance, executionContext);
        return onComplete;
    }

    public abstract void executeRecurringly(TaskInstance taskInstance, ExecutionContext executionContext);

    public TaskInstanceId getDefaultTaskInstance() {
        return TaskInstanceId.of(name, INSTANCE);
    }

    @Override
    public String toString() {
        return "RecurringTask name=" + getName() + ", onComplete=" + onComplete;
    }

}