com.nirmata.workflow

Interface WorkflowManager

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

WorkflowManagerImpl

public interface WorkflowManager
extends Closeable

Main API - create via WorkflowManagerBuilder

Method Summary

Modifier and Type	Method and Description
boolean	cancelRun(RunId runId) Attempt to cancel the given run.
WorkflowAdmin	getAdmin() Return administration operations
Optional<TaskExecutionResult>	getTaskExecutionResult(RunId runId, TaskId taskId) Return the result for a given task of a given run
WorkflowListenerManager	newWorkflowListenerManager() Allocate a new WorkflowListenerManager
void	start() The manager must be started before use.
RunId	submitSubTask(RunId runId, RunId parentRunId, Task task) Same as submitTask(Task) except that, when completed, the parent run will be notified.
RunId	submitSubTask(RunId parentRunId, Task task) Same as submitTask(Task) except that, when completed, the parent run will be notified.
RunId	submitTask(RunId runId, Task task) Submit a task for execution.
RunId	submitTask(Task task) Submit a task for execution.
void	updateTaskProgress(RunId runId, TaskId taskId, int progress) Update task progress info.

Methods inherited from interface java.io.Closeable

close

Method Detail

start

void start()

The manager must be started before use. Call Closeable.close() when done with the manager. Every instance that starts a manager using the same WorkflowManagerBuilder.withCurator(CuratorFramework, String, String) namespace and version will participate in the workflow.

One instance will be nominated as the scheduler and will be responsible for starting tasks and advancing the workflow.

Task executors will be started based on the values in the WorkflowManagerBuilder. Each WorkflowManager can declare a different combination of task executors as needed.

submitTask

RunId submitTask(Task task)

Submit a task for execution. The task will start nearly immediately. There's no guarantee which instances will execute the various tasks. This method can be called by any instance. i.e. it's not necessary that this be called from the currently nominated scheduler instance.

Parameters:

task - task to execute

Returns:

the Run ID for the task

submitTask

RunId submitTask(RunId runId,
                 Task task)

Submit a task for execution. The task will start nearly immediately. There's no guarantee which instances will execute the various tasks. This method can be called by any instance. i.e. it's not necessary that this be called from the currently nominated scheduler instance.

Parameters:

runId - the RunId to use - MUST BE GLOBALLY UNIQUE

task - task to execute

Returns:

the Run ID for the task

submitSubTask

RunId submitSubTask(RunId parentRunId,
                    Task task)

Same as submitTask(Task) except that, when completed, the parent run will be notified. This method is meant to be used inside of TaskExecutor for a task that needs to initiate a sub-run and have the parent run wait for the sub-run to complete.

Parameters:

parentRunId - run id of the parent run

task - task to execute

Returns:

sub-Run ID

submitSubTask

RunId submitSubTask(RunId runId,
                    RunId parentRunId,
                    Task task)

Same as submitTask(Task) except that, when completed, the parent run will be notified. This method is meant to be used inside of TaskExecutor for a task that needs to initiate a sub-run and have the parent run wait for the sub-run to complete.

Parameters:

runId - the RunId to use - MUST BE GLOBALLY UNIQUE

parentRunId - run id of the parent run

task - task to execute

Returns:

sub-Run ID

updateTaskProgress

void updateTaskProgress(RunId runId,
                        TaskId taskId,
                        int progress)

Update task progress info. This method is meant to be used inside of TaskExecutor for a running task to update its execution progress(0-100).

Parameters:

runId - run id of the task

taskId - the task

progress - progress to be set

cancelRun

boolean cancelRun(RunId runId)

Attempt to cancel the given run. NOTE: the cancellation is scheduled and does not occur immediately. Currently executing tasks will continue. Only tasks that have not yet executed can be canceled.

Parameters:

runId - the run to cancel

Returns:

true if the run was found and the cancellation was scheduled

getTaskExecutionResult

Optional<TaskExecutionResult> getTaskExecutionResult(RunId runId,
                                                     TaskId taskId)

Return the result for a given task of a given run

Parameters:

runId - the run

taskId - the task

Returns:

if found, a loaded optional with the result. Otherwise, an empty optional.

getAdmin

WorkflowAdmin getAdmin()

Return administration operations

Returns:

admin

newWorkflowListenerManager

WorkflowListenerManager newWorkflowListenerManager()

Allocate a new WorkflowListenerManager

Returns:

new WorkflowListenerManager