Uses of Interface
io.axoniq.framework.workflow.dsl.api.WorkflowContext
Packages that use WorkflowContext
Package
Description
Package containing workflow configuration components.
Base Java DSL for defining workflow steps, providing the core primitives to execute work, wait for events, modify the
workflow payload, sleep, fail, and cancel a workflow.
Convenience Java DSL built on top of the base DSL, adding shortcuts for common workflow steps such as executing
without extra input payload, waiting for a typed event, and replacing the workflow payload outright.
Internal runtime contracts for workflow execution, command dispatch, configuration, and event publication.
Internal implementation of the workflow execution engine: the
WorkflowEngine, its scheduling, state and
storage, checkpointing/replay support, cancellation coordination, and the delegates implementing individual step
primitives.The abstract base class for workflow runtime tests, wiring a workflow module, engine, and supporting services around
JUnit lifecycle callbacks.
The given/when/then style test fixture API for workflow runtime tests, including the staged
WorkflowTestFixture, the lower-level WorkflowTestDriver, and the shared testing state and services
backing both.-
Uses of WorkflowContext in io.axoniq.framework.workflow.configuration
Classes in io.axoniq.framework.workflow.configuration with type parameters of type WorkflowContextModifier and TypeInterfaceDescriptioninterfaceWorkflowModule<C extends WorkflowContext>A workflowModulethat encapsulates the configuration for one or more workflow definitions, all sharing the sameWorkflowContexttype defined by the genericC.static interfaceWorkflowModule.OptionalPhase<C extends WorkflowContext>Terminal phase of the module's building process, in which a multitude of optional components can be set:WorkflowModule.OptionalPhase.definition(Function)- add another workflow definition to this module.WorkflowModule.OptionalPhase.processorConfiguration(Function)- customize thePooledStreamingEventProcessorConfigurationbacking this module's event processor.WorkflowModule.OptionalPhase.withHistory(ComponentBuilder)/WorkflowModule.OptionalPhase.withoutHistory()- enable or disable workflow history tracking.WorkflowModule.OptionalPhase.historyProcessorConfiguration(Function)- customize thePooledStreamingEventProcessorConfigurationbacking the history projector's own event processor.WorkflowModule.OptionalPhase.contextFactory(ComponentBuilder)- override theWorkflowContextFactoryused to create theWorkflowContextfor each workflow execution.WorkflowModule.OptionalPhase.configurationRegistry(ComponentBuilder)- override theWorkflowConfigurationRegistrystoring workflow configurations and their start conditions.WorkflowModule.OptionalPhase.executionRepository(ComponentBuilder)- override theWorkflowExecutionRepositorypersisting and retrieving workflow instances.static interfacePhase of the module's building process in which one or more workflow definitions are provided.static interfacePhase of the workflow definition process in which the detection strategy is chosen.static interfacePhase of the declarative workflow definition process in which the workflow is named.static interfacePhase of the declarative workflow definition process in which the trigger condition is defined.static interfacePhase of the declarative workflow definition process in which optional customizations can be applied.Fields in io.axoniq.framework.workflow.configuration with type parameters of type WorkflowContextModifier and TypeFieldDescriptionstatic final Context.ResourceKey<WorkflowContext> WorkflowMethodParameterResolverFactory.WORKFLOW_CONTEXT_RESOURCE_KEYResource key under which theWorkflowContextof the invocation in progress is stored.Methods in io.axoniq.framework.workflow.configuration with type parameters of type WorkflowContextModifier and TypeMethodDescriptionstatic <C extends WorkflowContext>
WorkflowModule.WorkflowDefinitionPhase<C> Creates a new workflow module, exposing the sameWorkflowModule.WorkflowDefinitionPhaseentry point asWorkflowModule.defaults(String, Class).static <C extends WorkflowContext>
WorkflowModule.WorkflowDefinitionPhase<C> Creates a new workflow module using default infrastructure settings, the recommended entry point for most use cases.Methods in io.axoniq.framework.workflow.configuration that return types with arguments of type WorkflowContextModifier and TypeMethodDescription@Nullable Class<? extends WorkflowContext> AutoDetectionUtils.MethodWithWorkflowAttributes.workflowContextType()Returns the value of theworkflowContextTyperecord component.Methods in io.axoniq.framework.workflow.configuration with parameters of type WorkflowContextModifier and TypeMethodDescriptionvoidCompositeWorkflowStatusChangeListener.onWorkflowStatus(WorkflowStatus status, WorkflowContext workflowContext, ProcessingContext processingContext) static @Nullable ObjectAutoDetectionUtils.wrapIfPossible(Class<?> type, @Nullable WorkflowContext context) Wraps the context if possible.Constructor parameters in io.axoniq.framework.workflow.configuration with type arguments of type WorkflowContextModifierConstructorDescriptionMethodWithWorkflowAttributes(Method method, Map<String, @Nullable Object> attributes, @Nullable Class<? extends WorkflowContext> workflowContextType) Creates an instance of aMethodWithWorkflowAttributesrecord class. -
Uses of WorkflowContext in io.axoniq.framework.workflow.dsl.base
Classes in io.axoniq.framework.workflow.dsl.base that implement WorkflowContextModifier and TypeClassDescriptionclassBase Java DSL entry point for defining workflow steps. -
Uses of WorkflowContext in io.axoniq.framework.workflow.dsl.simple
Classes in io.axoniq.framework.workflow.dsl.simple that implement WorkflowContext -
Uses of WorkflowContext in io.axoniq.framework.workflow.runtime.api.execution.context
Classes in io.axoniq.framework.workflow.runtime.api.execution.context with type parameters of type WorkflowContextModifier and TypeInterfaceDescriptioninterfaceWorkflowConfiguration<T extends WorkflowContext>Configures definition, context factory and correlation provider.interfaceWorkflowContextFactory<T extends WorkflowContext>Creates a context for workflow execution.interfaceWorkflowDefinition<T extends WorkflowContext>Definition of the workflow.Methods in io.axoniq.framework.workflow.runtime.api.execution.context with parameters of type WorkflowContextModifier and TypeMethodDescriptionWorkflowExecutionFactory.create(WorkflowContext workflowContext) Creates workflow execution for a given workflow context.voidWorkflowStatusChangeListener.onWorkflowStatus(WorkflowStatus status, WorkflowContext context, ProcessingContext processingContext) Handler reacting on aworkflow statuschange. -
Uses of WorkflowContext in io.axoniq.framework.workflow.runtime.execution
Classes in io.axoniq.framework.workflow.runtime.execution with type parameters of type WorkflowContextModifier and TypeClassDescriptionclassWorkflow execution factory adopting an author-facing context implementingAbstractWorkflowContext.Classes in io.axoniq.framework.workflow.runtime.execution that implement WorkflowContextModifier and TypeClassDescriptionclassBase class for author-facingWorkflowContextimplementations.Methods in io.axoniq.framework.workflow.runtime.execution with type parameters of type WorkflowContextModifier and TypeMethodDescription<T extends WorkflowContext>
TWorkflowExecutionOperationsDelegation.typedWorkflowContext()Retrieves the typed author-facing workflow context.Methods in io.axoniq.framework.workflow.runtime.execution with parameters of type WorkflowContextModifier and TypeMethodDescriptionWorkflowContextAdoptingExecutionFactory.create(WorkflowContext workflowContext) Constructors in io.axoniq.framework.workflow.runtime.execution with parameters of type WorkflowContextModifierConstructorDescriptionSimpleWorkflowExecution(String workflowId, Map<String, @Nullable Object> initial, ProcessingContext processingContext, WorkflowConfiguration<?> workflowConfiguration, WorkflowContext workflowContext) Constructs a new instance.WorkflowExecutionOperationsDelegation(WorkflowConfiguration<?> workflowConfiguration, WorkflowContext workflowContext, WorkflowExecution workflowExecution, RunningSteps runningSteps, io.axoniq.framework.workflow.runtime.execution.EventWaitConditions eventWaitConditions, ReachedSteps reachedSteps, io.axoniq.framework.workflow.runtime.execution.WorkflowTerminalTransition terminalTransition, ProcessingContext processingContext) Creates the context delegation. -
Uses of WorkflowContext in io.axoniq.framework.workflow.runtime.test
Classes in io.axoniq.framework.workflow.runtime.test with type parameters of type WorkflowContextModifier and TypeClassDescriptionclassAbstractWorkflowTestBase<T extends WorkflowContext>Abstract test base for workflow test, until we develop a test fixture. -
Uses of WorkflowContext in io.axoniq.framework.workflow.runtime.test.fixture
Classes in io.axoniq.framework.workflow.runtime.test.fixture with type parameters of type WorkflowContextModifier and TypeClassDescriptionclassDefaultWorkflowTestFixture<T extends WorkflowContext,ACTION extends GivenWhen<ACTION, ASSERT>, ASSERT extends Then<ASSERT, ACTION>> Default implementation ofWorkflowTestFixture.Methods in io.axoniq.framework.workflow.runtime.test.fixture with type parameters of type WorkflowContextModifier and TypeMethodDescriptionstatic <C extends WorkflowContext>
WorkflowTestDriverWorkflowTestDriver.live(WorkflowModule<C> workflowModule, boolean throwFixtureException, UnaryOperator<WorkflowConfigurer> customize) Creates a new test driver in live mode.static <C extends WorkflowContext>
WorkflowTestDriverWorkflowTestDriver.live(WorkflowModule<C> workflowModule, UnaryOperator<WorkflowConfigurer> customize) Creates a new test driver in live mode.static <T extends WorkflowContext>
WorkflowTestFixture<GivenWhen.Phase, Then.Phase> WorkflowTestFixture.of(WorkflowModule<T> workflowModule) Creates a fixture with the default action and assertion phases.static <T extends WorkflowContext>
WorkflowTestFixture<GivenWhen.Phase, Then.Phase> WorkflowTestFixture.of(WorkflowModule<T> workflowModule, UnaryOperator<WorkflowConfigurer> customize) Creates a fixture with the default action and assertion phases and a custom configuration step.static <T extends WorkflowContext,ACTION extends GivenWhen<ACTION, ASSERT>, ASSERT extends Then<ASSERT, ACTION>>
WorkflowTestFixture<ACTION, ASSERT> WorkflowTestFixture.of(WorkflowModule<T> workflowModule, UnaryOperator<WorkflowConfigurer> customize, ACTION givenWhenPhase, ASSERT thenPhase) Creates a fixture with caller-supplied action and assertion phases.static <C extends WorkflowContext>
WorkflowTestDriverWorkflowTestDriver.stepper(WorkflowModule<C> workflowModule, boolean throwFixtureException, UnaryOperator<WorkflowConfigurer> customize) Constructs a new test driver in stepping mode.static <T extends WorkflowContext>
WorkflowModule<T> WorkflowTestFixture.workflowModule(Class<T> contextType, ComponentBuilder<WorkflowContextFactory<T>> workflowContextFactoryBuilder, ComponentBuilder<Object> workflowInstanceBuilder) Builds an autodetectedWorkflowModuleregistered underWorkflowTestServices.DEFAULT_MODULE_NAME, ready to be passed intoWorkflowTestFixture.of(WorkflowModule)orWorkflowTestFixture.of(WorkflowModule, UnaryOperator).