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

Class WorkflowLifecycleControlDelegate

java.lang.Object

io.axoniq.framework.workflow.runtime.execution.WorkflowLifecycleControlDelegate

All Implemented Interfaces:

WorkflowLifecycleControl

@Internal
public class WorkflowLifecycleControlDelegate
extends Object
implements WorkflowLifecycleControl

Delegate that applies workflow and step lifecycle-control commands on the workflow control thread.

It prepares a workflow for a terminal lifecycle event, publishes that event, and waits for the state projection. For a single-step cancellation it completes the running future, leaving the owning step executor to publish the guarded terminal step event.

Replay-drift invariant: any path that publishes a workflow- or step-level event or mutates recorded state must be guarded against replay drift first. This applies to both step-level cancellation (cancelStep → StepStatus.CANCELLED) and workflow-level termination (ctx.fail() / ctx.cancel() → terminal workflow event), because in-flight workflows replaying older code through removed steps would otherwise have a terminal event forced onto a history the new body no longer reaches.

Since:

5.4.0

Author:

Stefan Dragisic

Nested Class Summary

Nested classes/interfaces inherited from interface io.axoniq.framework.workflow.runtime.api.execution.context.WorkflowLifecycleControl

WorkflowLifecycleControl.CancelStepCommand, WorkflowLifecycleControl.CancelWorkflowCommand, WorkflowLifecycleControl.FailWorkflowCommand

Constructor Summary

Constructors

Constructor	Description
WorkflowLifecycleControlDelegate(WorkflowExecutionOperations workflowExecutionOperations, WorkflowExecution workflowExecution, RunningSteps runningSteps, ReachedSteps reachedSteps, io.axoniq.framework.workflow.runtime.execution.WorkflowTerminalTransition terminalTransition)	Constructs a lifecycle-control delegate.

Method Summary

Modifier and Type	Method	Description
boolean	cancelStep(WorkflowLifecycleControl.CancelStepCommand command)	Cancels a single running step while the workflow itself stays non-terminal.
void	cancelWorkflow(WorkflowLifecycleControl.CancelWorkflowCommand command)	Cancels the entire workflow, publishing the terminal <workflow>:CANCELLED event.
void	failWorkflow(WorkflowLifecycleControl.FailWorkflowCommand command)	Fails the entire workflow, publishing the terminal <workflow>:FAILED event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkflowLifecycleControlDelegate

@Internal
public WorkflowLifecycleControlDelegate(WorkflowExecutionOperations workflowExecutionOperations,
 WorkflowExecution workflowExecution,
 RunningSteps runningSteps,
 ReachedSteps reachedSteps,
 io.axoniq.framework.workflow.runtime.execution.WorkflowTerminalTransition terminalTransition)

Constructs a lifecycle-control delegate.

Parameters:

workflowExecutionOperations - runtime primitive-operation surface

workflowExecution - workflow execution

runningSteps - running step registry

reachedSteps - reached steps tracker

terminalTransition - owner of workflow terminal-transition execution mechanics

Method Details

cancelWorkflow

public void cancelWorkflow(WorkflowLifecycleControl.CancelWorkflowCommand command)

Description copied from interface: WorkflowLifecycleControl

Cancels the entire workflow, publishing the terminal <workflow>:CANCELLED event.

Specified by:

cancelWorkflow in interface WorkflowLifecycleControl

Parameters:

command - cancellation command.

failWorkflow

public void failWorkflow(WorkflowLifecycleControl.FailWorkflowCommand command)

Description copied from interface: WorkflowLifecycleControl

Fails the entire workflow, publishing the terminal <workflow>:FAILED event.

Specified by:

failWorkflow in interface WorkflowLifecycleControl

Parameters:

command - failure command.

cancelStep

public boolean cancelStep(WorkflowLifecycleControl.CancelStepCommand command)

Description copied from interface: WorkflowLifecycleControl

Cancels a single running step while the workflow itself stays non-terminal.

The control operation completes the step's running future exceptionally. The owning step executor subsequently authors the guarded <step>:CANCELLED event through its normal terminal-event path.

Specified by:

cancelStep in interface WorkflowLifecycleControl

Parameters:

command - step cancellation command.

Returns:

true if cancellation was initiated for a running, non-terminal step, otherwise false