Package org.axonframework.eventhandling.scheduling.dbscheduler

Class DbSchedulerEventScheduler.Builder

java.lang.Object

org.axonframework.eventhandling.scheduling.dbscheduler.DbSchedulerEventScheduler.Builder

Enclosing class:

DbSchedulerEventScheduler

public static class DbSchedulerEventScheduler.Builder
extends Object

Builder class to instantiate a DbSchedulerEventScheduler.

The TransactionManager is defaulted to a NoTransactionManager. The useBinaryPojo and startScheduler are defaulted to true.

The Scheduler, Serializer and EventBus are hard requirements and as such should be provided.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DbSchedulerEventScheduler	build()	Initializes a DbSchedulerEventScheduler as specified through this Builder.
DbSchedulerEventScheduler.Builder	eventBus(EventBus eventBus)	Sets the EventBus used to publish events on once the schedule has been met.
DbSchedulerEventScheduler.Builder	scheduler(com.github.kagkarlsson.scheduler.Scheduler scheduler)	Sets the Scheduler used for scheduling and triggering purposes of the events.
DbSchedulerEventScheduler.Builder	serializer(Serializer serializer)	Sets the Serializer used to de-/serialize the payload and the MetaData.
DbSchedulerEventScheduler.Builder	startScheduler(boolean startScheduler)	Sets whether to start the Scheduler using the Lifecycle, or to never start the scheduler from this component instead.
DbSchedulerEventScheduler.Builder	stopScheduler(boolean stopScheduler)	Sets whether to stop the Scheduler using the Lifecycle, or to never stop the scheduler from this component instead.
DbSchedulerEventScheduler.Builder	transactionManager(TransactionManager transactionManager)	Sets the TransactionManager used to build transactions and ties them on event publication.
DbSchedulerEventScheduler.Builder	useBinaryPojo(boolean useBinaryPojo)	Sets whether to use a pojo optimized for size, DbSchedulerBinaryEventData, compared to a pojo optimized for readability, DbSchedulerEventScheduler.
protected void	validate()	Validates whether the fields contained in this Builder are set accordingly.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

scheduler

public DbSchedulerEventScheduler.Builder scheduler(com.github.kagkarlsson.scheduler.Scheduler scheduler)

Sets the Scheduler used for scheduling and triggering purposes of the events. It should have either the DbSchedulerEventScheduler.binaryTask(Supplier) or the DbSchedulerEventScheduler.humanReadableTask(Supplier) from this class as one of its tasks to work. Which one depends on the setting of useBinaryPojo. When true, use DbSchedulerEventScheduler.binaryTask(Supplier) else DbSchedulerEventScheduler.humanReadableTask(Supplier). Depending on you application, you can manage when to start the scheduler, or leave startScheduler to true, to start it via the Lifecycle.

Parameters:

scheduler - a Scheduler used for scheduling and triggering purposes of the events

Returns:

the current Builder instance, for fluent interfacing

serializer

public DbSchedulerEventScheduler.Builder serializer(Serializer serializer)

Sets the Serializer used to de-/serialize the payload and the MetaData.

Parameters:

serializer - a Serializer used to de-/serialize the payload, and MetaData.

Returns:

the current Builder instance, for fluent interfacing

transactionManager

public DbSchedulerEventScheduler.Builder transactionManager(TransactionManager transactionManager)

Sets the TransactionManager used to build transactions and ties them on event publication. Defaults to a NoTransactionManager.

Parameters:

transactionManager - a TransactionManager used to build transactions and ties them on event publication

Returns:

the current Builder instance, for fluent interfacing

eventBus

public DbSchedulerEventScheduler.Builder eventBus(EventBus eventBus)

Sets the EventBus used to publish events on once the schedule has been met.

Parameters:

eventBus - a EventBus used to publish events on once the schedule has been met

Returns:

the current Builder instance, for fluent interfacing

useBinaryPojo

public DbSchedulerEventScheduler.Builder useBinaryPojo(boolean useBinaryPojo)

Sets whether to use a pojo optimized for size, DbSchedulerBinaryEventData, compared to a pojo optimized for readability, DbSchedulerEventScheduler.

Parameters:

useBinaryPojo - a boolean to determine whether to use a binary format.

Returns:

the current Builder instance, for fluent interfacing

startScheduler

public DbSchedulerEventScheduler.Builder startScheduler(boolean startScheduler)

Sets whether to start the Scheduler using the Lifecycle, or to never start the scheduler from this component instead. Defaults to true.

Parameters:

startScheduler - a boolean to determine whether to start the scheduler.

Returns:

the current Builder instance, for fluent interfacing

stopScheduler

public DbSchedulerEventScheduler.Builder stopScheduler(boolean stopScheduler)

Sets whether to stop the Scheduler using the Lifecycle, or to never stop the scheduler from this component instead. Defaults to true.

Parameters:

stopScheduler - a boolean to determine whether to stop the scheduler.

Returns:

the current Builder instance, for fluent interfacing

build

public DbSchedulerEventScheduler build()

Initializes a DbSchedulerEventScheduler as specified through this Builder.

Returns:

a DbSchedulerEventScheduler as specified through this Builder

validate

protected void validate()
                 throws AxonConfigurationException

Validates whether the fields contained in this Builder are set accordingly.

Throws:

AxonConfigurationException - if one field is asserted to be incorrect according to the Builder's specifications