org.graylog.scheduler.schedule

Class IntervalJobSchedule

java.lang.Object

org.graylog.scheduler.schedule.IntervalJobSchedule

All Implemented Interfaces:

JobSchedule

public abstract class IntervalJobSchedule
extends Object
implements JobSchedule

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntervalJobSchedule.Builder

Nested classes/interfaces inherited from interface org.graylog.scheduler.JobSchedule

JobSchedule.FallbackSchedule

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_INTERVAL
static String	FIELD_UNIT
static String	TYPE_NAME

Fields inherited from interface org.graylog.scheduler.JobSchedule

TYPE_FIELD

Constructor Summary

Constructors

Constructor and Description
IntervalJobSchedule()

Method Summary

Modifier and Type	Method and Description
static IntervalJobSchedule.Builder	builder()
Optional<org.joda.time.DateTime>	calculateNextTime(org.joda.time.DateTime lastExecutionTime, org.joda.time.DateTime lastNextTime) Calculates the next time a job should be executed based on the schedule implementation.
abstract @Min(value=1L) long	interval()
abstract IntervalJobSchedule.Builder	toBuilder()
Optional<Map<String,Object>>	toDBUpdate(String fieldPrefix) Returns a map with the schedule data.
abstract TimeUnit	unit()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graylog.scheduler.JobSchedule

type

Field Detail

TYPE_NAME

public static final String TYPE_NAME

See Also:

Constant Field Values

FIELD_INTERVAL

public static final String FIELD_INTERVAL

See Also:

Constant Field Values

FIELD_UNIT

public static final String FIELD_UNIT

See Also:

Constant Field Values

Constructor Detail

IntervalJobSchedule

public IntervalJobSchedule()

Method Detail

interval

@Min(value=1L)
public abstract @Min(value=1L) long interval()

unit

public abstract TimeUnit unit()

calculateNextTime

public Optional<org.joda.time.DateTime> calculateNextTime(org.joda.time.DateTime lastExecutionTime,
                                                          org.joda.time.DateTime lastNextTime)

Description copied from interface: JobSchedule

Calculates the next time a job should be executed based on the schedule implementation. If this returns an empty Optional, there will be no next execution time. (e.g. for one-off jobs)

The lastExecutionTime parameter is the last execution time of the trigger. This can be used to detect if the trigger has been executed way later than the lastNextTime.

The lastNextTime parameter is the last nextTime of the job trigger. This can be used to calculate the new next time. Using the previous nextTime as base for the new one is more accurate than using the current time. (e.g. because of delayed execution and job duration)

Specified by:

calculateNextTime in interface JobSchedule

Parameters:

lastExecutionTime - the last execution time of a trigger

lastNextTime - the base time, chosen by the caller (mostly last nextTime)

Returns:

filled optional with the next execution time, empty optional if there is no next execution time

toDBUpdate

public Optional<Map<String,Object>> toDBUpdate(String fieldPrefix)

Description copied from interface: JobSchedule

Returns a map with the schedule data. This can be used to update a MongoDB document with schedule data. (see JacksonDBCollection#update())

Specified by:

toDBUpdate in interface JobSchedule

Parameters:

fieldPrefix - the field prefix to use for the map key

Returns:

filled optional with a map, empty optional if there is no update data

builder

public static IntervalJobSchedule.Builder builder()

toBuilder

public abstract IntervalJobSchedule.Builder toBuilder()