com.github.kagkarlsson.scheduler.TaskRepository 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;

import com.github.kagkarlsson.scheduler.task.Execution;
import com.github.kagkarlsson.scheduler.task.SchedulableInstance;
import com.github.kagkarlsson.scheduler.task.TaskInstanceId;
import java.time.Duration;
import java.time.Instant;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;

public interface TaskRepository {

  boolean createIfNotExists(SchedulableInstance execution);

  List getDue(Instant now, int limit);

  Instant replace(Execution toBeReplaced, SchedulableInstance newInstance);

  void getScheduledExecutions(ScheduledExecutionsFilter filter, Consumer consumer);

  void getScheduledExecutions(
      ScheduledExecutionsFilter filter, String taskName, Consumer consumer);

  List lockAndFetchGeneric(Instant now, int limit);

  List lockAndGetDue(Instant now, int limit);

  void remove(Execution execution);

  boolean reschedule(
      Execution execution,
      Instant nextExecutionTime,
      Instant lastSuccess,
      Instant lastFailure,
      int consecutiveFailures);

  boolean reschedule(
      Execution execution,
      Instant nextExecutionTime,
      Object newData,
      Instant lastSuccess,
      Instant lastFailure,
      int consecutiveFailures);

  Optional pick(Execution e, Instant timePicked);

  List getDeadExecutions(Instant olderThan);

  boolean updateHeartbeatWithRetry(Execution execution, Instant newHeartbeat, int tries);

  boolean updateHeartbeat(Execution execution, Instant heartbeatTime);

  List getExecutionsFailingLongerThan(Duration interval);

  Optional getExecution(String taskName, String taskInstanceId);

  default Optional getExecution(TaskInstanceId taskInstance) {
    return getExecution(taskInstance.getTaskName(), taskInstance.getId());
  }
  ;

  int removeExecutions(String taskName);

  void verifySupportsLockAndFetch();
}