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

Class WorkflowExecutionOperationsDelegation

java.lang.Object

io.axoniq.framework.workflow.runtime.execution.WorkflowExecutionOperationsDelegation

All Implemented Interfaces:

AllMatchCombinator, AnyMatchCombinator, ExecutePrimitive, NoneMatchCombinator, PayloadPrimitive, PublishPrimitive, VersionPrimitive, WaitForPrimitive, WorkflowEventPublicationContext, WorkflowExecutionOperations, WorkflowLifecycleControl, DescribableComponent

public class WorkflowExecutionOperationsDelegation
extends Object
implements WorkflowExecutionOperations

Implementation of WorkflowExecutionOperations that delegates all operations to the underlying WorkflowExecution and primitive implementations.

Since:

5.4.0

Author:

Simon Zambrovski

Nested Class Summary

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

ExecutePrimitive.ExecuteCommand

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

PayloadPrimitive.ModifyPayloadCommand

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

PublishPrimitive.PublishCommand

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

VersionPrimitive.VersionCommand

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

WaitForPrimitive.WaitForCommand

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

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.

Method Summary

Modifier and Type	Method	Description
CombinatorWorkflowStepResult	allMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Combines step results when all results satisfy the predicate.
CombinatorWorkflowStepResult	anyMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Combines step results when any result satisfies the predicate.
boolean	cancelStep(WorkflowLifecycleControl.CancelStepCommand command)	Requests cancellation of a workflow step.
void	cancelWorkflow(WorkflowLifecycleControl.CancelWorkflowCommand command)	Requests cancellation of the workflow.
Clock	clock()	Returns the clock used by workflow primitives.
void	describeTo(ComponentDescriptor descriptor)	Describes this workflow context to the supplied component descriptor.
void	eventReceived(io.axoniq.framework.workflow.runtime.execution.EventWaitConditions.Awaited awaited)	Dispatches an event to the wait-for primitive.
WorkflowStepResult	execute(ExecutePrimitive.ExecuteCommand command)	Executes the step described by the given command.
ExecutorService	executorService()	Returns the executor that runs workflow work.
void	failWorkflow(WorkflowLifecycleControl.FailWorkflowCommand command)	Fails the workflow with the cause supplied by the command.
WorkflowStepResult	modifyPayload(PayloadPrimitive.ModifyPayloadCommand command)	Changes the workflow payload according to the given command.
CombinatorWorkflowStepResult	noneMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Combines step results when no result satisfies the predicate.
ProcessingContext	processingContext()	Returns the processing context of this workflow invocation.
WorkflowStepResult	publish(PublishPrimitive.PublishCommand command)	Publishes a business event as a durable workflow step according to the given command.
<T extends WorkflowContext> T	typedWorkflowContext()	Retrieves the typed author-facing workflow context.
UnitOfWorkFactory	unitOfWorkFactory()	Returns the transactional unit of work factory for short-lived workflow operations.
WorkflowStepResult	version(VersionPrimitive.VersionCommand command)	Resolves the workflow version according to the given command.
WorkflowStepResult	waitForEvent(WaitForPrimitive.WaitForCommand command)	Waits for an event according to the given command.
UnitOfWorkFactory	workflowBodyUnitOfWorkFactory()	Factory for the unit of work wrapping a workflow instance's body execution.
String	workflowId()	Returns the identifier of the workflow instance.
Map<String,@Nullable Object>	workflowPayload()	Returns the current workflow payload.
WorkflowStatus	workflowStatus()	Returns the current status of the workflow.
List<String>	workflowStepNames()	Returns the names of all known workflow steps.
String	workflowVersion()	Returns the version of the workflow definition being executed.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkflowExecutionOperationsDelegation

public 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.

Parameters:

workflowConfiguration - workflow configuration

workflowContext - author-facing context created by the factory

workflowExecution - workflow execution

runningSteps - running step registry

eventWaitConditions - event wait condition registry

reachedSteps - reached steps tracker

terminalTransition - owner of workflow terminal-transition execution mechanics

processingContext - processing context

Method Details

workflowId

public String workflowId()

Returns the identifier of the workflow instance.

Specified by:

workflowId in interface WorkflowEventPublicationContext

Returns:

the workflow instance identifier

workflowVersion

public String workflowVersion()

Returns the version of the workflow definition being executed.

Specified by:

workflowVersion in interface WorkflowEventPublicationContext

Returns:

the workflow definition version

workflowPayload

public Map<String,@Nullable Object> workflowPayload()

Returns the current workflow payload.

Specified by:

workflowPayload in interface WorkflowEventPublicationContext

Returns:

the workflow payload

modifyPayload

public WorkflowStepResult modifyPayload(PayloadPrimitive.ModifyPayloadCommand command)

Changes the workflow payload according to the given command.

Specified by:

modifyPayload in interface PayloadPrimitive

Parameters:

command - the payload modification to perform

Returns:

the result representing the modification

workflowStatus

public WorkflowStatus workflowStatus()

Returns the current status of the workflow.

Specified by:

