Package com.broadleafcommerce.workflow.service

Interface WorkflowRunner

All Superinterfaces:
org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
All Known Implementing Classes:
DefaultWorkflowRunner
public interface WorkflowRunner extends org.springframework.context.SmartLifecycle
Worker component (in a thread pool - see WorkflowLauncher) that handles calling SimpleWorkflow.start(Map), or handles reconstitution of workflow state via replay. The latter is usually performed to handle WorkflowService.readOrchestrationMap(String, ContextInfo) and WorkflowService.readHistoryElements(String, ContextInfo) calls.

  • Field Summary

    Fields inherited from interface org.springframework.context.SmartLifecycle

    DEFAULT_PHASE

  • Method Summary

    Modifier and Type
    Method
    Description
    com.broadleafcommerce.orchestration.client.SimpleWorkflow
    replay(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Rebuild the state for a workflow from previous runs (without actually executing any activities)
    CompletableFuture<String>
    run(Informational workflow)
    Execute the SimpleWorkflow.start(Map) call asynchronously.

    Methods inherited from interface org.springframework.context.Lifecycle

    isRunning, start, stop

    Methods inherited from interface org.springframework.context.SmartLifecycle

    getPhase, isAutoStartup, isPauseable, stop

  • Method Details

    • run

      CompletableFuture<String> run(Informational workflow)
      Execute the SimpleWorkflow.start(Map) call asynchronously.
      Parameters:
      workflow - Information about the workflow to execute
      Returns:
      A callback for when the thread completes

    • replay

      com.broadleafcommerce.orchestration.client.SimpleWorkflow replay(String id, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Rebuild the state for a workflow from previous runs (without actually executing any activities)
      Parameters:
      id - The primary key for the workflow
      contextInfo - Data tracking context information
      Returns:
      The reconstituted state