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

Class AbstractStepExecutor

java.lang.Object

io.axoniq.framework.workflow.runtime.execution.AbstractStepExecutor

Direct Known Subclasses:

ExecuteDelegate, PayloadDelegate, RetryableExecuteDelegate, WaitForDelegate

@Internal
public abstract class AbstractStepExecutor
extends Object

Abstract class for step executor implementations.

Since:

5.4.0

Author:

Simon Zambrovski

Field Summary

Fields

Modifier and Type	Field	Description
protected final Clock	clock
protected final EventNameCustomizer	parentEventNameCustomizer
protected final ReachedSteps	reachedSteps
protected final RunningSteps	runningSteps
protected final WorkflowScheduler	timeoutScheduler
protected final WorkflowExecution	workflowExecution
protected final WorkflowExecutionOperations	workflowExecutionOperations

Constructor Summary

Constructors

Constructor	Description
AbstractStepExecutor(WorkflowExecutionOperations workflowExecutionOperations, WorkflowExecution workflowExecution, RunningSteps runningSteps, ReachedSteps reachedSteps, EventNameCustomizer parentEventNameCustomizer, Clock clock, WorkflowScheduler timeoutScheduler)	Constructs the abstract step executor.

Method Summary

Modifier and Type	Method	Description
protected void	acceptAllPendingTasksForStep(String stepName)
protected CompletableFuture<Void>	appendEvent(EventMessage eventMessage, Context context)	Appends the given eventMessage under its append condition, deriving the append's unit of work from the given context.
protected CompletableFuture<Void>	cancelled(String stepName, EventNameCustomizer eventNameCustomizer)
protected CompletableFuture<Void>	cancelled(String stepName, @Nullable Throwable cause, EventNameCustomizer eventNameCustomizer)
protected CompletableFuture<Void>	cancelledWaitForEvent(String stepName, @Nullable Throwable cause, EventNameCustomizer eventNameCustomizer)
protected CompletableFuture<Void>	completed(String stepName, Map<String,@Nullable Object> payload, EventNameCustomizer eventNameCustomizer)
protected CompletableFuture<Void>	completed(String stepName, Map<String,@Nullable Object> payload, @Nullable String payloadReducerName, EventNameCustomizer eventNameCustomizer)
protected CompletableFuture<Void>	completedWaitForEvent(String stepName, Map<String,@Nullable Object> payload, @Nullable String payloadReducerName, EventNameCustomizer eventNameCustomizer)
protected Map<String,@Nullable Object>	eventMessagePayload(EventMessage eventMessage)
protected CompletableFuture<Void>	failed(String stepName, Throwable ex, EventNameCustomizer eventNameCustomizer)
protected Context	getContext(String stepName)
static boolean	isCancellation(Throwable error)	Determines whether an exceptional step completion represents cancellation rather than failure or interruption.
protected void	registerParkedStep(String stepName, CompletableFuture<?> parkedPhase, EventNameCustomizer eventNameCustomizer, Runnable onCancelled)	Registers the given future as the step's running phase while the step is parked (a wait timeout window, a retry backoff window).
protected void	registerParkedStep(String stepName, CompletableFuture<?> parkedPhase, Runnable cancelTimer, EventNameCustomizer eventNameCustomizer, Runnable onCancelled)	Registers a parked step and owns the lifetime of its timer.
protected CompletableFuture<Void>	retrying(String stepName, StepRetryInfo retryInfo, EventNameCustomizer eventNameCustomizer)
protected CompletableFuture<Void>	retryStarted(String stepName, StepRetryInfo retryInfo, EventNameCustomizer eventNameCustomizer)
protected Map<String,@Nullable Object>	sanitize(@Nullable Map<String,@Nullable Object> payload)
protected CompletableFuture<Void>	started(String stepName, Map<String,@Nullable Object> payload, EventNameCustomizer eventNameCustomizer)
protected CompletableFuture<Void>	startedWaitForEvent(String stepName, Map<String,@Nullable Object> payload, EventNameCustomizer eventNameCustomizer)
static WorkflowStepResult	stateBased(String stepName, EventNameCustomizer eventNameCustomizer, WorkflowExecution workflowExecution)	Creates a durable result handle for a step while retaining its event-name customizer for later cancellation.
protected CompletableFuture<Void>	timedOut(String stepName, EventNameCustomizer eventNameCustomizer)
protected CompletableFuture<Void>	timedOut(String stepName, Instant timeoutTimestamp, EventNameCustomizer eventNameCustomizer)
protected CompletableFuture<Void>	timedOutWaitForEvent(String stepName, EventNameCustomizer eventNameCustomizer)
protected CompletableFuture<Void>	timedOutWaitForEvent(String stepName, Instant timeoutTimestamp, EventNameCustomizer eventNameCustomizer)
protected static Throwable	unwrapCancellation(Throwable e)
protected static Throwable	unwrapCompletionException(Throwable e)

Methods inherited from class java.lang.Object

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

Field Details

workflowExecutionOperations

protected final WorkflowExecutionOperations workflowExecutionOperations

workflowExecution

protected final WorkflowExecution workflowExecution

runningSteps

protected final RunningSteps runningSteps

reachedSteps

protected final ReachedSteps reachedSteps

clock

protected final Clock clock

parentEventNameCustomizer

protected final EventNameCustomizer parentEventNameCustomizer

timeoutScheduler

protected final WorkflowScheduler timeoutScheduler

Constructor Details

AbstractStepExecutor

@Internal
public AbstractStepExecutor(WorkflowExecutionOperations workflowExecutionOperations,
 WorkflowExecution workflowExecution,
 RunningSteps runningSteps,
 ReachedSteps reachedSteps,
 EventNameCustomizer parentEventNameCustomizer,
 Clock clock,
 WorkflowScheduler timeoutScheduler)

