org.axonframework.deadline

Class SimpleDeadlineManager

java.lang.Object

org.axonframework.deadline.AbstractDeadlineManager

org.axonframework.deadline.SimpleDeadlineManager

All Implemented Interfaces:

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

public class SimpleDeadlineManager
extends AbstractDeadlineManager
implements Lifecycle

Implementation of DeadlineManager which uses Java's ScheduledExecutorService as scheduling and triggering mechanism.

Note that this mechanism is non-persistent. Scheduled tasks will be lost then the JVM is shut down, unless special measures have been taken to prevent that. For more flexible and powerful scheduling options, see QuartzDeadlineManager.

Since:

3.3

Author:

Milan Savic, Steven van Beelen

Nested Class Summary

Nested Classes

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

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

Lifecycle.LifecycleHandler, Lifecycle.LifecycleRegistry

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleDeadlineManager(SimpleDeadlineManager.Builder builder) Instantiate a SimpleDeadlineManager based on the fields contained in the SimpleDeadlineManager.Builder to handle the process around scheduling and triggering a DeadlineMessage.

Method Summary

Modifier and Type	Method and Description
static SimpleDeadlineManager.Builder	builder() Instantiate a Builder to be able to create a SimpleDeadlineManager.
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.
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.

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

SimpleDeadlineManager

protected SimpleDeadlineManager(SimpleDeadlineManager.Builder builder)

Instantiate a SimpleDeadlineManager based on the fields contained in the SimpleDeadlineManager.Builder to handle the process around scheduling and triggering a DeadlineMessage.

Will assert that the ScopeAwareProvider, ScheduledExecutorService and TransactionManager are not null, and will throw an AxonConfigurationException if either of them is null.

Parameters:

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

Method Detail

builder

public static SimpleDeadlineManager.Builder builder()

Instantiate a Builder to be able to create a SimpleDeadlineManager.

The ScheduledExecutorService is defaulted to an Executors.newSingleThreadScheduledExecutor() which contains an AxonThreadFactory, the TransactionManager defaults to a NoTransactionManager, and the DeadlineManagerSpanFactory is defaulted to a DefaultDeadlineManagerSpanFactory backed by a NoOpSpanFactory. The ScopeAwareProvider is a hard requirement and as such should be provided.

Returns:

a Builder to be able to create a SimpleDeadlineManager

schedule

public String schedule(@Nonnull
                       Instant triggerDateTime,
                       @Nonnull
                       String deadlineName,
                       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

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

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)

shutdown

public void shutdown()

Description copied from interface: DeadlineManager

Shuts down this deadline manager.

Specified by:

shutdown in interface DeadlineManager