org.axonframework.deadline.dbscheduler

Class DbSchedulerDeadlineManager.Builder

java.lang.Object

org.axonframework.deadline.dbscheduler.DbSchedulerDeadlineManager.Builder

Enclosing class:

DbSchedulerDeadlineManager

public static class DbSchedulerDeadlineManager.Builder
extends Object

Builder class to instantiate a DbSchedulerDeadlineManager.

The TransactionManager is defaulted to a NoTransactionManager, the DefaultDeadlineManagerSpanFactory defaults to a DefaultDeadlineManagerSpanFactory backed by a NoOpSpanFactory. The useBinaryPojo and startScheduler are defaulted to true.

The JobScheduler, ScopeAwareProvider and Serializer are hard requirements and as such should be provided.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DbSchedulerDeadlineManager	build() Initializes a DbSchedulerDeadlineManager as specified through this Builder.
DbSchedulerDeadlineManager.Builder	scheduler(com.github.kagkarlsson.scheduler.Scheduler scheduler) Sets the Scheduler used for scheduling and triggering purposes of deadlines.
DbSchedulerDeadlineManager.Builder	scopeAwareProvider(ScopeAwareProvider scopeAwareProvider) Sets the ScopeAwareProvider which is capable of providing a stream of Scope instances for a given ScopeDescriptor.
DbSchedulerDeadlineManager.Builder	serializer(Serializer serializer) Sets the Serializer used to de-/serialize the payload, MetaData and the ScopeDescriptor into the DeadlineDetails as well as the whole DeadlineDetails itself.
DbSchedulerDeadlineManager.Builder	spanFactory(DeadlineManagerSpanFactory spanFactory) Sets the DeadlineManagerSpanFactory implementation to use for providing tracing capabilities.
DbSchedulerDeadlineManager.Builder	spanFactory(SpanFactory spanFactory) Deprecated. Use spanFactory(DeadlineManagerSpanFactory) instead as it provides more configuration options.
DbSchedulerDeadlineManager.Builder	startScheduler(boolean startScheduler) Sets whether to start the Scheduler using the Lifecycle, or to never start the scheduler from this component instead.
DbSchedulerDeadlineManager.Builder	stopScheduler(boolean stopScheduler) Sets whether to stop the Scheduler using the Lifecycle, or to never stop the scheduler from this component instead.
DbSchedulerDeadlineManager.Builder	transactionManager(TransactionManager transactionManager) Sets the TransactionManager used to build transactions and ties them to deadline.
DbSchedulerDeadlineManager.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 Detail

Builder

public Builder()

Method Detail

scheduler

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

Sets the Scheduler used for scheduling and triggering purposes of deadlines. It should have either the DbSchedulerDeadlineManager.binaryTask(Supplier) or the DbSchedulerDeadlineManager.humanReadableTask(Supplier) from this class as one of its tasks to work. Which one depends on the setting of useBinaryPojo. When true, use DbSchedulerDeadlineManager.binaryTask(Supplier) else DbSchedulerDeadlineManager.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 deadlines

Returns:

the current Builder instance, for fluent interfacing

scopeAwareProvider

public DbSchedulerDeadlineManager.Builder scopeAwareProvider(ScopeAwareProvider scopeAwareProvider)

Sets the ScopeAwareProvider which is capable of providing a stream of Scope instances for a given ScopeDescriptor. Used to return the right Scope to trigger a deadline in.

Parameters:

scopeAwareProvider - a ScopeAwareProvider used to find the right Scope to trigger a deadline in

Returns:

the current Builder instance, for fluent interfacing

serializer

public DbSchedulerDeadlineManager.Builder serializer(Serializer serializer)

Sets the Serializer used to de-/serialize the payload, MetaData and the ScopeDescriptor into the DeadlineDetails as well as the whole DeadlineDetails itself.

Parameters:

serializer - a Serializer used to de-/serialize the payload, MetaData and the ScopeDescriptor into the DeadlineDetails, as well as the whole DeadlineDetails itself.

Returns:

the current Builder instance, for fluent interfacing

transactionManager

public DbSchedulerDeadlineManager.Builder transactionManager(TransactionManager transactionManager)

Sets the TransactionManager used to build transactions and ties them to deadline. Defaults to a NoTransactionManager.

Parameters:

transactionManager - a TransactionManager used to build transactions and ties them to deadline

Returns:

the current Builder instance, for fluent interfacing

spanFactory

@Deprecated
public DbSchedulerDeadlineManager.Builder spanFactory(@Nonnull
                                                                  SpanFactory spanFactory)

Deprecated. Use spanFactory(DeadlineManagerSpanFactory) instead as it provides more configuration options.

Sets the SpanFactory implementation to use for providing tracing capabilities. Defaults to a NoOpSpanFactory by default, which provides no tracing capabilities.

Parameters:

spanFactory - The SpanFactory implementation

Returns:

The current Builder instance, for fluent interfacing.

spanFactory

public DbSchedulerDeadlineManager.Builder spanFactory(@Nonnull
                                                      DeadlineManagerSpanFactory spanFactory)

Sets the DeadlineManagerSpanFactory implementation to use for providing tracing capabilities. Defaults to a DefaultDeadlineManagerSpanFactory backed by a NoOpSpanFactory by default, which provides no tracing capabilities.

Parameters:

spanFactory - The DeadlineManagerSpanFactory implementation

Returns:

The current Builder instance, for fluent interfacing.

useBinaryPojo

public DbSchedulerDeadlineManager.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 DbSchedulerDeadlineManager.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 DbSchedulerDeadlineManager.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 start the scheduler.

Returns:

the current Builder instance, for fluent interfacing

build

public DbSchedulerDeadlineManager build()

Initializes a DbSchedulerDeadlineManager as specified through this Builder.

Returns:

a DbSchedulerDeadlineManager 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