org.axonframework.deadline

Interface DeadlineManager

All Known Implementing Classes:

AbstractDeadlineManager, QuartzDeadlineManager, SimpleDeadlineManager, StubDeadlineManager

public interface DeadlineManager

Contract for deadline managers. There are two sets of methods for scheduling - ones which accept a specified scheduleId and ones which generate and return the id themselves. For callers that want to use the auto generated schedule id approach, it is recommended to use generateScheduleId() method.

Since:

3.3

Author:

Milan Savic, Steven van Beelen

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.
default String	generateScheduleId() Generates a String schedule id.
default String	schedule(Duration triggerDuration, String deadlineName) Schedules a deadline after the given triggerDuration with given deadlineName.
default String	schedule(Duration triggerDuration, String deadlineName, Object messageOrPayload) Schedules a deadline after the given triggerDuration.
default String	schedule(Duration triggerDuration, String deadlineName, Object messageOrPayload, ScopeDescriptor deadlineScope) Schedules a deadline after the given triggerDuration with provided context.
void	schedule(Duration triggerDuration, String deadlineName, Object messageOrPayload, ScopeDescriptor deadlineScope, String scheduleId) Schedules a deadline after the given triggerDuration with provided context.
default String	schedule(Instant triggerDateTime, String deadlineName) Schedules a deadline at given triggerDateTime with given deadlineName.
default String	schedule(Instant triggerDateTime, String deadlineName, Object messageOrPayload) Schedules a deadline at given triggerDateTime with given deadlineName.
default String	schedule(Instant triggerDateTime, String deadlineName, Object messageOrPayload, ScopeDescriptor deadlineScope) Schedules a deadline at given triggerDateTime with provided context.
default void	schedule(Instant triggerDateTime, String deadlineName, Object messageOrPayload, ScopeDescriptor deadlineScope, String scheduleId) Schedules a deadline at given triggerDateTime with provided context.

Method Detail

schedule

default String schedule(Instant triggerDateTime,
                        String deadlineName)

Schedules a deadline at given triggerDateTime with given deadlineName. The payload of this deadline will be null, as none is provided. The returned scheduleId and provided deadlineName combination can be used to cancel the scheduled deadline. The scope within which this call is made will be retrieved by the DeadlineManager itself.

Parameters:

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

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

Returns:

the scheduleId as a String to use when cancelling the schedule

schedule

default String schedule(Instant triggerDateTime,
                        String deadlineName,
                        Object messageOrPayload)

Schedules a deadline at given triggerDateTime with given deadlineName. The returned scheduleId and provided deadlineName combination can be used to cancel the scheduled deadline. The scope within which this call is made will be retrieved by the DeadlineManager itself.

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.

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

Returns:

the scheduleId as a String to use when cancelling the schedule

schedule

default String schedule(Instant triggerDateTime,
                        String deadlineName,
                        Object messageOrPayload,
                        ScopeDescriptor deadlineScope)

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.

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

schedule

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

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

default String schedule(Duration triggerDuration,
                        String deadlineName)

Schedules a deadline after the given triggerDuration with given deadlineName. The payload of this deadline will be null, as none is provided. The returned scheduleId and provided deadlineName combination can be used to cancel the scheduled deadline. The scope within which this call is made will be retrieved by the DeadlineManager itself.

Parameters:

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

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

Returns:

the scheduleId as a String to use when cancelling the schedule

schedule

default String schedule(Duration triggerDuration,
                        String deadlineName,
                        Object messageOrPayload)

Schedules a deadline after the given triggerDuration. The returned scheduleId and provided deadlineName combination can be used to cancel the scheduled deadline. The scope within which this call is made will be retrieved by the DeadlineManager itself.

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.

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

Returns:

the scheduleId as a String to use when cancelling the schedule

schedule

default String schedule(Duration triggerDuration,
                        String deadlineName,
                        Object messageOrPayload,
                        ScopeDescriptor deadlineScope)

Schedules a deadline after the given triggerDuration 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.

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

Returns:

the scheduleId as a String to use when cancelling the schedule

schedule

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

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

default String generateScheduleId()

Generates a String schedule id.

Returns:

a String schedule id

cancelSchedule

void cancelSchedule(String deadlineName,
                    String scheduleId)

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

void cancelAll(String deadlineName)

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