de.otto.edison.jobs.definition

Class DefaultJobDefinition

java.lang.Object

de.otto.edison.jobs.definition.DefaultJobDefinition

All Implemented Interfaces:

JobDefinition

public final class DefaultJobDefinition
extends java.lang.Object
implements JobDefinition

A definition of a job type.

Since:

20.08.15

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	cron() Optional cron expression used to specify when a job should be triggered.
static JobDefinition	cronJobDefinition(java.lang.String jobType, java.lang.String jobName, java.lang.String description, java.lang.String cron, java.util.Optional<java.time.Duration> maxAge) Create a JobDefinition that is using a cron expression to specify, when and how often the job should be triggered.
java.lang.String	description() A human-readable description of the job.
java.util.Optional<java.time.Duration>	fixedDelay() Optional fixed delay after that a job is triggered again.
static DefaultJobDefinition	fixedDelayJobDefinition(java.lang.String jobType, java.lang.String jobName, java.lang.String description, java.time.Duration fixedDelay, java.util.Optional<java.time.Duration> maxAge) Create a JobDefinition that is using fixed delays specify, when and how often the job should be triggered.
java.lang.String	jobName() A human-readable name of the job.
java.lang.String	jobType() The type of the job that is specified by this JobDefinition.
java.util.Optional<java.time.Duration>	maxAge()
static JobDefinition	notTriggerableJobDefinition(java.lang.String jobType, java.lang.String jobName, java.lang.String description) Create a JobDefinition that will not be triggered.
int	retries() Number of retries when starting a job is failing for some reason.
static JobDefinition	retryableCronJobDefinition(java.lang.String jobType, java.lang.String jobName, java.lang.String description, java.lang.String cron, int retries, java.time.Duration retryDelay, java.util.Optional<java.time.Duration> maxAge) Create a JobDefinition that is using a cron expression to specify, when and how often the job should be triggered.
static DefaultJobDefinition	retryableFixedDelayJobDefinition(java.lang.String jobType, java.lang.String jobName, java.lang.String description, java.time.Duration fixedDelay, int retries, java.util.Optional<java.time.Duration> retryDelay, java.util.Optional<java.time.Duration> maxAge) Create a JobDefinition that is using fixed delays specify, when and how often the job should be triggered.
java.util.Optional<java.time.Duration>	retryDelay() The duration after that a retry should be scheduled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

cronJobDefinition

public static JobDefinition cronJobDefinition(java.lang.String jobType,
                                              java.lang.String jobName,
                                              java.lang.String description,
                                              java.lang.String cron,
                                              java.util.Optional<java.time.Duration> maxAge)

Create a JobDefinition that is using a cron expression to specify, when and how often the job should be triggered.

Parameters:

jobType - The type of the Job

jobName - A human readable name of the Job

description - A human readable description of the Job.

cron - The cron expression

maxAge - Maximum age of the latest job after that we want to get a warning

Returns:

JobDefinition

notTriggerableJobDefinition

public static JobDefinition notTriggerableJobDefinition(java.lang.String jobType,
                                                        java.lang.String jobName,
                                                        java.lang.String description)

Create a JobDefinition that will not be triggered.

Parameters:

jobType - The type of the Job

jobName - A human readable name of the Job

description - A human readable description of the Job.

Returns:

JobDefinition

retryableCronJobDefinition

public static JobDefinition retryableCronJobDefinition(java.lang.String jobType,
                                                       java.lang.String jobName,
                                                       java.lang.String description,
                                                       java.lang.String cron,
                                                       int retries,
                                                       java.time.Duration retryDelay,
                                                       java.util.Optional<java.time.Duration> maxAge)

Create a JobDefinition that is using a cron expression to specify, when and how often the job should be triggered.

Parameters:

jobType - The type of the Job

jobName - A human readable name of the Job

description - A human readable description of the Job.

cron - The cron expression

maxAge - Maximum age of the latest job after that we want to get a warning

retries - Specifies how often a job trigger should retry to start the job if triggering fails for some reason.

retryDelay - The optional delay between retries.

Returns:

JobDefinition

fixedDelayJobDefinition

public static DefaultJobDefinition fixedDelayJobDefinition(java.lang.String jobType,
                                                           java.lang.String jobName,
                                                           java.lang.String description,
                                                           java.time.Duration fixedDelay,
                                                           java.util.Optional<java.time.Duration> maxAge)

Create a JobDefinition that is using fixed delays specify, when and how often the job should be triggered.

Parameters:

jobType - The type of the Job

jobName - A human readable name of the Job

description - A human readable description of the Job.

fixedDelay - The delay duration between to executions of the Job

maxAge - Maximum age of the latest job after that we want to get a warning

Returns:

JobDefinition

retryableFixedDelayJobDefinition

public static DefaultJobDefinition retryableFixedDelayJobDefinition(java.lang.String jobType,
                                                                    java.lang.String jobName,
                                                                    java.lang.String description,
                                                                    java.time.Duration fixedDelay,
                                                                    int retries,
                                                                    java.util.Optional<java.time.Duration> retryDelay,
                                                                    java.util.Optional<java.time.Duration> maxAge)

Create a JobDefinition that is using fixed delays specify, when and how often the job should be triggered.

Parameters:

jobType - The type of the Job

jobName - A human readable name of the Job

description - A human readable description of the Job.

fixedDelay - The delay duration between to executions of the Job

maxAge - Maximum age of the latest job after that we want to get a warning

retries - Specifies how often a job trigger should retry to start the job if triggering fails for some reason.

retryDelay - The optional delay between retries.

Returns:

JobDefinition

jobType

public java.lang.String jobType()

The type of the job that is specified by this JobDefinition.

Only one JobDefinition per type is supported.

Specified by:

jobType in interface JobDefinition

Returns:

job type

jobName

public java.lang.String jobName()

A human-readable name of the job.

Specified by:

jobName in interface JobDefinition

Returns:

job name

description

public java.lang.String description()

A human-readable description of the job.

Specified by:

description in interface JobDefinition

Returns:

job description

maxAge

public java.util.Optional<java.time.Duration> maxAge()

Specified by:

maxAge in interface JobDefinition

fixedDelay

public java.util.Optional<java.time.Duration> fixedDelay()

Optional fixed delay after that a job is triggered again.

Specified by:

fixedDelay in interface JobDefinition

Returns:

optional fixed delay

cron

public java.util.Optional<java.lang.String> cron()

Optional cron expression used to specify when a job should be triggered.

Specified by:

cron in interface JobDefinition

Returns:

optional cron expression

retries

public int retries()

Number of retries when starting a job is failing for some reason.

Specified by:

retries in interface JobDefinition

Returns:

number of retries

retryDelay

public java.util.Optional<java.time.Duration> retryDelay()

The duration after that a retry should be scheduled.

Specified by:

retryDelay in interface JobDefinition

Returns:

optional delay before retrying