Package io.axoniq.framework.workflow.dsl.api

@NullMarked package io.axoniq.framework.workflow.dsl.api

Author-facing DSL entry points, step-definition value types, event conditions, and workflow lifecycle exceptions. These types describe a workflow author's intent; the runtime translates them into execution commands.

Since:

5.4.0

Related Packages

Package	Description
io.axoniq.framework.workflow.dsl
io.axoniq.framework.workflow.dsl.api.retry	Retry policy configuration for workflow execute steps, including backoff strategies and retry callbacks.
io.axoniq.framework.workflow.dsl.base	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.
io.axoniq.framework.workflow.dsl.simple	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.

Class	Description
CancelStepDefinition	Specification for terminating a single step with cancellation.
CancelWorkflowDefinition	Specification for terminating a workflow with cancellation.
Cause	Contract describing the cause of a workflow or step failure.
CombinatorWorkflowStepResult	Result type that all combinator methods (AnyMatchCombinator.anyMatch(java.util.function.Predicate<io.axoniq.framework.workflow.dsl.api.WorkflowStepResult>, io.axoniq.framework.workflow.dsl.api.WorkflowStepResult...), NoneMatchCombinator.noneMatch(java.util.function.Predicate<io.axoniq.framework.workflow.dsl.api.WorkflowStepResult>, io.axoniq.framework.workflow.dsl.api.WorkflowStepResult...), AllMatchCombinator.allMatch(java.util.function.Predicate<io.axoniq.framework.workflow.dsl.api.WorkflowStepResult>, io.axoniq.framework.workflow.dsl.api.WorkflowStepResult...)) are required to return.
EventAssociationsUtils	DSL-level helpers for authoring serialized event associations.
EventCondition	Represents a condition for event receipt.
EventConditions	Helper for construction of EventCondition.
EventNameCustomizer	Customizes workflow event names.
ExecuteStepDefinition	Specification for executing an action within a workflow.
FailWorkflowDefinition	Specification for terminating a workflow with failure.
Payload	Payload manipulation helper.
PayloadMapping	Reusable payload mapping shared by primitive specs.
PayloadModification	Payload modification interface.
PayloadProcessor	Action executed consuming payload and returning payload as a result run in a provided processing context.
PayloadReducer	Payload reducer to combine two payloads into one.
PayloadStepDefinition	Specification for modifying of payload within a workflow.
PrimitiveMetadata	Reusable metadata shared by primitive specs.
PublishStepDefinition	Specification for a ctx.publish(stepName, event) call.
StepCancellationException	Exception thrown when an individual step is cancelled.
StepFailedException	Base exception type for individual step failures surfaced by the DSL.
StepIndeterminateException	Exception used as the failure cause when a step's action was in-flight at a crash and, under the engine's at-most-once execution guarantee, is not re-run on recovery.
StepInterruptedException	Exception thrown into the workflow body when a step's blocking wait is interrupted because the workflow itself reached a terminal state (cancelled, failed, timed out) or the engine is shutting down.
StepRetryInfo	Payload for the RETRYING event.
StepStatus	Step status.
StepTimedOutException	Exception thrown when an individual step reaches its configured timeout before completing.
Timing	Reusable timing configuration shared by primitive specs.
VersionStepDefinition	Specification for a ctx.migrateVersion(changeId, newVersion) call.
WaitForStepDefinition	Specification for waiting for an event within a workflow.
WorkflowCancelledException	Exception thrown when a workflow is cancelled via the terminate primitive.
WorkflowContext	Author-facing DSL API based on step definitions.
WorkflowError	Compact, serialization-friendly representation of a Throwable stored in workflow events.
WorkflowExecutionException	Stackless RuntimeException produced when a WorkflowError is rehydrated from an event payload.
WorkflowFailedException	Exception thrown when a workflow fails.
WorkflowState	State of a workflow execution.
WorkflowStatus	Status of the workflow execution.
WorkflowStep	Basic step of workflow execution.
WorkflowStepResult	Represents a result of a step execution.