Constructs the abstract step executor.

Parameters:

workflowExecutionOperations - runtime primitive-operation surface

workflowExecution - workflow execution

runningSteps - running step registry

reachedSteps - reached steps tracker

parentEventNameCustomizer - parent event name customizer

clock - clock for time calculations

timeoutScheduler - timeout scheduler

Method Details

isCancellation

public static boolean isCancellation(Throwable error)

Determines whether an exceptional step completion represents cancellation rather than failure or interruption.

Parameters:

error - completion error to classify

Returns:

true when the error represents step or workflow cancellation

unwrapCancellation

protected static Throwable unwrapCancellation(Throwable e)

unwrapCompletionException

protected static Throwable unwrapCompletionException(Throwable e)

stateBased

public static WorkflowStepResult stateBased(String stepName,
 EventNameCustomizer eventNameCustomizer,
 WorkflowExecution workflowExecution)

Creates a durable result handle for a step while retaining its event-name customizer for later cancellation.

Parameters:

stepName - logical name of the step

eventNameCustomizer - customizer originally supplied for the step primitive

workflowExecution - execution providing state access and cancellation delegation

Returns:

state-backed step result handle

acceptAllPendingTasksForStep

protected void acceptAllPendingTasksForStep(String stepName)

getContext

protected Context getContext(String stepName)

started

protected CompletableFuture<Void> started(String stepName,
 Map<String,@Nullable Object> payload,
 EventNameCustomizer eventNameCustomizer)

startedWaitForEvent

protected CompletableFuture<Void> startedWaitForEvent(String stepName,
 Map<String,@Nullable Object> payload,
 EventNameCustomizer eventNameCustomizer)

completed

protected CompletableFuture<Void> completed(String stepName,
 Map<String,@Nullable Object> payload,
 EventNameCustomizer eventNameCustomizer)

completed

protected CompletableFuture<Void> completed(String stepName,
 Map<String,@Nullable Object> payload,
 @Nullable String payloadReducerName,
 EventNameCustomizer eventNameCustomizer)

completedWaitForEvent

protected CompletableFuture<Void> completedWaitForEvent(String stepName,
 Map<String,@Nullable Object> payload,
 @Nullable String payloadReducerName,
 EventNameCustomizer eventNameCustomizer)

cancelled

protected CompletableFuture<Void> cancelled(String stepName,
 EventNameCustomizer eventNameCustomizer)

cancelled

protected CompletableFuture<Void> cancelled(String stepName,
 @Nullable Throwable cause,
 EventNameCustomizer eventNameCustomizer)

registerParkedStep

protected void registerParkedStep(String stepName,
 CompletableFuture<?> parkedPhase,
 EventNameCustomizer eventNameCustomizer,
 Runnable onCancelled)

Registers the given future as the step's running phase while the step is parked (a wait timeout window, a retry backoff window). When the future is completed exceptionally with a cancellation cause, the step is recorded CANCELLED through the guarded publish path and the cleanup hook runs; any other completion only removes the running-step registration, leaving the durable step state untouched.

Parameters:

stepName - name of the parked step

parkedPhase - future representing the parked phase

eventNameCustomizer - event name customizer of the step

onCancelled - cleanup to run when the parked phase is cancelled

registerParkedStep

protected void registerParkedStep(String stepName,
 CompletableFuture<?> parkedPhase,
 Runnable cancelTimer,
 EventNameCustomizer eventNameCustomizer,
 Runnable onCancelled)

Registers a parked step and owns the lifetime of its timer.

Parameters:

stepName - name of the parked step

parkedPhase - future representing the parked phase

cancelTimer - cancels the timer associated with the parked phase

eventNameCustomizer - event name customizer of the step

onCancelled - cleanup to run when the parked phase is cancelled

cancelledWaitForEvent

protected CompletableFuture<Void> cancelledWaitForEvent(String stepName,
 @Nullable Throwable cause,
 EventNameCustomizer eventNameCustomizer)

failed

protected CompletableFuture<Void> failed(String stepName,
 Throwable ex,
 EventNameCustomizer eventNameCustomizer)

retrying

protected CompletableFuture<Void> retrying(String stepName,
 StepRetryInfo retryInfo,
 EventNameCustomizer eventNameCustomizer)

retryStarted

protected CompletableFuture<Void> retryStarted(String stepName,
 StepRetryInfo retryInfo,
 EventNameCustomizer eventNameCustomizer)

timedOut

protected CompletableFuture<Void> timedOut(String stepName,
 EventNameCustomizer eventNameCustomizer)

timedOut

protected CompletableFuture<Void> timedOut(String stepName,
 Instant timeoutTimestamp,
 EventNameCustomizer eventNameCustomizer)

timedOutWaitForEvent

protected CompletableFuture<Void> timedOutWaitForEvent(String stepName,
 EventNameCustomizer eventNameCustomizer)

timedOutWaitForEvent

protected CompletableFuture<Void> timedOutWaitForEvent(String stepName,
 Instant timeoutTimestamp,
 EventNameCustomizer eventNameCustomizer)

appendEvent

protected CompletableFuture<Void> appendEvent(EventMessage eventMessage,
 Context context)

Appends the given eventMessage under its append condition, deriving the append's unit of work from the given context. Use this from a primitive that publishes an event without the step guards of sendStepEvent, so every append still shares one condition and one fencing path.

Parameters:

eventMessage - the event to append.

context - the context the append's unit of work derives its resources from.

Returns:

a future completing once the event is appended.

sanitize

protected Map<String,@Nullable Object> sanitize(@Nullable Map<String,@Nullable Object> payload)

eventMessagePayload

protected Map<String,@Nullable Object> eventMessagePayload(EventMessage eventMessage)