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

Class PrimitiveCommands

java.lang.Object

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

public class PrimitiveCommands
extends Object

Commands helper.

Since:

5.4.0

Author:

Simon Zambrovski

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PrimitiveCommands.SimplePublishCommand	Default publish command implementation.
static final record	PrimitiveCommands.SimpleVersionCommand	Default version command implementation.
static final record	PrimitiveCommands.WorkflowStepResultExecuteCommand	Default execute command implementation.
static final record	PrimitiveCommands.WorkflowStepResultModifyPayloadCommand	Default payload modification command implementation allowing asynchronous execution and returning the invalid reference WorkflowStepResult .
static final record	PrimitiveCommands.WorkflowStepResultWaitForCommand	Default wait-for-event command implementation allowing asynchronous execution and returning the invalid reference WorkflowStepResult .

Method Summary

Modifier and Type	Method	Description
static WorkflowLifecycleControl.CancelStepCommand	cancelStep(String stepName, @Nullable Throwable cause, EventNameCustomizer eventNameCustomizer)	Creates a command cancelling one running step.
static WorkflowLifecycleControl.CancelWorkflowCommand	cancelWorkflow(@Nullable Throwable cause, EventNameCustomizer eventNameCustomizer)	Creates a command cancelling an entire workflow.
static WorkflowLifecycleControl.FailWorkflowCommand	failWorkflow(@Nullable Throwable cause, EventNameCustomizer eventNameCustomizer)	Creates a command failing an entire workflow.
static PrimitiveCommands.WorkflowStepResultModifyPayloadCommand	modifyPayload(String stepName, PayloadModification payloadModification, EventNameCustomizer eventNameCustomizer)	Factory method to create a PrimitiveCommands.WorkflowStepResultModifyPayloadCommand.
static PrimitiveCommands.SimplePublishCommand	publish(String stepName, EventMessage event)	Factory method to create a PrimitiveCommands.SimplePublishCommand, the parameter object of PublishPrimitive.publish(PublishPrimitive.PublishCommand).
static PrimitiveCommands.SimpleVersionCommand	version(String stepName, String newVersion, EventNameCustomizer eventNameCustomizer)	Factory method to create a PrimitiveCommands.SimpleVersionCommand.
static PrimitiveCommands.WorkflowStepResultWaitForCommand	waitForEvent(String stepName, EventCondition eventCondition, PayloadReducer resultPayloadReducer, Duration duration, EventNameCustomizer eventNameCustomizer)	Factory method to create a PrimitiveCommands.WorkflowStepResultWaitForCommand.

Methods inherited from class java.lang.Object

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

Method Details

waitForEvent

public static PrimitiveCommands.WorkflowStepResultWaitForCommand waitForEvent(String stepName,
 EventCondition eventCondition,
 PayloadReducer resultPayloadReducer,
 Duration duration,
 EventNameCustomizer eventNameCustomizer)

Factory method to create a PrimitiveCommands.WorkflowStepResultWaitForCommand.

Parameters:

stepName - step name

eventCondition - event condition

resultPayloadReducer - result payload reducer

duration - timeout duration

eventNameCustomizer - event name customizer

Returns:

command object

modifyPayload

public static PrimitiveCommands.WorkflowStepResultModifyPayloadCommand modifyPayload(String stepName,
 PayloadModification payloadModification,
 EventNameCustomizer eventNameCustomizer)

Factory method to create a PrimitiveCommands.WorkflowStepResultModifyPayloadCommand.

Parameters:

stepName - step name

payloadModification - payload modification

eventNameCustomizer - event name customizer

Returns:

command object

version

public static PrimitiveCommands.SimpleVersionCommand version(String stepName,
 String newVersion,
 EventNameCustomizer eventNameCustomizer)

Factory method to create a PrimitiveCommands.SimpleVersionCommand.

Parameters:

stepName - logical step name (developer-chosen identifier describing the change).

newVersion - new workflow version to record (semver string).

eventNameCustomizer - event name customizer.

Returns:

command object.

publish

public static PrimitiveCommands.SimplePublishCommand publish(String stepName,
 EventMessage event)

Factory method to create a PrimitiveCommands.SimplePublishCommand, the parameter object of PublishPrimitive.publish(PublishPrimitive.PublishCommand).

The command carries the stepName under which the step is recorded in the workflow state, and the EventMessage to publish. The primitive appends that event once, enriched with workflow metadata, and skips the append on replay when the step is already recorded.

Parameters:

stepName - logical step name recorded with the published event

event - event to publish

Returns:

command object

cancelWorkflow

public static WorkflowLifecycleControl.CancelWorkflowCommand cancelWorkflow(@Nullable Throwable cause,
 EventNameCustomizer eventNameCustomizer)

Creates a command cancelling an entire workflow.

Parameters:

cause - optional cancellation cause

eventNameCustomizer - customizer for published event names

Returns:

workflow cancellation command

failWorkflow

public static WorkflowLifecycleControl.FailWorkflowCommand failWorkflow(@Nullable Throwable cause,
 EventNameCustomizer eventNameCustomizer)

Creates a command failing an entire workflow.

Parameters:

cause - optional failure cause

eventNameCustomizer - customizer for published event names

Returns:

workflow failure command

cancelStep

public static WorkflowLifecycleControl.CancelStepCommand cancelStep(String stepName,
 @Nullable Throwable cause,
 EventNameCustomizer eventNameCustomizer)

Creates a command cancelling one running step.

Parameters:

stepName - logical name of the step

cause - optional cancellation cause

eventNameCustomizer - customizer for published event names

Returns:

step cancellation command