Package 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 useBinaryPojo, startScheduler and stopScheduler settings are defaulted to true. The Scheduler, ScopeAwareProvider, UnitOfWorkFactory and Converter are hard requirements and as such should be provided.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DbSchedulerDeadlineManager	build()	Initializes a DbSchedulerDeadlineManager as specified through this Builder.
DbSchedulerDeadlineManager.Builder	converter(Converter converter)	Sets the Converter used to convert the payload, metadata and ScopeDescriptor of a deadline to and from their stored form in the task data.
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	startScheduler(boolean startScheduler)	Sets whether DbSchedulerDeadlineManager.start() starts the Scheduler, or leaves starting it to the application.
DbSchedulerDeadlineManager.Builder	stopScheduler(boolean stopScheduler)	Sets whether DbSchedulerDeadlineManager.shutdown() stops the Scheduler, or leaves stopping it to the application.
DbSchedulerDeadlineManager.Builder	unitOfWorkFactory(UnitOfWorkFactory unitOfWorkFactory)	Sets the UnitOfWorkFactory creating the unit of work a fired deadline runs in.
DbSchedulerDeadlineManager.Builder	useBinaryPojo(boolean useBinaryPojo)	Sets whether to use a pojo optimized for size, DbSchedulerBinaryDeadlineDetails, compared to a pojo optimized for readability, DbSchedulerHumanReadableDeadlineDetails.
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 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).

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

unitOfWorkFactory

public DbSchedulerDeadlineManager.Builder unitOfWorkFactory(UnitOfWorkFactory unitOfWorkFactory)

Sets the UnitOfWorkFactory creating the unit of work a fired deadline runs in. Pass the factory of the application's configuration, so that a fired deadline runs in the same kind of unit of work as other messages: transactional if the factory is, and with a ProcessingContext that resolves components.

Parameters:

unitOfWorkFactory - the factory creating the unit of work a fired deadline runs in

Returns:

the current Builder instance, for fluent interfacing

converter

public DbSchedulerDeadlineManager.Builder converter(Converter converter)

Sets the Converter used to convert the payload, metadata and ScopeDescriptor of a deadline to and from their stored form in the task data. To keep reading tasks scheduled by Axon Framework 4, it has to match the serializer the Axon Framework 4 deadline manager used, such as a JacksonConverter for a JacksonSerializer. For a manager that Axon Framework 4's Spring Boot auto-configuration built, that is the counterpart of the event serializer, the EventConverter.

Parameters:

converter - the Converter used to convert the deadline's parts

Returns:

the current Builder instance, for fluent interfacing

useBinaryPojo

public DbSchedulerDeadlineManager.Builder useBinaryPojo(boolean useBinaryPojo)

Sets whether to use a pojo optimized for size, DbSchedulerBinaryDeadlineDetails, compared to a pojo optimized for readability, DbSchedulerHumanReadableDeadlineDetails. Defaults to true.

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 DbSchedulerDeadlineManager.start() starts the Scheduler, or leaves starting it to the application. 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 DbSchedulerDeadlineManager.shutdown() stops the Scheduler, or leaves stopping it to the application. Defaults to true.

Parameters:

stopScheduler - a boolean to determine whether to stop 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