Package org.sterl.spring.persistent_tasks.trigger

Class TriggerService

java.lang.Object

org.sterl.spring.persistent_tasks.trigger.TriggerService

@TransactionalService
public class TriggerService
extends Object

Manages QuartzEndpoint.QuartzTriggerGroupSummaryDescriptor.Triggers to Tasks and the data.

Constructor Summary

Constructors

Constructor	Description
TriggerService()

Method Summary

Modifier and Type	Method	Description
List<RunningTriggerEntity>	cancel(Collection<TriggerKey> key)
Optional<RunningTriggerEntity>	cancel(TriggerKey key)	If you changed your mind, cancel the persistentTask
long	countTriggers()
long	countTriggers(TaskId<?> taskId)	Counts the trigger using the name only from the TaskId
long	countTriggers(TriggerStatus status)
Collection<CronTriggerEntity<? extends Serializable>>	cronTriggers()
void	deleteAll()
List<RunningTriggerEntity>	expireTimeoutTriggers()
org.springframework.data.domain.Page<RunningTriggerEntity>	findAllTriggers(TaskId<?> task, org.springframework.data.domain.Pageable page)
Optional<RunningTriggerEntity>	get(TriggerKey triggerKey)
boolean	hasPendingTriggers()	Checks if any job is still running or waiting for it's execution.
RunningTriggerEntity	lockNextTrigger(String runOn)
List<RunningTriggerEntity>	lockNextTrigger(String runOn, int count, OffsetDateTime timeDueAt)
int	markTriggersAsRunning(Collection<TriggerKey> keys, String runOn)
RunningTriggerEntity	markTriggersAsRunning(RunningTriggerEntity trigger, String runOn)
<T extends Serializable> RunningTriggerEntity	queue(TriggerRequest<T> tigger)	Adds or updates an existing trigger based on its TriggerKey
int	queueCronTrigger()
boolean	register(CronTrigger cronAnnotation, TaskId<?> taskId)
boolean	register(CronTriggerEntity<? extends Serializable> cron)	Adds a CronTriggerEntity for recurring tasks.
List<RunningTriggerEntity>	rescheduleAbandoned(OffsetDateTime timeout)	Marks any tasks which are not on the given executors/schedulers abandoned for .
org.springframework.data.domain.Page<RunningTriggerEntity>	resume(TriggerRequest<?> trigger)	Will resume any found RunningTriggerEntity in state TriggerStatus.AWAITING_SIGNAL
boolean	resumeCron(TriggerKey triggerKey)
<T extends Serializable> Optional<RunningTriggerEntity>	resumeOne(TriggerSearch search, Function<T,T> stateModifier)	Will resume first found RunningTriggerEntity in state TriggerStatus.AWAITING_SIGNAL with the given search.
Optional<RunningTriggerEntity>	run(TriggerKey triggerKey, String runningOn)	The main purpose of this method is to simplify testing and run just one trigger.
Optional<RunningTriggerEntity>	run(TriggerRequest<?> request, String runningOn)
Optional<RunningTriggerEntity>	run(RunningTriggerEntity trigger)	Executes the given trigger directly in the current thread and handle any errors etc.
org.springframework.data.domain.Page<TriggerGroup>	searchGroupedTriggers(TriggerSearch search, org.springframework.data.domain.Pageable page)
org.springframework.data.domain.Page<RunningTriggerEntity>	searchTriggers(TriggerSearch search, org.springframework.data.domain.Pageable page)
boolean	suspendCron(TriggerKey triggerKey)
Optional<RunningTriggerEntity>	updateRunAt(TriggerKey key, OffsetDateTime time)

Methods inherited from class java.lang.Object

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

Constructor Details

TriggerService

public TriggerService()

Method Details

run

@Transactional(propagation=NEVER)
public Optional<RunningTriggerEntity> run(@Nullable
 RunningTriggerEntity trigger)

Executes the given trigger directly in the current thread and handle any errors etc.

Parameters:

trigger - the RunningTriggerEntity to run

Returns:

the reference to the found an executed RunningTriggerEntity

run

@Transactional(propagation=NEVER)
public Optional<RunningTriggerEntity> run(TriggerKey triggerKey,
 String runningOn)

The main purpose of this method is to simplify testing and run just one trigger.

Parameters:

triggerKey - the key to trigger which should be executed

runningOn - just any string, could be test for testing, usually the scheduler name

Returns:

