public class QuartzDeadlineManager extends AbstractDeadlineManager implements Lifecycle
DeadlineManager
that delegates scheduling and triggering to a Quartz Scheduler
.Modifier and Type | Class and Description |
---|---|
static class |
QuartzDeadlineManager.Builder
Builder class to instantiate a
QuartzDeadlineManager . |
Lifecycle.LifecycleHandler, Lifecycle.LifecycleRegistry
Modifier | Constructor and Description |
---|---|
protected |
QuartzDeadlineManager(QuartzDeadlineManager.Builder builder)
Instantiate a
QuartzDeadlineManager based on the fields contained in the QuartzDeadlineManager.Builder . |
Modifier and Type | Method and Description |
---|---|
static QuartzDeadlineManager.Builder |
builder()
Instantiate a Builder to be able to create a
QuartzDeadlineManager . |
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(Duration triggerDuration,
String deadlineName,
Object messageOrPayload,
ScopeDescriptor deadlineScope)
Schedules a deadline after the given
triggerDuration with provided context. |
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.
|
dispatchInterceptors, handlerInterceptors, processDispatchInterceptors, registerDispatchInterceptor, registerHandlerInterceptor, runOnPrepareCommitOrNow
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
cancelAllWithinScope, schedule, schedule, schedule, schedule
protected QuartzDeadlineManager(QuartzDeadlineManager.Builder builder)
QuartzDeadlineManager
based on the fields contained in the QuartzDeadlineManager.Builder
.
Will assert that the Scheduler
, ScopeAwareProvider
, TransactionManager
and
Serializer
are not null
, and will throw an AxonConfigurationException
if any of them is
null
. The TransactionManager, ScopeAwareProvider and Serializer will be tied to the Scheduler's context.
If this initialization step fails, this will too result in an AxonConfigurationException.
builder
- the QuartzDeadlineManager.Builder
used to instantiate a QuartzDeadlineManager
instancepublic static QuartzDeadlineManager.Builder builder()
QuartzDeadlineManager
.
The TransactionManager
is defaulted to a NoTransactionManager
.
The SpanFactory
is defaulted to a NoOpSpanFactory
.
The Scheduler
, ScopeAwareProvider
and Serializer
are hard requirements and as such
should be provided.
QuartzDeadlineManager
public String schedule(@Nonnull Instant triggerDateTime, @Nonnull String deadlineName, Object messageOrPayload, @Nonnull ScopeDescriptor deadlineScope)
DeadlineManager
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
.
schedule
in interface DeadlineManager
triggerDateTime
- A Instant
denoting the moment to trigger the deadline handlingdeadlineName
- A String
representing the name of the deadline to schedulemessageOrPayload
- A Message
or payload for a message as an
Object
deadlineScope
- A ScopeDescriptor
describing the scope within which the deadline was scheduledscheduleId
as a String
to use when cancelling the schedulepublic String schedule(@Nonnull Duration triggerDuration, @Nonnull String deadlineName, Object messageOrPayload, @Nonnull ScopeDescriptor deadlineScope)
DeadlineManager
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
.
schedule
in interface DeadlineManager
triggerDuration
- A Duration
describing the waiting period before handling the deadlinedeadlineName
- A String
representing the name of the deadline to schedulemessageOrPayload
- A Message
or payload for a message as an
Object
deadlineScope
- A ScopeDescriptor
describing the scope within which the deadline was scheduledscheduleId
as a String
to use when cancelling the schedulepublic void cancelSchedule(@Nonnull String deadlineName, @Nonnull String scheduleId)
DeadlineManager
deadlineName
/ scheduleId
combination. This
method has no impact on deadlines which have already been triggered.cancelSchedule
in interface DeadlineManager
deadlineName
- a String
representing the name of the deadline to cancelscheduleId
- the String
denoting the scheduled deadline to cancelpublic void cancelAll(@Nonnull String deadlineName)
DeadlineManager
deadlineName
. This method has no impact on deadlines
which have already been triggered.cancelAll
in interface DeadlineManager
deadlineName
- a String
representing the name of the deadlines to cancelpublic void cancelAllWithinScope(@Nonnull String deadlineName, @Nonnull ScopeDescriptor scope)
DeadlineManager
deadlineName
and scope
.
This method has no impact on deadlines which have already been triggered.cancelAllWithinScope
in interface DeadlineManager
deadlineName
- a String
representing the name of the deadlines to cancelscope
- a ScopeDescriptor
describing the scope within which the deadline was scheduledpublic void registerLifecycleHandlers(@Nonnull Lifecycle.LifecycleRegistry lifecycle)
Lifecycle
registerLifecycleHandlers
in interface Lifecycle
lifecycle
- the lifecycle instance to register the handlers withLifecycle.LifecycleRegistry.onShutdown(int, Runnable)
,
LifecycleRegistry#onShutdown(int, LifecycleHandler)
,
Lifecycle.LifecycleRegistry.onStart(int, Runnable)
,
LifecycleRegistry#onStart(int, LifecycleHandler)
public void shutdown()
DeadlineManager
shutdown
in interface DeadlineManager
Copyright © 2010–2023. All rights reserved.