org.axonframework.eventhandling.scheduling.dbscheduler

Class DbSchedulerEventScheduler

java.lang.Object

org.axonframework.eventhandling.scheduling.dbscheduler.DbSchedulerEventScheduler

All Implemented Interfaces:

EventScheduler, Lifecycle

public class DbSchedulerEventScheduler
extends Object
implements EventScheduler, Lifecycle

EventScheduler implementation that delegates scheduling and triggering to a db-scheduler Scheduler.

Since:

4.8.0

Author:

Gerard Klijs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbSchedulerEventScheduler.Builder Builder class to instantiate a DbSchedulerEventScheduler.

Nested classes/interfaces inherited from interface org.axonframework.lifecycle.Lifecycle

Lifecycle.LifecycleHandler, Lifecycle.LifecycleRegistry

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DbSchedulerEventScheduler(DbSchedulerEventScheduler.Builder builder) Instantiate a DbSchedulerEventScheduler based on the fields contained in the DbSchedulerEventScheduler.Builder.

Method Summary

Modifier and Type	Method and Description
static com.github.kagkarlsson.scheduler.task.Task<DbSchedulerBinaryEventData>	binaryTask(Supplier<DbSchedulerEventScheduler> eventSchedulerSupplier) Gives the Task using DbSchedulerHumanReadableEventData to publish an event via a Scheduler.
static DbSchedulerEventScheduler.Builder	builder() Instantiate a Builder to be able to create a DbSchedulerEventScheduler.
void	cancelSchedule(ScheduleToken scheduleToken) Cancel the publication of a scheduled event.
static com.github.kagkarlsson.scheduler.task.Task<DbSchedulerHumanReadableEventData>	humanReadableTask(Supplier<DbSchedulerEventScheduler> eventSchedulerSupplier) Gives the Task using DbSchedulerBinaryEventData to publish an event via a Scheduler.
void	registerLifecycleHandlers(Lifecycle.LifecycleRegistry lifecycle) Registers the activities to be executed in the various phases of an application's lifecycle.
ScheduleToken	schedule(Duration triggerDuration, Object event) Schedule the given event for publication after the given triggerDuration.
ScheduleToken	schedule(Instant triggerDateTime, Object event) Schedule the given event for publication at the given triggerDateTime.
void	shutdown() Shuts down this event scheduler.
void	start() Will start the Scheduler depending on its current state and the value of startScheduler,

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.eventhandling.scheduling.EventScheduler

reschedule, reschedule

Constructor Detail

DbSchedulerEventScheduler

protected DbSchedulerEventScheduler(DbSchedulerEventScheduler.Builder builder)

Instantiate a DbSchedulerEventScheduler based on the fields contained in the DbSchedulerEventScheduler.Builder.

Will assert that the Scheduler, Serializer and EventBus are not null, and will throw an AxonConfigurationException if any of them is null.

Parameters:

builder - the DbSchedulerEventScheduler.Builder used to instantiate a DbSchedulerEventScheduler instance

Method Detail

builder

public static DbSchedulerEventScheduler.Builder builder()

Instantiate a Builder to be able to create a DbSchedulerEventScheduler.

The TransactionManager is defaulted to a NoTransactionManager. The useBinaryPojo is defaulted to true.

The Scheduler, Serializer and EventBus are hard requirements and as such should be provided.

Returns:

a Builder to be able to create a DbSchedulerEventScheduler

schedule

public ScheduleToken schedule(Instant triggerDateTime,
                              Object event)

Description copied from interface: EventScheduler

Schedule the given event for publication at the given triggerDateTime. The returned ScheduleToken can be used to cancel the planned publication.

The given event may be any object, as well as an EventMessage. In the latter case, the instance provided is the donor for the payload and Meta Data of the actual message being dispatched. In the former case, the given event will be wrapped as the payload of an EventMessage.

Specified by:

schedule in interface EventScheduler

Parameters:

triggerDateTime - The moment to trigger publication of the event

event - The event to publish

Returns:

the token to use when cancelling the schedule

humanReadableTask

public static com.github.kagkarlsson.scheduler.task.Task<DbSchedulerHumanReadableEventData> humanReadableTask(Supplier<DbSchedulerEventScheduler> eventSchedulerSupplier)

Gives the Task using DbSchedulerBinaryEventData to publish an event via a Scheduler. To be able to execute the task, this should be added to the task list, used to create the scheduler.

Parameters:

eventSchedulerSupplier - a Supplier of a DbSchedulerEventScheduler. Preferably a method involving dependency injection is used. When those are not available the DbSchedulerEventSchedulerSupplier can be used instead.

Returns:

a Task to publish an event

binaryTask

public static com.github.kagkarlsson.scheduler.task.Task<DbSchedulerBinaryEventData> binaryTask(Supplier<DbSchedulerEventScheduler> eventSchedulerSupplier)

Gives the Task using DbSchedulerHumanReadableEventData to publish an event via a Scheduler. To be able to execute the task, this should be added to the task list, used to create the scheduler.

Parameters:

eventSchedulerSupplier - a Supplier of a DbSchedulerEventScheduler. Preferably a method involving dependency injection is used. When those are not available the DbSchedulerEventSchedulerSupplier can be used instead.

Returns:

a Task to publish an event

schedule

public ScheduleToken schedule(Duration triggerDuration,
                              Object event)

Description copied from interface: EventScheduler

Schedule the given event for publication after the given triggerDuration. The returned ScheduleToken can be used to cancel the planned publication.

The given event may be any object, as well as an EventMessage. In the latter case, the instance provided is the donor for the payload and Meta Data of the actual message being dispatched. In the former case, the given event will be wrapped as the payload of an EventMessage.

Specified by:

schedule in interface EventScheduler

Parameters:

triggerDuration - The amount of time to wait before publishing the event

event - The event to publish

Returns:

the token to use when cancelling the schedule

cancelSchedule

public void cancelSchedule(ScheduleToken scheduleToken)

Description copied from interface: EventScheduler

Cancel the publication of a scheduled event. If the events has already been published, this method does nothing.

Specified by:

cancelSchedule in interface EventScheduler

Parameters:

scheduleToken - the token returned when the event was scheduled

start

public void start()

Will start the Scheduler depending on its current state and the value of startScheduler,

shutdown

public void shutdown()

Description copied from interface: EventScheduler

Shuts down this event scheduler.

Specified by:

shutdown in interface EventScheduler

registerLifecycleHandlers

public void registerLifecycleHandlers(@Nonnull
                                      Lifecycle.LifecycleRegistry lifecycle)

Description copied from interface: Lifecycle

Registers the activities to be executed in the various phases of an application's lifecycle. This could either be at startup, shutdown, or both.

Specified by:

registerLifecycleHandlers in interface Lifecycle

Parameters:

lifecycle - the lifecycle instance to register the handlers with

See Also:

Lifecycle.LifecycleRegistry.onShutdown(int, Runnable), LifecycleRegistry#onShutdown(int, LifecycleHandler), Lifecycle.LifecycleRegistry.onStart(int, Runnable), LifecycleRegistry#onStart(int, LifecycleHandler)