the reference to the found an executed RunningTriggerEntity

run

@Transactional(propagation=NEVER)
public Optional<RunningTriggerEntity> run(@Nullable
 TriggerRequest<?> request,
 String runningOn)

markTriggersAsRunning

public RunningTriggerEntity markTriggersAsRunning(RunningTriggerEntity trigger,
 String runOn)

markTriggersAsRunning

public int markTriggersAsRunning(Collection<TriggerKey> keys,
 String runOn)

lockNextTrigger

public RunningTriggerEntity lockNextTrigger(String runOn)

lockNextTrigger

public List<RunningTriggerEntity> lockNextTrigger(String runOn,
 int count,
 OffsetDateTime timeDueAt)

get

public Optional<RunningTriggerEntity> get(TriggerKey triggerKey)

searchTriggers

@Transactional(readOnly=true,
               timeout=10)
public org.springframework.data.domain.Page<RunningTriggerEntity> searchTriggers(@Nullable
 TriggerSearch search,
 org.springframework.data.domain.Pageable page)

findAllTriggers

@Transactional(readOnly=true,
               timeout=10)
public org.springframework.data.domain.Page<RunningTriggerEntity> findAllTriggers(TaskId<?> task,
 org.springframework.data.domain.Pageable page)

searchGroupedTriggers

@Transactional(readOnly=true,
               timeout=10)
public org.springframework.data.domain.Page<TriggerGroup> searchGroupedTriggers(@Nullable
 TriggerSearch search,
 org.springframework.data.domain.Pageable page)

deleteAll

public void deleteAll()

hasPendingTriggers

@Transactional(readOnly=true,
               timeout=5)
public boolean hasPendingTriggers()

Checks if any job is still running or waiting for it's execution.

queue

public <T extends Serializable>
RunningTriggerEntity queue(TriggerRequest<T> tigger)

Adds or updates an existing trigger based on its TriggerKey

Type Parameters:

T - the state type

Parameters:

tigger - the TriggerRequest to save

Returns:

the saved RunningTriggerEntity

Throws:

IllegalStateException - if the trigger already exists and is TriggerStatus.RUNNING

resume

public org.springframework.data.domain.Page<RunningTriggerEntity> resume(TriggerRequest<?> trigger)

Will resume any found RunningTriggerEntity in state TriggerStatus.AWAITING_SIGNAL

resumeOne

public <T extends Serializable>
Optional<RunningTriggerEntity> resumeOne(TriggerSearch search,
 Function<T,T> stateModifier)

Will resume first found RunningTriggerEntity in state TriggerStatus.AWAITING_SIGNAL with the given search.

cancel

public Optional<RunningTriggerEntity> cancel(TriggerKey key)

If you changed your mind, cancel the persistentTask

cancel

public List<RunningTriggerEntity> cancel(Collection<TriggerKey> key)

countTriggers

@Transactional(timeout=5,
               readOnly=true)
public long countTriggers(@Nullable
 TaskId<?> taskId)

Counts the trigger using the name only from the TaskId

Parameters:

taskId - to get the TaskId.name()

Returns:

the amount of stored tasks

countTriggers

public long countTriggers(@Nullable
 TriggerStatus status)

rescheduleAbandoned

public List<RunningTriggerEntity> rescheduleAbandoned(OffsetDateTime timeout)

Marks any tasks which are not on the given executors/schedulers abandoned for . Retry will be triggered based on the set strategy.

expireTimeoutTriggers

public List<RunningTriggerEntity> expireTimeoutTriggers()

countTriggers

public long countTriggers()

updateRunAt

public Optional<RunningTriggerEntity> updateRunAt(TriggerKey key,
 OffsetDateTime time)

register

@Transactional(propagation=SUPPORTS)
public boolean register(CronTriggerEntity<? extends Serializable> cron)

Adds a CronTriggerEntity for recurring tasks. It will also add the TriggerEntity if required.

Parameters:

cron - the CronTriggerEntity to manage

Returns:

true if a new TriggerEntity was created, false if one already exists

register

public boolean register(CronTrigger cronAnnotation,
 TaskId<?> taskId)

cronTriggers

public Collection<CronTriggerEntity<? extends Serializable>> cronTriggers()

suspendCron

public boolean suspendCron(TriggerKey triggerKey)

resumeCron

public boolean resumeCron(TriggerKey triggerKey)

queueCronTrigger

public int queueCronTrigger()