Package io.axoniq.framework.workflow.runtime.api.execution.context

Interface WorkflowConfiguration<T extends WorkflowContext>

Type Parameters:
T - workflow context type.
public interface WorkflowConfiguration<T extends WorkflowContext>
Configures definition, context factory and correlation provider.
Since:
5.4.0
Author:
Simon Zambrovski, Stefan Dragisic

  • Method Details

    • getWorkflowContextType

      Class<T> getWorkflowContextType()
      Returns the type of the workflow context.
      Returns:
      type of the workflow context.

    • workflowDefinition

      WorkflowDefinition<T> workflowDefinition()
      Returns workflow definition.
      Returns:
      workflow definition method expressed using workflow context.

    • workflowContextFactory

      WorkflowContextFactory<T> workflowContextFactory()
      Returns workflow context factory.
      Returns:
      factory for workflow context.

    • workflowExecutionFactory

      WorkflowExecutionFactory workflowExecutionFactory()
      Returns workflow state factory.
      Returns:
      factory for workflow state.

    • workflowIdProvider

      WorkflowIdProvider workflowIdProvider()
      Returns workflow id provider.
      Returns:
      provider responsible for creation of workflow id out of initial event message.

    • workflowName

      default String workflowName()
      Returns the workflow name.
      Returns:
      name of the workflow.

    • workflowVersion

      default String workflowVersion()
      Workflow definition version (semver, e.g. "0.0.2"). Defaults to Version.DEFAULT_VERSION ("0.0.1").
      Returns:
      workflow definition version.

    • eventNameCustomizer

      EventNameCustomizer eventNameCustomizer()
      Default event name customizer applied on workflow level.
      Returns:
      default customizer.

    • workflowStatusChangeListeners

      default Map<WorkflowStatus,WorkflowStatusChangeListener> workflowStatusChangeListeners()
      Returns workflow status change listeners.
      Returns:
      map of workflow status change listeners.

    • recoverableExceptionPolicy

      default RecoverableWorkflowExceptionPolicy recoverableExceptionPolicy()
      Classifies an exception that escaped the workflow body. A recoverable exception pauses the workflow so a later run can succeed; any other exception fails the workflow.
      Returns:
      the policy deciding whether an unhandled body exception is recoverable, by default RecoverableWorkflowExceptionPolicy.DEFAULT