org.axonframework.deadline.jobrunr

Class JobRunrDeadlineManager.Builder

java.lang.Object

org.axonframework.deadline.jobrunr.JobRunrDeadlineManager.Builder

Enclosing class:

JobRunrDeadlineManager

public static class JobRunrDeadlineManager.Builder
extends Object

Builder class to instantiate a JobRunrDeadlineManager.

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

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
JobRunrDeadlineManager	build() Initializes a JobRunrDeadlineManager as specified through this Builder.
JobRunrDeadlineManager.Builder	jobScheduler(org.jobrunr.scheduling.JobScheduler jobScheduler) Sets the JobScheduler used for scheduling and triggering purposes of the deadlines.
JobRunrDeadlineManager.Builder	scopeAwareProvider(ScopeAwareProvider scopeAwareProvider) Sets the ScopeAwareProvider which is capable of providing a stream of Scope instances for a given ScopeDescriptor.
JobRunrDeadlineManager.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.
JobRunrDeadlineManager.Builder	spanFactory(DeadlineManagerSpanFactory spanFactory) Sets the DeadlineManagerSpanFactory implementation to use for providing tracing capabilities.
JobRunrDeadlineManager.Builder	spanFactory(SpanFactory spanFactory) Deprecated. Use spanFactory(DeadlineManagerSpanFactory) instead as it provides more configuration options.
JobRunrDeadlineManager.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

jobScheduler

public JobRunrDeadlineManager.Builder jobScheduler(org.jobrunr.scheduling.JobScheduler jobScheduler)

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

Parameters:

jobScheduler - a JobScheduler used for scheduling and triggering purposes of the deadlines

Returns:

the current Builder instance, for fluent interfacing

scopeAwareProvider

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

build

public JobRunrDeadlineManager build()

Initializes a JobRunrDeadlineManager as specified through this Builder.

Returns:

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