Package io.axoniq.framework.workflow.configuration

Interface WorkflowModule.OptionalPhase<C extends WorkflowContext>

Type Parameters:

C - the type of WorkflowContext used by the workflows in this module

All Superinterfaces:

Module, WorkflowModule<C>

Enclosing interface:

WorkflowModule<C extends WorkflowContext>

public static interface WorkflowModule.OptionalPhase<C extends WorkflowContext>
extends WorkflowModule<C>

Terminal phase of the module's building process, in which a multitude of optional components can be set:

• definition(Function) - add another workflow definition to this module.
• processorConfiguration(Function) - customize the PooledStreamingEventProcessorConfiguration backing this module's event processor.
• withHistory(ComponentBuilder) / withoutHistory() - enable or disable workflow history tracking.
• historyProcessorConfiguration(Function) - customize the PooledStreamingEventProcessorConfiguration backing the history projector's own event processor.
• contextFactory(ComponentBuilder) - override the WorkflowContextFactory used to create the WorkflowContext for each workflow execution.
• configurationRegistry(ComponentBuilder) - override the WorkflowConfigurationRegistry storing workflow configurations and their start conditions.
• executionRepository(ComponentBuilder) - override the WorkflowExecutionRepository persisting and retrieving workflow instances.

Reaching this phase already yields a fully-formed WorkflowModule.

Nested Class Summary

Nested classes/interfaces inherited from interface io.axoniq.framework.workflow.configuration.WorkflowModule

WorkflowModule.OptionalPhase<C extends WorkflowContext>, WorkflowModule.WorkflowDefinitionPhase<C extends WorkflowContext>

Method Summary

Modifier and Type	Method	Description
WorkflowModule.OptionalPhase<C>	configurationRegistry(ComponentBuilder<WorkflowConfigurationRegistry<?>> workflowConfigurationRegistry)	Registers the given ComponentBuilder of a WorkflowConfigurationRegistry as the registry for the workflow module being built.
WorkflowModule.OptionalPhase<C>	contextFactory(ComponentBuilder<WorkflowContextFactory<C>> workflowContextFactory)	Registers the given ComponentBuilder of a WorkflowContextFactory as the context factory for the workflow module being built, overriding any factory a DSL module registered for WorkflowModule.contextType().
WorkflowModule.OptionalPhase<C>	definition(Function<WorkflowModule.WorkflowDefinitionPhase.DetectionPhase<C>,WorkflowModule.WorkflowDefinitionPhase.FinalizedPhase<C>> definition)	Add another workflow definition to this module, which already received one or more via the fluent WorkflowModule.WorkflowDefinitionPhase.definition(Function) entry point.
WorkflowModule.OptionalPhase<C>	executionRepository(ComponentBuilder<WorkflowExecutionRepository> workflowExecutionRepository)	Registers the given ComponentBuilder of a WorkflowExecutionRepository as the repository for the workflow module being built.
WorkflowModule.OptionalPhase<C>	historyProcessorConfiguration(Function<PooledStreamingEventProcessorConfiguration,PooledStreamingEventProcessorConfiguration> historyProcessorConfiguration)	Applies the given historyProcessorConfiguration function to the PooledStreamingEventProcessorConfiguration backing the history projector's own, dedicated event processor.
WorkflowModule.OptionalPhase<C>	processorConfiguration(Function<PooledStreamingEventProcessorConfiguration,PooledStreamingEventProcessorConfiguration> processorConfiguration)	Applies the given processorConfiguration function to the PooledStreamingEventProcessorConfiguration backing this module's event processor.
WorkflowModule.OptionalPhase<C>	withHistory(ComponentBuilder<MutableWorkflowHistoryRepository> workflowHistoryRepository)	Enables workflow history tracking, storing collected history in the given MutableWorkflowHistoryRepository.
WorkflowModule.OptionalPhase<C>	withoutHistory()	Disables workflow history tracking for this module.

Methods inherited from interface org.axonframework.common.configuration.Module

build, name

Methods inherited from interface io.axoniq.framework.workflow.configuration.WorkflowModule

contextType

Method Details

definition

WorkflowModule.OptionalPhase<C> definition(Function<WorkflowModule.WorkflowDefinitionPhase.DetectionPhase<C>,WorkflowModule.WorkflowDefinitionPhase.FinalizedPhase<C>> definition)

Add another workflow definition to this module, which already received one or more via the fluent WorkflowModule.WorkflowDefinitionPhase.definition(Function) entry point.

