Package org.sterl.spring.persistent_tasks.api

Class TriggerBuilder<T extends Serializable>

java.lang.Object

org.sterl.spring.persistent_tasks.api.TriggerBuilder<T>

public class TriggerBuilder<T extends Serializable>
extends Object

Constructor Summary

Constructors

Constructor	Description
TriggerBuilder()

Method Summary

Modifier and Type	Method	Description
TriggerRequest<T>	build()
TriggerBuilder<T>	correlationId(String correlationId)	An unique ID which is taken over to a chain/set of tasks.
TriggerBuilder<T>	id(String id)	The ID of this task, same queued ids are replaced.
static <T extends Serializable> TriggerBuilder<T>	newTrigger(String name)
static <T extends Serializable> TriggerBuilder<T>	newTrigger(String name, T state)
static <T extends Serializable> TriggerBuilder<T>	newTrigger(TriggerKey key, T state)
TriggerBuilder<T>	priority(int priority)	The higher the priority the earlier this task is picked.
TriggerBuilder<T>	runAfter(Duration duration)	synonym for runAt(OffsetDateTime)
TriggerBuilder<T>	runAt(OffsetDateTime when)
TriggerBuilder<T>	state(T state)
TriggerBuilder<T>	tag(String tag)
TriggerBuilder<T>	waitForSignal(OffsetDateTime timeout)	Creates a trigger which waits for an external signal and will run into TriggerStatus.EXPIRED_SIGNAL if no signal happens.
TriggerBuilder<T>	when(OffsetDateTime when)	synonym for runAt(OffsetDateTime)

Methods inherited from class java.lang.Object

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

Constructor Details

TriggerBuilder

public TriggerBuilder()

Method Details

newTrigger

public static <T extends Serializable>
TriggerBuilder<T> newTrigger(String name)

newTrigger

public static <T extends Serializable>
TriggerBuilder<T> newTrigger(String name,
 T state)

newTrigger

public static <T extends Serializable>
TriggerBuilder<T> newTrigger(TriggerKey key,
 T state)

build

public TriggerRequest<T> build()

id

public TriggerBuilder<T> id(String id)

The ID of this task, same queued ids are replaced.

correlationId

public TriggerBuilder<T> correlationId(String correlationId)

An unique ID which is taken over to a chain/set of tasks. If task is triggered it in a task, this ID is taken over.

tag

public TriggerBuilder<T> tag(String tag)

state

public TriggerBuilder<T> state(T state)

priority

public TriggerBuilder<T> priority(int priority)

The higher the priority the earlier this task is picked. Same as JMS priority. Default is also 4, like in JMS.

Parameters:

priority - custom priority e.g. 0-9, also higher numbers are supported

Returns:

this TriggerBuilder

when

public TriggerBuilder<T> when(OffsetDateTime when)

synonym for runAt(OffsetDateTime)

runAt

public TriggerBuilder<T> runAt(OffsetDateTime when)

runAfter

public TriggerBuilder<T> runAfter(Duration duration)

synonym for runAt(OffsetDateTime)

waitForSignal

public TriggerBuilder<T> waitForSignal(OffsetDateTime timeout)

Creates a trigger which waits for an external signal and will run into TriggerStatus.EXPIRED_SIGNAL if no signal happens.