Package org.axonframework.deadline

Class SimpleDeadlineManager.Builder

java.lang.Object

org.axonframework.deadline.SimpleDeadlineManager.Builder

Enclosing class:

SimpleDeadlineManager

public static class SimpleDeadlineManager.Builder
extends Object

Builder class to instantiate a SimpleDeadlineManager.

The ScheduledExecutorService is defaulted to an Executors.newSingleThreadScheduledExecutor() which contains an AxonThreadFactory. The ScopeAwareProvider and the UnitOfWorkFactory are hard requirements and as such should be provided.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SimpleDeadlineManager	build()	Initializes a SimpleDeadlineManager as specified through this Builder.
SimpleDeadlineManager.Builder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)	Sets the ScheduledExecutorService used for scheduling and triggering deadlines.
SimpleDeadlineManager.Builder	scopeAwareProvider(ScopeAwareProvider scopeAwareProvider)	Sets the ScopeAwareProvider which is capable of providing a stream of Scope instances for a given ScopeDescriptor.
SimpleDeadlineManager.Builder	unitOfWorkFactory(UnitOfWorkFactory unitOfWorkFactory)	Sets the UnitOfWorkFactory creating the unit of work a fired deadline runs in.
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

scopeAwareProvider

public SimpleDeadlineManager.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

scheduledExecutorService

public SimpleDeadlineManager.Builder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)

Sets the ScheduledExecutorService used for scheduling and triggering deadlines. Defaults to a Executors.newSingleThreadScheduledExecutor(), containing an AxonThreadFactory.

Parameters:

scheduledExecutorService - a ScheduledExecutorService used for scheduling and triggering deadlines

Returns:

the current Builder instance, for fluent interfacing

unitOfWorkFactory

public SimpleDeadlineManager.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

build

public SimpleDeadlineManager build()

Initializes a SimpleDeadlineManager as specified through this Builder.

Returns:

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