org.axonframework.deadline.dbscheduler

Class DbSchedulerDeadlineManager

java.lang.Object

org.axonframework.deadline.AbstractDeadlineManager

org.axonframework.deadline.dbscheduler.DbSchedulerDeadlineManager

All Implemented Interfaces:

DeadlineManager, Lifecycle, MessageDispatchInterceptorSupport<DeadlineMessage<?>>, MessageHandlerInterceptorSupport<DeadlineMessage<?>>

public class DbSchedulerDeadlineManager
extends AbstractDeadlineManager
implements Lifecycle

Implementation of DeadlineManager 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	DbSchedulerDeadlineManager.Builder Builder class to instantiate a DbSchedulerDeadlineManager.

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

Lifecycle.LifecycleHandler, Lifecycle.LifecycleRegistry

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static com.github.kagkarlsson.scheduler.task.Task<DbSchedulerBinaryDeadlineDetails>	binaryTask(Supplier<DbSchedulerDeadlineManager> deadlineManagerSupplier) Gives the Task using DbSchedulerBinaryDeadlineDetails to execute a deadline via a Scheduler.
static DbSchedulerDeadlineManager.Builder	builder() Instantiate a Builder to be able to create a DbSchedulerDeadlineManager.
void	cancelAll(String deadlineName) Cancels all the deadlines corresponding to the given deadlineName.
void	cancelAllWithinScope(String deadlineName, ScopeDescriptor scope) Cancels all deadlines corresponding to the given deadlineName and scope.
void	cancelSchedule(String deadlineName, String scheduleId) Cancels the deadline corresponding to the given deadlineName / scheduleId combination.
static com.github.kagkarlsson.scheduler.task.Task<DbSchedulerHumanReadableDeadlineDetails>	humanReadableTask(Supplier<DbSchedulerDeadlineManager> deadlineManagerSupplier) Gives the Task using DbSchedulerHumanReadableDeadlineDetails to execute a deadline via a Scheduler.
void	registerLifecycleHandlers(Lifecycle.LifecycleRegistry lifecycle) Registers the activities to be executed in the various phases of an application's lifecycle.
String	schedule(Instant triggerDateTime, String deadlineName, Object messageOrPayload, ScopeDescriptor deadlineScope) Schedules a deadline at given triggerDateTime with provided context.
void	shutdown() Shuts down this deadline manager.
void	start() Will start the Scheduler depending on its current state and the value of startScheduler,

Methods inherited from class org.axonframework.deadline.AbstractDeadlineManager

dispatchInterceptors, handlerInterceptors, processDispatchInterceptors, registerDispatchInterceptor, registerHandlerInterceptor, runOnPrepareCommitOrNow

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.deadline.DeadlineManager

cancelAllWithinScope, schedule, schedule, schedule, schedule, schedule

Constructor Detail

DbSchedulerDeadlineManager

protected DbSchedulerDeadlineManager(DbSchedulerDeadlineManager.Builder builder)

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

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

Parameters:

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

Method Detail

builder

public static DbSchedulerDeadlineManager.Builder builder()

Instantiate a Builder to be able to create a DbSchedulerDeadlineManager.

The TransactionManager is defaulted to a NoTransactionManager.

The DeadlineManagerSpanFactory is defaulted to a DefaultDeadlineManagerSpanFactory backed by a NoOpSpanFactory.

The useBinaryPojo and startScheduler are defaulted to true.

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

Returns:

a Builder to be able to create a DbSchedulerDeadlineManager

schedule

public String schedule(@Nonnull
                       Instant triggerDateTime,
                       @Nonnull
                       String deadlineName,
                       @Nullable
                       Object messageOrPayload,
                       @Nonnull
                       ScopeDescriptor deadlineScope)

Description copied from interface: DeadlineManager

Schedules a deadline at given triggerDateTime with provided context. The returned scheduleId and provided deadlineName combination can be used to cancel the scheduled deadline.

The given messageOrPayload may be any object, as well as a DeadlineMessage. In the latter case, the instance provided is the donor for the payload and MetaData of the actual deadline being used. In the former case, the given messageOrPayload will be wrapped as the payload of a DeadlineMessage.

Specified by:

schedule in interface DeadlineManager

Parameters:

triggerDateTime - A Instant denoting the moment to trigger the deadline handling

deadlineName - A String representing the name of the deadline to schedule

messageOrPayload - A Message or payload for a message as an Object

deadlineScope - A ScopeDescriptor describing the scope within which the deadline was scheduled

Returns:

the scheduleId as a String to use when cancelling the schedule

binaryTask

public static com.github.kagkarlsson.scheduler.task.Task<DbSchedulerBinaryDeadlineDetails> binaryTask(Supplier<DbSchedulerDeadlineManager> deadlineManagerSupplier)

Gives the Task using DbSchedulerBinaryDeadlineDetails to execute a deadline via a Scheduler. To be able to execute the task, this should be added to the task list, used to create the scheduler.

Parameters:

deadlineManagerSupplier - a Supplier of a DbSchedulerDeadlineManager. Preferably a method involving dependency injection is used. When those are not available the DbSchedulerDeadlineManagerSupplier can be used instead.

Returns:

a Task to execute a deadline

humanReadableTask

public static com.github.kagkarlsson.scheduler.task.Task<DbSchedulerHumanReadableDeadlineDetails> humanReadableTask(Supplier<DbSchedulerDeadlineManager> deadlineManagerSupplier)

Gives the Task using DbSchedulerHumanReadableDeadlineDetails to execute a deadline via a Scheduler. To be able to execute the task, this should be added to the task list, used to create the scheduler.

Parameters:

deadlineManagerSupplier - a Supplier of a DbSchedulerDeadlineManager. Preferably a method involving dependency injection is used. When those are not available the DbSchedulerDeadlineManagerSupplier can be used instead.

Returns:

a Task to execute a deadline

cancelSchedule

public void cancelSchedule(@Nonnull
                           String deadlineName,
                           @Nonnull
                           String scheduleId)

Description copied from interface: DeadlineManager

Cancels the deadline corresponding to the given deadlineName / scheduleId combination. This method has no impact on deadlines which have already been triggered.

Specified by:

cancelSchedule in interface DeadlineManager

Parameters:

deadlineName - a String representing the name of the deadline to cancel

scheduleId - the String denoting the scheduled deadline to cancel

cancelAll

public void cancelAll(@Nonnull
                      String deadlineName)

Description copied from interface: DeadlineManager

Cancels all the deadlines corresponding to the given deadlineName. This method has no impact on deadlines which have already been triggered.

Specified by:

cancelAll in interface DeadlineManager

Parameters:

deadlineName - a String representing the name of the deadlines to cancel

cancelAllWithinScope

public void cancelAllWithinScope(@Nonnull
                                 String deadlineName,
                                 @Nonnull
                                 ScopeDescriptor scope)

Description copied from interface: DeadlineManager

Cancels all deadlines corresponding to the given deadlineName and scope. This method has no impact on deadlines which have already been triggered.

Specified by:

cancelAllWithinScope in interface DeadlineManager

Parameters:

deadlineName - a String representing the name of the deadlines to cancel

scope - a ScopeDescriptor describing the scope within which the deadline 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: DeadlineManager

Shuts down this deadline manager.

Specified by:

shutdown in interface DeadlineManager

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)