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 TransactionManager defaults to a NoTransactionManager, and the SpanFactory defaults to a DefaultDeadlineManagerSpanFactory backed by a NoOpSpanFactory. The ScopeAwareProvider is a hard requirement and as such should be provided.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and 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	spanFactory(DeadlineManagerSpanFactory spanFactory) Sets the DeadlineManagerSpanFactory implementation to use for providing tracing capabilities.
SimpleDeadlineManager.Builder	spanFactory(SpanFactory spanFactory) Deprecated. Use spanFactory(DeadlineManagerSpanFactory) instead as it provides more configuration options.
SimpleDeadlineManager.Builder	transactionManager(TransactionManager transactionManager) Sets the TransactionManager used to build transactions and ties them to deadline.
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

scopeAwareProvider

public SimpleDeadlineManager.Builder scopeAwareProvider(@Nonnull
                                                        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(@Nonnull
                                                              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

transactionManager

public SimpleDeadlineManager.Builder transactionManager(@Nonnull
                                                        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 SimpleDeadlineManager.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 SimpleDeadlineManager.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 SpanFactory implementation

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