org.axonframework.axonserver.connector.event.axon

Class AxonServerEventScheduler

java.lang.Object

org.axonframework.axonserver.connector.event.axon.AxonServerEventScheduler

All Implemented Interfaces:

EventScheduler, Lifecycle

public class AxonServerEventScheduler
extends Object
implements EventScheduler, Lifecycle

Implementation of the EventScheduler that uses Axon Server to schedule the events.

Since:

4.4

Author:

Marc Gathier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AxonServerEventScheduler.Builder Builder class to instantiate an AxonServerEventScheduler.

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

Lifecycle.LifecycleHandler, Lifecycle.LifecycleRegistry

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AxonServerEventScheduler(AxonServerEventScheduler.Builder builder) Instantiates an AxonServerEventScheduler using the given AxonServerEventScheduler.Builder.

Method Summary

Modifier and Type	Method and Description
static AxonServerEventScheduler.Builder	builder() Instantiate a Builder to be able to create a AxonServerEventScheduler.
void	cancelSchedule(ScheduleToken scheduleToken) Cancel a scheduled event.
void	registerLifecycleHandlers(Lifecycle.LifecycleRegistry lifecycle) Registers the activities to be executed in the various phases of an application's lifecycle.
ScheduleToken	reschedule(ScheduleToken scheduleToken, Duration triggerDuration, Object event) Changes the trigger time for a scheduled event.
ScheduleToken	schedule(Duration triggerDuration, Object event) Schedules an event to be published after a specified amount of time.
ScheduleToken	schedule(Instant triggerDateTime, Object event) Schedules an event to be published at a given moment.
void	shutdownDispatching() Shuts down the Axon Server EventScheduler implementation.
void	start() Start the Axon Server EventScheduler implementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.axonframework.eventhandling.scheduling.EventScheduler

reschedule, shutdown

Constructor Detail

AxonServerEventScheduler

protected AxonServerEventScheduler(AxonServerEventScheduler.Builder builder)

Instantiates an AxonServerEventScheduler using the given AxonServerEventScheduler.Builder.

Will assert that the Serializer and AxonServerConnectionManager are not null and will throw an AxonConfigurationException if this is the case.

Parameters:

builder - the AxonServerEventScheduler.Builder used.

Method Detail

builder

public static AxonServerEventScheduler.Builder builder()

Instantiate a Builder to be able to create a AxonServerEventScheduler.

The requestTimeout is defaulted to 15000 millis.

The Serializer and AxonServerConnectionManager are hard requirements and as such should be provided.

Returns:

a Builder to be able to create a AxonServerEventScheduler

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)

start

public void start()

Start the Axon Server EventScheduler implementation.

shutdownDispatching

public void shutdownDispatching()

Shuts down the Axon Server EventScheduler implementation.

schedule

public ScheduleToken schedule(Instant triggerDateTime,
                              Object event)

Schedules an event to be published at a given moment. The event is published in the application's default context.

Specified by:

schedule in interface EventScheduler

Parameters:

triggerDateTime - The moment to trigger publication of the event

event - The event to publish

Returns:

a token used to manage the schedule later

schedule

public ScheduleToken schedule(Duration triggerDuration,
                              Object event)

Schedules an event to be published after a specified amount of time.

Specified by:

schedule in interface EventScheduler

Parameters:

triggerDuration - the amount of time to wait before publishing the event

event - the event to publish

Returns:

a token used to manage the schedule later

cancelSchedule

public void cancelSchedule(ScheduleToken scheduleToken)

Cancel a scheduled event.

Specified by:

cancelSchedule in interface EventScheduler

Parameters:

scheduleToken - the token returned when the event was scheduled

reschedule

public ScheduleToken reschedule(ScheduleToken scheduleToken,
                                Duration triggerDuration,
                                Object event)

Changes the trigger time for a scheduled event.

Specified by:

reschedule in interface EventScheduler

Parameters:

scheduleToken - the token returned when the event was scheduled, might be null

triggerDuration - the amount of time to wait before publishing the event

event - the event to publish

Returns:

a token used to manage the schedule later