com.github.kagkarlsson.scheduler.boot.config.DbSchedulerCustomizer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of db-scheduler-spring-boot-starter Show documentation

A starter for Spring Boot that will configure db-scheduler

There is a newer version: 14.1.0

Show newest version

/*
 * 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.boot.config;

import com.github.kagkarlsson.scheduler.SchedulerName;
import com.github.kagkarlsson.scheduler.jdbc.JdbcCustomization;
import com.github.kagkarlsson.scheduler.serializer.Serializer;
import java.util.Optional;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;

/**
 * Provides functionality for customizing various aspects of the db-scheduler configuration that is
 * not easily done with properties.
 */
public interface DbSchedulerCustomizer {
  /** Provide a custom {@link SchedulerName} implementation. */
  default Optional schedulerName() {
    return Optional.empty();
  }

  /** A custom serializer for task data. */
  default Optional serializer() {
    return Optional.empty();
  }

  /** Provide an existing {@link ExecutorService} instance. Used for processing tasks. */
  default Optional executorService() {
    return Optional.empty();
  }

  /** Provide an existing {@link ExecutorService} instance. Used for handling due executions. */
  default Optional dueExecutor() {
    return Optional.empty();
  }

  /** Provide an existing {@link ScheduledExecutorService} instance. Used for housekeeping tasks. */
  default Optional housekeeperExecutor() {
    return Optional.empty();
  }

  /** Provide a custom JdbcCustomization. */
  default Optional jdbcCustomization() {
    return Optional.empty();
  }
}