net.nemerosa.ontrack.job.JobScheduler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ontrack-job Show documentation
Abstract management of identified jobs.
There is a newer version: 4.4.5
package net.nemerosa.ontrack.job;

import net.nemerosa.ontrack.job.support.JobNotScheduledException;

import java.util.Collection;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.Future;

public interface JobScheduler {

    /**
     * Schedules or reschedules a job in the scheduler. If the job is already running,
     * does not stop its current execution.
     *
     * @param job      Job to schedule
     * @param schedule Schedule for the job
     */
    void schedule(Job job, Schedule schedule);

    /**
     * Removes a job from the scheduler. Any running execution will be stopped immediately.
     *
     * @param key Key of the job to unschedule
     * @return True if the job was running and had to be stopped
     */
    boolean unschedule(JobKey key);

    /**
     * Pauses the scheduler
     */
    void pause();

    /**
     * Resumes the scheduler
     */
    void resume();

    /**
     * Pauses the execution of a job
     *
     * @param key Key of the job to pause
     * @return true if the job was paused
     * @throws JobNotScheduledException If the job is not scheduled
     */
    boolean pause(JobKey key);

    /**
     * Resumes the execution of a job
     *
     * @param key Key of the job to resume
     * @return true if the job was resumed
     * @throws JobNotScheduledException If the job is not scheduled
     */
    boolean resume(JobKey key);

    /**
     * Gets the status for a job
     *
     * @param key Key of the job to get a status for
     * @return The job status or empty if not found.
     */
    Optional getJobStatus(JobKey key);

    /**
     * Gets all the job keys
     *
     * @return List of all job keys, never null
     */
    Collection getAllJobKeys();

    /**
     * Gets all the job keys for a type of job
     *
     * @param type Job type
     * @return List of job keys for this type
     */
    @SuppressWarnings("unused")
    Collection getJobKeysOfType(JobType type);

    /**
     * Gets all the job keys for a category of jobs
     *
     * @param category Job category
     * @return List of job keys for this category
     */
    Collection getJobKeysOfCategory(JobCategory category);

    /**
     * Gets the list of job statuses
     *
     * @return All job statuses (never null)
     */
    Collection getJobStatuses();

    /**
     * Fires a job immediately, without waiting the schedule
     *
     * @param jobKey Key of the job to fire immediately
     * @return Future for the job execution
     * @throws JobNotScheduledException If the job is not scheduled
     */
    Future fireImmediately(JobKey jobKey);

    /**
     * Fires a job immediately, without waiting the schedule, and passes additional parameters.
     *
     * @param jobKey     Key of the job to fire immediately
     * @param parameters List of parameters to give for this job execution
     * @return Future for the job execution
     * @throws JobNotScheduledException If the job is not scheduled
     * @see JobRunListener#getParam(String)
     */
    Future fireImmediately(JobKey jobKey, Map parameters);

    /**
     * Runs a job once.
     * 
     * Registers the job, runs it and unregisters it.
     *
     * @param job Job to run
     * @return Future for the job execution
     */
    Future runOnce(Job job);

    /**
     * Gets the job key for a job id
     */
    Optional getJobKey(long id);
}