workflowStatus in interface WorkflowExecutionOperations

Returns:

the workflow status

workflowStepNames

public List<String> workflowStepNames()

Returns the names of all known workflow steps.

Specified by:

workflowStepNames in interface WorkflowExecutionOperations

Returns:

the workflow step names

processingContext

public ProcessingContext processingContext()

Returns the processing context of this workflow invocation.

Specified by:

processingContext in interface WorkflowEventPublicationContext

Returns:

the processing context

execute

public WorkflowStepResult execute(ExecutePrimitive.ExecuteCommand command)

Executes the step described by the given command.

Specified by:

execute in interface ExecutePrimitive

Parameters:

command - the step execution command

Returns:

the result representing the step execution

waitForEvent

public WorkflowStepResult waitForEvent(WaitForPrimitive.WaitForCommand command)

Waits for an event according to the given command.

Specified by:

waitForEvent in interface WaitForPrimitive

Parameters:

command - the event wait command

Returns:

the result representing the event wait

version

public WorkflowStepResult version(VersionPrimitive.VersionCommand command)

Resolves the workflow version according to the given command.

Specified by:

version in interface VersionPrimitive

Parameters:

command - the version resolution command

Returns:

the result representing the version resolution

publish

public WorkflowStepResult publish(PublishPrimitive.PublishCommand command)

Publishes a business event as a durable workflow step according to the given command.

Specified by:

publish in interface PublishPrimitive

Parameters:

command - the publish command

Returns:

the result representing the published step

cancelWorkflow

public void cancelWorkflow(WorkflowLifecycleControl.CancelWorkflowCommand command)

Requests cancellation of the workflow.

Specified by:

cancelWorkflow in interface WorkflowLifecycleControl

Parameters:

command - the workflow cancellation command

failWorkflow

public void failWorkflow(WorkflowLifecycleControl.FailWorkflowCommand command)

Fails the workflow with the cause supplied by the command.

Specified by:

failWorkflow in interface WorkflowLifecycleControl

Parameters:

command - the workflow failure command

cancelStep

public boolean cancelStep(WorkflowLifecycleControl.CancelStepCommand command)

Requests cancellation of a workflow step.

Specified by:

cancelStep in interface WorkflowLifecycleControl

Parameters:

command - the step cancellation command

Returns:

true when the cancellation was accepted

allMatch

public CombinatorWorkflowStepResult allMatch(Predicate<WorkflowStepResult> predicate,
 WorkflowStepResult... results)

Combines step results when all results satisfy the predicate.

Specified by:

allMatch in interface AllMatchCombinator

Parameters:

predicate - predicate each result must satisfy

results - results to combine

Returns:

the combined step result

anyMatch

public CombinatorWorkflowStepResult anyMatch(Predicate<WorkflowStepResult> predicate,
 WorkflowStepResult... results)

Combines step results when any result satisfies the predicate.

Specified by:

anyMatch in interface AnyMatchCombinator

Parameters:

predicate - predicate at least one result must satisfy

results - results to combine

Returns:

the combined step result

noneMatch

public CombinatorWorkflowStepResult noneMatch(Predicate<WorkflowStepResult> predicate,
 WorkflowStepResult... results)

Combines step results when no result satisfies the predicate.

Specified by:

noneMatch in interface NoneMatchCombinator

Parameters:

predicate - predicate no result may satisfy

results - results to combine

Returns:

the combined step result

clock

public Clock clock()

Returns the clock used by workflow primitives.

Returns:

the workflow clock

unitOfWorkFactory

public UnitOfWorkFactory unitOfWorkFactory()

Returns the transactional unit of work factory for short-lived workflow operations.

Returns:

the transactional unit of work factory

workflowBodyUnitOfWorkFactory

public UnitOfWorkFactory workflowBodyUnitOfWorkFactory()

Factory for the unit of work wrapping a workflow instance's body execution.

The body-wrapper unit of work stays open for the workflow instance's entire lifetime, including any time the body spends parked at awaitEvent, sleep, or retry backoff. It is therefore non-transactional, as a transaction bound to it would hold its resources per in-flight instance for as long as the instance lives. Workflow and step events are published in short-lived child units of work created from the transactional unitOfWorkFactory() instead.

Returns:

the non-transactional unit of work factory used for the workflow-body wrapper

executorService

public ExecutorService executorService()

Returns the executor that runs workflow work.

Returns:

the workflow executor

eventReceived

@Internal
public void eventReceived(io.axoniq.framework.workflow.runtime.execution.EventWaitConditions.Awaited awaited)

Dispatches an event to the wait-for primitive.

Parameters:

awaited - event arrival wrapper object

typedWorkflowContext

public <T extends WorkflowContext> T typedWorkflowContext()

Retrieves the typed author-facing workflow context.

Type Parameters:

T - workflow context type

Returns:

typed workflow context created by the factory

describeTo

public void describeTo(ComponentDescriptor descriptor)

Describes this workflow context to the supplied component descriptor.

Specified by:

describeTo in interface DescribableComponent

Parameters:

descriptor - descriptor to populate