Package org.sterl.spring.persistent_tasks

Class PersistentTaskService

java.lang.Object

org.sterl.spring.persistent_tasks.PersistentTaskService

@Service
public class PersistentTaskService
extends Object

Abstraction to SchedulerService or TriggerService depends on if the SchedulerService is available.

Constructor Summary

Constructors

Constructor	Description
PersistentTaskService()

Method Summary

Modifier and Type	Method	Description
List<TriggerEntity>	findAllTriggerByCorrelationId(String correlationId)	Returns all triggers for a correlationId sorted by the creation time.
Optional<TriggerEntity>	findLastTriggerByCorrelationId(String correlationId)
Optional<HasTrigger>	getLastTriggerData(TriggerKey key)	Returns the last known TriggerEntity to a given key.
Optional<HistoryTriggerEntity>	getLastTriggerHistory(Long id)
<T extends Serializable> List<TriggerKey>	queue(Collection<TriggerRequest<T>> triggers)	Queues/updates the given triggers, if the TriggerKey is already present
<T extends Serializable> TriggerKey	queue(TriggerRequest<T> trigger)	Queues/updates the given trigger, if the TriggerKey is already present.
boolean	register(CronTriggerEntity<? extends Serializable> cron)	Adds a CronTriggerEntity for recurring tasks.
<T extends Serializable> TriggerKey	runOrQueue(TriggerRequest<T> triggerRequest)	Runs the given trigger if a free threads are available and the runAt time is not in the future.

Methods inherited from class java.lang.Object

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

Constructor Details

PersistentTaskService

public PersistentTaskService()

Method Details

getLastTriggerData

public Optional<HasTrigger> getLastTriggerData(TriggerKey key)

Returns the last known TriggerEntity to a given key. First running triggers are checked. Maybe out of the history event from a retry execution of the very same id.

Parameters:

key - the TriggerKey to look for

Returns:

the TriggerEntity to the TriggerKey

queue

@Transactional(timeout=10)
@NonNull
public <T extends Serializable> List<TriggerKey> queue(Collection<TriggerRequest<T>> triggers)

Queues/updates the given triggers, if the TriggerKey is already present

Type Parameters:

T - the state type

Parameters:

triggers - the triggers to add

Returns:

the TriggerKey

queue

@Transactional(timeout=5)
@NonNull
public <T extends Serializable> TriggerKey queue(TriggerRequest<T> trigger)

Queues/updates the given trigger, if the TriggerKey is already present.

Type Parameters:

T - the state type

Parameters:

trigger - the trigger to add

Returns:

the TriggerKey

runOrQueue

public <T extends Serializable> TriggerKey runOrQueue(TriggerRequest<T> triggerRequest)

Runs the given trigger if a free threads are available and the runAt time is not in the future.

Returns:

the reference to the TriggerKey

findAllTriggerByCorrelationId

@Transactional(readOnly=true,
               timeout=5)
public List<TriggerEntity> findAllTriggerByCorrelationId(String correlationId)

Returns all triggers for a correlationId sorted by the creation time. Data is limited to overall 300 elements.

Parameters:

correlationId - the id to search for

Returns:

the found TriggerEntity sorted by create time ASC

findLastTriggerByCorrelationId

@Transactional(readOnly=true,
               timeout=5)
public Optional<TriggerEntity> findLastTriggerByCorrelationId(String correlationId)

getLastTriggerHistory

public Optional<HistoryTriggerEntity> getLastTriggerHistory(Long id)

register

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