-
Notifications
You must be signed in to change notification settings - Fork 1
/
WorkflowSystemTask.java
118 lines (104 loc) · 3.98 KB
/
WorkflowSystemTask.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/*
* Copyright 2023 Swift Software Group, Inc.
* (Code and content before December 13, 2023, Copyright Netflix, Inc.)
* <p>
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package com.swiftconductor.conductor.core.execution.tasks;
import java.util.Optional;
import com.swiftconductor.conductor.common.metadata.workflow.WorkflowTask;
import com.swiftconductor.conductor.core.execution.WorkflowExecutor;
import com.swiftconductor.conductor.model.TaskModel;
import com.swiftconductor.conductor.model.WorkflowModel;
public abstract class WorkflowSystemTask {
private final String taskType;
public WorkflowSystemTask(String taskType) {
this.taskType = taskType;
}
/**
* Start the task execution.
*
* <p>Called only once, and first, when the task status is SCHEDULED.
*
* @param workflow Workflow for which the task is being started
* @param task Instance of the Task
* @param workflowExecutor Workflow Executor
*/
public void start(WorkflowModel workflow, TaskModel task, WorkflowExecutor workflowExecutor) {
// Do nothing unless overridden by the task implementation
}
/**
* "Execute" the task.
*
* <p>Called after {@link #start(WorkflowModel, TaskModel, WorkflowExecutor)}, if the task
* status is not terminal. Can be called more than once.
*
* @param workflow Workflow for which the task is being started
* @param task Instance of the Task
* @param workflowExecutor Workflow Executor
* @return true, if the execution has changed the task status. return false otherwise.
*/
public boolean execute(
WorkflowModel workflow, TaskModel task, WorkflowExecutor workflowExecutor) {
return false;
}
/**
* Cancel task execution
*
* @param workflow Workflow for which the task is being started
* @param task Instance of the Task
* @param workflowExecutor Workflow Executor
*/
public void cancel(WorkflowModel workflow, TaskModel task, WorkflowExecutor workflowExecutor) {}
public Optional<Long> getEvaluationOffset(TaskModel taskModel, long defaultOffset) {
return Optional.empty();
}
/**
* @return True if the task is supposed to be started asynchronously using internal queues.
*/
public boolean isAsync() {
return false;
}
/**
* @return True to keep task in 'IN_PROGRESS' state, and 'COMPLETE' later by an external
* message.
*/
public boolean isAsyncComplete(TaskModel task) {
if (task.getInputData().containsKey("asyncComplete")) {
return Optional.ofNullable(task.getInputData().get("asyncComplete"))
.map(result -> (Boolean) result)
.orElse(false);
} else {
return Optional.ofNullable(task.getWorkflowTask())
.map(WorkflowTask::isAsyncComplete)
.orElse(false);
}
}
/**
* @return name of the system task
*/
public String getTaskType() {
return taskType;
}
/**
* Default to true for retrieving tasks when retrieving workflow data. Some cases (e.g.
* subworkflows) might not need the tasks at all, and by setting this to false in that case, you
* can get a solid performance gain.
*
* @return true for retrieving tasks when getting workflow
*/
public boolean isTaskRetrievalRequired() {
return true;
}
@Override
public String toString() {
return taskType;
}
}