Package org.axonframework.deadline.quartz

Class QuartzDeadlineManager.Builder

java.lang.Object

org.axonframework.deadline.quartz.QuartzDeadlineManager.Builder

Enclosing class:

QuartzDeadlineManager

public static class QuartzDeadlineManager.Builder
extends Object

Builder class to instantiate a QuartzDeadlineManager.

The TransactionManager is defaulted to a NoTransactionManager and the DeadlineManagerSpanFactory defaults to a DefaultDeadlineManagerSpanFactory backed by a NoOpSpanFactory.

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QuartzDeadlineManager	build()	Initializes a QuartzDeadlineManager as specified through this Builder.
QuartzDeadlineManager.Builder	refireImmediatelyPolicy(Predicate<Throwable> refireImmediatelyPolicy)	Sets a Predicate taking a Throwable to decided whether a failed DeadlineJob should be 'refired' immediately.
QuartzDeadlineManager.Builder	scheduler(org.quartz.Scheduler scheduler)	Sets the Scheduler used for scheduling and triggering purposes of the deadlines.
QuartzDeadlineManager.Builder	scopeAwareProvider(ScopeAwareProvider scopeAwareProvider)	Sets the ScopeAwareProvider which is capable of providing a stream of Scope instances for a given ScopeDescriptor.
QuartzDeadlineManager.Builder	serializer(Serializer serializer)	Sets the Serializer used to de-/serialize the DeadlineMessage and the ScopeDescriptor into the JobDataMap.
QuartzDeadlineManager.Builder	spanFactory(DeadlineManagerSpanFactory spanFactory)	Sets the SpanFactory implementation to use for providing tracing capabilities.
QuartzDeadlineManager.Builder	spanFactory(SpanFactory spanFactory)	Deprecated. Use spanFactory(DeadlineManagerSpanFactory) which provides more configuration options.
QuartzDeadlineManager.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 Details

Builder

public Builder()

Method Details

scheduler

public QuartzDeadlineManager.Builder scheduler(org.quartz.Scheduler scheduler)

Sets the Scheduler used for scheduling and triggering purposes of the deadlines.

Parameters:

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

Returns:

the current Builder instance, for fluent interfacing

scopeAwareProvider

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

transactionManager

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

serializer

public QuartzDeadlineManager.Builder serializer(Serializer serializer)

Sets the Serializer used to de-/serialize the DeadlineMessage and the ScopeDescriptor into the JobDataMap.

Parameters:

serializer - a Serializer used to de-/serialize the DeadlineMessage and the ScopeDescriptor into the JobDataMap

Returns:

the current Builder instance, for fluent interfacing

spanFactory

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

Deprecated.

Use spanFactory(DeadlineManagerSpanFactory) which 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 QuartzDeadlineManager.Builder spanFactory(@Nonnull
 DeadlineManagerSpanFactory spanFactory)

Sets the SpanFactory 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.

refireImmediatelyPolicy

public QuartzDeadlineManager.Builder refireImmediatelyPolicy(Predicate<Throwable> refireImmediatelyPolicy)

Sets a Predicate taking a Throwable to decided whether a failed DeadlineJob should be 'refired' immediately. Defaults to a Predicate which will refire immediately on non-AxonNonTransientExceptions.

Parameters:

refireImmediatelyPolicy - a Predicate taking a Throwable to decided whether a failed DeadlineJob should be 'refired' immediately

Returns:

the current Builder instance, for fluent interfacing

build

public QuartzDeadlineManager build()

Initializes a QuartzDeadlineManager as specified through this Builder.

Returns:

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