org.graylog.scheduler

Class DBJobTriggerService

java.lang.Object

org.graylog.scheduler.DBJobTriggerService

public class DBJobTriggerService
extends Object

Constructor Summary

Constructors

Constructor and Description
DBJobTriggerService(MongoConnection mongoConnection, MongoJackObjectMapperProvider mapper, NodeId nodeId, JobSchedulerClock clock)

Method Summary

Modifier and Type	Method and Description
List<JobTriggerDto>	all() Loads all existing records and returns them.
JobTriggerDto	create(JobTriggerDto trigger) Creates a new record in the database.
boolean	delete(String triggerId) Deletes the trigger with the given ID.
int	deleteCompletedOnceSchedulesOlderThan(long timeValue, TimeUnit unit) Deletes completed OnceJobSchedule triggers that are older than the provided time
int	forceReleaseOwnedTriggers() WARNING: This should only be called before the job scheduler is started! Calling this while the scheduler is running might result in data corruption or inconsistencies!
Optional<JobTriggerDto>	get(String id) Loads the record for the given ID.
List<JobTriggerDto>	getForJob(String jobDefinitionId) Returns all job triggers for the given job definition ID.
Map<String,List<JobTriggerDto>>	getForJobs(Collection<String> jobDefinitionIds) Returns all job triggers for the given job definition IDs, grouped by job definition ID.
Optional<JobTriggerDto>	nextRunnableTrigger() Locks and returns the next runnable trigger.
boolean	releaseTrigger(JobTriggerDto trigger, JobTriggerUpdate triggerUpdate) Releases a locked trigger.
boolean	setTriggerError(JobTriggerDto trigger) Mark the given trigger as defective to make sure it will not be scheduled anymore.
boolean	update(JobTriggerDto trigger) Updates the given trigger record in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBJobTriggerService

@Inject
public DBJobTriggerService(MongoConnection mongoConnection,
                                   MongoJackObjectMapperProvider mapper,
                                   NodeId nodeId,
                                   JobSchedulerClock clock)

Method Detail

all

public List<JobTriggerDto> all()

Loads all existing records and returns them.

Returns:

list of records

get

public Optional<JobTriggerDto> get(String id)

Loads the record for the given ID.

Parameters:

id - record ID to load

Returns:

filled optional when the record exists, an empty optional otherwise

getForJob

public List<JobTriggerDto> getForJob(String jobDefinitionId)

Returns all job triggers for the given job definition ID. TODO: Don't throw exception when there is more than one trigger for a job definition. (see source code)

Parameters:

jobDefinitionId - the job definition ID

Returns:

list of found job triggers

getForJobs

public Map<String,List<JobTriggerDto>> getForJobs(Collection<String> jobDefinitionIds)

Returns all job triggers for the given job definition IDs, grouped by job definition ID. TODO: Don't throw exception when there is more than one trigger for a job definition. (see source code)

Parameters:

jobDefinitionIds - the job definition IDs

Returns:

list of found job triggers

create

public JobTriggerDto create(JobTriggerDto trigger)

Creates a new record in the database. The given JobTriggerDto object must not have an ID to make sure a new record is created.

Parameters:

trigger - the new trigger object (without an ID set)

Returns:

the newly created trigger object

Throws:

IllegalArgumentException - if the passed trigger has an ID set

update

public boolean update(JobTriggerDto trigger)

Updates the given trigger record in the database. This method takes care of not overwriting any locks and state data with the update.

Parameters:

trigger - the trigger to update

Returns:

true when the update was successful, false otherwise

Throws:

IllegalArgumentException - if the passed trigger doesn't have an ID set

delete

public boolean delete(String triggerId)

Deletes the trigger with the given ID.

Parameters:

triggerId - the trigger ID to delete

Returns:

true if the trigger got deleted, false otherwise

deleteCompletedOnceSchedulesOlderThan

public int deleteCompletedOnceSchedulesOlderThan(long timeValue,
                                                 TimeUnit unit)

Deletes completed OnceJobSchedule triggers that are older than the provided time

Parameters:

timeValue - the time range of triggers to be removed

unit - the unit of the provided timeValue

Returns:

the number of deleted triggers

nextRunnableTrigger

public Optional<JobTriggerDto> nextRunnableTrigger()

Locks and returns the next runnable trigger. The caller needs to take care of releasing the trigger lock.

Returns:

next runnable trigger if any exists, an empty Optional otherwise

releaseTrigger

public boolean releaseTrigger(JobTriggerDto trigger,
                              JobTriggerUpdate triggerUpdate)

Releases a locked trigger. The trigger is only released if it's owned by the calling node.

Parameters:

trigger - trigger that should be released

triggerUpdate - update to apply to the trigger

Returns:

true if the trigger has been modified, false otherwise

forceReleaseOwnedTriggers

public int forceReleaseOwnedTriggers()

WARNING: This should only be called before the job scheduler is started! Calling this while the scheduler is running might result in data corruption or inconsistencies!

This method will release all triggers that are locked by the calling node. It should be called before starting the scheduler service on the current node to release all triggers that might be in a stale RUNNING status after an unclean JVM or Graylog server shutdown.

Returns:

number of released triggers

setTriggerError

public boolean setTriggerError(JobTriggerDto trigger)

Mark the given trigger as defective to make sure it will not be scheduled anymore.

Parameters:

trigger - trigger that should be marked as defective

Returns:

true if the trigger has been modified, false otherwise