org.axonframework.deadline

Class SimpleDeadlineManager

java.lang.Object

org.axonframework.deadline.AbstractDeadlineManager

org.axonframework.deadline.SimpleDeadlineManager

All Implemented Interfaces:

DeadlineManager

public class SimpleDeadlineManager
extends AbstractDeadlineManager

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

Constructor Summary

Constructors

Constructor and Description
SimpleDeadlineManager(ScopeAwareProvider scopeAwareProvider) Initializes SimpleDeadlineManager with scopeAwareProvider which will load and send messages to Scope implementing components.
SimpleDeadlineManager(ScopeAwareProvider scopeAwareProvider, ScheduledExecutorService scheduledExecutorService, TransactionManager transactionManager) Initializes a SimpleDeadlineManager to handle the process around scheduling and triggering a DeadlineMessage
SimpleDeadlineManager(ScopeAwareProvider scopeAwareProvider, TransactionManager transactionManager) Initializes SimpleDeadlineManager with transactionManager and scopeAwareProvider which will load and send messages to Scope implementing components.

Method Summary

Modifier and Type	Method and Description
void	cancelAll(String deadlineName) Cancels all the deadlines corresponding to the given deadlineName.
void	cancelSchedule(String deadlineName, String scheduleId) Cancels the deadline corresponding to the given deadlineName / scheduleId combination.
void	schedule(Duration triggerDuration, String deadlineName, Object messageOrPayload, ScopeDescriptor deadlineScope, String scheduleId) Schedules a deadline after the given triggerDuration with provided context.

Methods inherited from class org.axonframework.deadline.AbstractDeadlineManager

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

generateScheduleId, schedule, schedule, schedule, schedule, schedule, schedule, schedule

Constructor Detail

SimpleDeadlineManager

public SimpleDeadlineManager(ScopeAwareProvider scopeAwareProvider)

Initializes SimpleDeadlineManager with scopeAwareProvider which will load and send messages to Scope implementing components. NoTransactionManager is used as transaction manager and Executors.newSingleThreadScheduledExecutor() with AxonThreadFactory is used as scheduled executor service.

Parameters:

scopeAwareProvider - a List of ScopeAware components which are able to load and send Messages to components which implement Scope

SimpleDeadlineManager

public SimpleDeadlineManager(ScopeAwareProvider scopeAwareProvider,
                             TransactionManager transactionManager)

Initializes SimpleDeadlineManager with transactionManager and scopeAwareProvider which will load and send messages to Scope implementing components. Executors.newSingleThreadScheduledExecutor() with AxonThreadFactory is used as scheduled executor service.

Parameters:

scopeAwareProvider - a List of ScopeAware components which are able to load and send Messages to components which implement Scope

transactionManager - The transaction manager used to manage transaction during processing of DeadlineMessage when deadline is not met

SimpleDeadlineManager

public SimpleDeadlineManager(ScopeAwareProvider scopeAwareProvider,
                             ScheduledExecutorService scheduledExecutorService,
                             TransactionManager transactionManager)

Initializes a SimpleDeadlineManager to handle the process around scheduling and triggering a DeadlineMessage

Parameters:

scopeAwareProvider - a List of ScopeAware components which are able to load and send Messages to components which implement Scope

scheduledExecutorService - Java's service used for scheduling and triggering deadlines

transactionManager - The transaction manager used to manage transaction during processing of DeadlineMessage when deadline is not met

Method Detail

schedule

public void schedule(Duration triggerDuration,
                     String deadlineName,
                     Object messageOrPayload,
                     ScopeDescriptor deadlineScope,
                     String scheduleId)

Description copied from interface: DeadlineManager

Schedules a deadline after the given triggerDuration with provided context. The provided deadlineName / scheduleId 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.

Scheduling a deadline with the same deadlineName and scheduleId will replace the previous schedule with the new one.

Parameters:

triggerDuration - A Duration describing the waiting period before handling the deadline

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

scheduleId - A String schedule id to use when cancelling the schedule

cancelSchedule

public void cancelSchedule(String deadlineName,
                           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.

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(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.

Parameters:

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