org.axonframework.deadline.quartz

Class QuartzDeadlineManager

java.lang.Object

org.axonframework.deadline.AbstractDeadlineManager

org.axonframework.deadline.quartz.QuartzDeadlineManager

All Implemented Interfaces:

DeadlineManager

public class QuartzDeadlineManager
extends AbstractDeadlineManager

Implementation of DeadlineManager that delegates scheduling and triggering to a Quartz Scheduler.

Since:

3.3

Author:

Milan Savic, Steven van Beelen

Constructor Summary

Constructors

Constructor and Description
QuartzDeadlineManager(org.quartz.Scheduler scheduler, ScopeAwareProvider scopeAwareProvider) Initializes QuartzDeadlineManager with given scheduler and scopeAwareProvider which will load and send messages to Scope implementing components.
QuartzDeadlineManager(org.quartz.Scheduler scheduler, ScopeAwareProvider scopeAwareProvider, TransactionManager transactionManager) Initializes QuartzDeadlineManager with given scheduler and scopeAwareProvider which will load and send messages to Scope implementing components.
QuartzDeadlineManager(org.quartz.Scheduler scheduler, ScopeAwareProvider scopeAwareProvider, TransactionManager transactionManager, Serializer serializer) Initializes QuartzDeadlineManager with given scheduler 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.
String	generateScheduleId() Generates a String schedule id.
void	schedule(Duration triggerDuration, String deadlineName, Object messageOrPayload, ScopeDescriptor deadlineScope, String scheduleId) Schedules a deadline after the given triggerDuration with provided context.
void	schedule(Instant triggerDateTime, String deadlineName, Object messageOrPayload, ScopeDescriptor deadlineScope, String scheduleId) Schedules a deadline at given triggerDateTime 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

schedule, schedule, schedule, schedule, schedule, schedule

Constructor Detail

QuartzDeadlineManager

public QuartzDeadlineManager(org.quartz.Scheduler scheduler,
                             ScopeAwareProvider scopeAwareProvider)

Initializes QuartzDeadlineManager with given scheduler and scopeAwareProvider which will load and send messages to Scope implementing components. A NoTransactionManager will be used as the transaction manager and the XStreamSerializer for serializing the JobDataMap contents.

Parameters:

scheduler - A Scheduler used for scheduling and triggering purposes

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

QuartzDeadlineManager

public QuartzDeadlineManager(org.quartz.Scheduler scheduler,
                             ScopeAwareProvider scopeAwareProvider,
                             TransactionManager transactionManager)

Initializes QuartzDeadlineManager with given scheduler and scopeAwareProvider which will load and send messages to Scope implementing components. Uses the XStreamSerializer for serializing the deadline message and scope in to the JobDataMap.

Parameters:

scheduler - A Scheduler used for scheduling and triggering purposes

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

transactionManager - A TransactionManager which builds transactions and ties them to deadline

QuartzDeadlineManager

public QuartzDeadlineManager(org.quartz.Scheduler scheduler,
                             ScopeAwareProvider scopeAwareProvider,
                             TransactionManager transactionManager,
                             Serializer serializer)

Initializes QuartzDeadlineManager with given scheduler and scopeAwareProvider which will load and send messages to Scope implementing components. Uses the given serializer for serializing the deadline message and scope in to the JobDataMap.

Parameters:

scheduler - A Scheduler used for scheduling and triggering purposes

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

transactionManager - A TransactionManager which builds transactions and ties them to deadline

serializer - The Serializer which will be used to de-/serialize the DeadlineMessage and the ScopeDescriptor into the JobDataMap

Method Detail

schedule

public void schedule(Instant triggerDateTime,
                     String deadlineName,
                     Object messageOrPayload,
                     ScopeDescriptor deadlineScope,
                     String scheduleId)

Description copied from interface: DeadlineManager

Schedules a deadline at given triggerDateTime 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:

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

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

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

generateScheduleId

public String generateScheduleId()

Description copied from interface: DeadlineManager

Generates a String schedule id.

Returns:

a String schedule id

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