Use this to register multiple workflow definitions of the same workflow context type into a SINGLE module so they share one WorkflowConfigurationRegistry and WorkflowEngine.

Parameters:

definition - function returning a WorkflowModule.WorkflowDefinitionPhase.FinalizedPhase for an additional workflow

Returns:

this phase, for further optional configuration

processorConfiguration

WorkflowModule.OptionalPhase<C> processorConfiguration(Function<PooledStreamingEventProcessorConfiguration,PooledStreamingEventProcessorConfiguration> processorConfiguration)

Applies the given processorConfiguration function to the PooledStreamingEventProcessorConfiguration backing this module's event processor.

Standard processor settings - segment count, batch size, error handling, worker executor, and so on - live on PooledStreamingEventProcessorConfiguration itself. This method is the hook through which those settings are reached: the given Function is applied on top of the module's own internal customization (event criteria, segment routing), so it composes with rather than replaces that wiring.

The engine component name and the event processor's own name are not configurable - the module derives both from its own name, so several WorkflowModules in one application never collide.

Parameters:

processorConfiguration - a function customizing the PooledStreamingEventProcessorConfiguration of this module's event processor

Returns:

this phase, for further optional configuration

withHistory

WorkflowModule.OptionalPhase<C> withHistory(ComponentBuilder<MutableWorkflowHistoryRepository> workflowHistoryRepository)

Enables workflow history tracking, storing collected history in the given MutableWorkflowHistoryRepository.

The module creates its own WorkflowHistoryProjector, injecting the repository constructed by the given workflowHistoryRepository.

Parameters:

workflowHistoryRepository - a ComponentBuilder constructing the MutableWorkflowHistoryRepository

Returns:

this phase, for further optional configuration

withoutHistory

WorkflowModule.OptionalPhase<C> withoutHistory()

Disables workflow history tracking for this module.

No historic information about workflow executions will be collected.

Returns:

this phase, for further optional configuration

historyProcessorConfiguration

WorkflowModule.OptionalPhase<C> historyProcessorConfiguration(Function<PooledStreamingEventProcessorConfiguration,PooledStreamingEventProcessorConfiguration> historyProcessorConfiguration)

Applies the given historyProcessorConfiguration function to the PooledStreamingEventProcessorConfiguration backing the history projector's own, dedicated event processor.

Note that setting these properties do not make sense if history has been disabled.

Parameters:

historyProcessorConfiguration - a function customizing the PooledStreamingEventProcessorConfiguration of the history projector's event processor

Returns:

this phase, for further optional configuration

contextFactory

WorkflowModule.OptionalPhase<C> contextFactory(ComponentBuilder<WorkflowContextFactory<C>> workflowContextFactory)

Registers the given ComponentBuilder of a WorkflowContextFactory as the context factory for the workflow module being built, overriding any factory a DSL module registered for WorkflowModule.contextType().

The factory is responsible for creating the WorkflowContext that is passed to workflow definitions during execution. Left uncalled, the module falls back to the WorkflowContextFactory a DSL's own ConfigurationEnhancer registered for WorkflowModule.contextType() - for example SimpleWorkflowContext or the Kotlin DSL's context type both have one registered automatically. A custom WorkflowContext type has no such enhancer, so it still requires this method to be called, or building fails with a clear error.

Parameters:

workflowContextFactory - a ComponentBuilder constructing the WorkflowContextFactory

Returns:

this phase, for further optional configuration

configurationRegistry

WorkflowModule.OptionalPhase<C> configurationRegistry(ComponentBuilder<WorkflowConfigurationRegistry<?>> workflowConfigurationRegistry)

Registers the given ComponentBuilder of a WorkflowConfigurationRegistry as the registry for the workflow module being built.

The registry stores workflow configurations together with their corresponding start conditions, and is used by the WorkflowEngine to look up which workflow to start for a given event.

Parameters:

workflowConfigurationRegistry - a ComponentBuilder constructing the WorkflowConfigurationRegistry

Returns:

this phase, for further optional configuration

executionRepository

WorkflowModule.OptionalPhase<C> executionRepository(ComponentBuilder<WorkflowExecutionRepository> workflowExecutionRepository)

Registers the given ComponentBuilder of a WorkflowExecutionRepository as the repository for the workflow module being built.

The repository is responsible for persisting and retrieving workflow instances, where each instance is identified by a unique workflow identifier and bundles configuration, context, and execution state.

Parameters:

workflowExecutionRepository - a ComponentBuilder constructing the WorkflowExecutionRepository

Returns:

this phase, for further optional configuration