/
WorkItemProvider.java
479 lines (419 loc) · 20.2 KB
/
WorkItemProvider.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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
/*
* Copyright (c) 2010-2013 Evolveum
*
* 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
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.evolveum.midpoint.wf.impl.activiti.dao;
import com.evolveum.midpoint.prism.PrismContext;
import com.evolveum.midpoint.prism.PrismPropertyValue;
import com.evolveum.midpoint.prism.PrismReferenceValue;
import com.evolveum.midpoint.prism.PrismValue;
import com.evolveum.midpoint.prism.path.ItemPath;
import com.evolveum.midpoint.prism.query.ObjectFilter;
import com.evolveum.midpoint.prism.query.ObjectPaging;
import com.evolveum.midpoint.prism.query.ObjectQuery;
import com.evolveum.midpoint.prism.xml.XmlTypeConverter;
import com.evolveum.midpoint.schema.GetOperationOptions;
import com.evolveum.midpoint.schema.SearchResultList;
import com.evolveum.midpoint.schema.SelectorOptions;
import com.evolveum.midpoint.schema.constants.ObjectTypes;
import com.evolveum.midpoint.schema.result.OperationResult;
import com.evolveum.midpoint.schema.util.ObjectTypeUtil;
import com.evolveum.midpoint.schema.util.WfContextUtil;
import com.evolveum.midpoint.task.api.TaskManager;
import com.evolveum.midpoint.util.exception.ObjectNotFoundException;
import com.evolveum.midpoint.util.exception.SchemaException;
import com.evolveum.midpoint.util.logging.LoggingUtils;
import com.evolveum.midpoint.util.logging.Trace;
import com.evolveum.midpoint.util.logging.TraceManager;
import com.evolveum.midpoint.wf.impl.WorkflowManagerImpl;
import com.evolveum.midpoint.wf.impl.activiti.ActivitiEngine;
import com.evolveum.midpoint.wf.impl.messages.TaskEvent;
import com.evolveum.midpoint.wf.impl.processes.ProcessInterfaceFinder;
import com.evolveum.midpoint.wf.impl.processes.ProcessMidPointInterface;
import com.evolveum.midpoint.wf.impl.processes.common.ActivitiUtil;
import com.evolveum.midpoint.wf.impl.processes.common.CommonProcessVariableNames;
import com.evolveum.midpoint.wf.impl.util.MiscDataUtil;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectReferenceType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.WorkItemType;
import org.activiti.engine.TaskService;
import org.activiti.engine.task.IdentityLink;
import org.activiti.engine.task.IdentityLinkType;
import org.activiti.engine.task.Task;
import org.activiti.engine.task.TaskQuery;
import org.apache.commons.lang.StringUtils;
import org.jetbrains.annotations.NotNull;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.*;
import static com.evolveum.midpoint.schema.constants.ObjectTypes.USER;
import static com.evolveum.midpoint.schema.util.ObjectQueryUtil.FilterComponents;
import static com.evolveum.midpoint.schema.util.ObjectQueryUtil.factorOutQuery;
import static com.evolveum.midpoint.schema.util.ObjectTypeUtil.createObjectRef;
import static com.evolveum.midpoint.xml.ns._public.common.common_3.WorkItemType.*;
import static org.apache.commons.collections.CollectionUtils.isEmpty;
import static org.apache.commons.lang3.ObjectUtils.defaultIfNull;
/**
* Used to retrieve (and provide) data about work items.
*
* @author mederly
*/
@Component
public class WorkItemProvider {
private static final transient Trace LOGGER = TraceManager.getTrace(WorkItemProvider.class);
@Autowired private ActivitiEngine activitiEngine;
@Autowired private MiscDataUtil miscDataUtil;
@Autowired private PrismContext prismContext;
@Autowired private ProcessInterfaceFinder processInterfaceFinder;
@Autowired private TaskManager taskManager;
private static final String DOT_CLASS = WorkflowManagerImpl.class.getName() + ".";
private static final String OPERATION_ACTIVITI_TASK_TO_WORK_ITEM = DOT_CLASS + "activitiTaskToWorkItem";
public Integer countWorkItems(ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult result) throws SchemaException {
TaskQuery taskQuery = createTaskQuery(query, false, options, result);
return taskQuery != null ? (int) taskQuery.count() : 0;
}
public SearchResultList<WorkItemType> searchWorkItems(ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult result)
throws SchemaException {
TaskQuery taskQuery = createTaskQuery(query, true, options, result);
if (taskQuery == null) {
return new SearchResultList<>(Collections.emptyList());
}
Integer offset = query != null ? query.getOffset() : null;
Integer maxSize = query != null ? query.getMaxSize() : null;
List<Task> tasks;
if (offset == null && maxSize == null) {
tasks = taskQuery.list();
} else {
tasks = taskQuery.listPage(defaultIfNull(offset, 0), defaultIfNull(maxSize, Integer.MAX_VALUE));
}
boolean getAllVariables = true; // TODO implement based on options
// there's no need to fill-in assignee details ; but candidates are necessary to fill-in; TODO implement based on options (resolve)
return tasksToWorkItems(tasks, null, false, false, true, getAllVariables, result);
}
// primitive 'query interpreter'
// returns null if no results should be returned
private TaskQuery createTaskQuery(ObjectQuery query, boolean includeVariables, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult result) throws SchemaException {
FilterComponents components = factorOutQuery(query, F_ASSIGNEE_REF, F_CANDIDATE_REF, F_EXTERNAL_ID);
List<ObjectFilter> remainingClauses = components.getRemainderClauses();
if (!remainingClauses.isEmpty()) {
throw new SchemaException("Unsupported clause(s) in search filter: " + remainingClauses);
}
final ItemPath WORK_ITEM_ID_PATH = new ItemPath(F_EXTERNAL_ID);
final ItemPath ASSIGNEE_PATH = new ItemPath(F_ASSIGNEE_REF);
final ItemPath CANDIDATE_PATH = new ItemPath(F_CANDIDATE_REF);
final ItemPath CREATED_PATH = new ItemPath(WorkItemType.F_CREATE_TIMESTAMP);
final Map.Entry<ItemPath, Collection<? extends PrismValue>> workItemIdFilter = components.getKnownComponent(WORK_ITEM_ID_PATH);
final Map.Entry<ItemPath, Collection<? extends PrismValue>> assigneeFilter = components.getKnownComponent(ASSIGNEE_PATH);
final Map.Entry<ItemPath, Collection<? extends PrismValue>> candidateRolesFilter = components.getKnownComponent(CANDIDATE_PATH);
TaskQuery taskQuery = activitiEngine.getTaskService().createTaskQuery();
if (workItemIdFilter != null) {
Collection<? extends PrismValue> filterValues = workItemIdFilter.getValue();
if (filterValues.size() > 1) {
throw new IllegalArgumentException("In a query there must be exactly one value for workItemId: " + filterValues);
}
taskQuery = taskQuery.taskId(((PrismPropertyValue<String>) filterValues.iterator().next()).getValue());
}
if (assigneeFilter != null) {
taskQuery = addAssigneesToQuery(taskQuery, assigneeFilter);
}
if (candidateRolesFilter != null) {
// TODO what about candidate users? (currently these are not supported)
List<String> candidateGroups = MiscDataUtil.prismRefsToStrings((Collection<PrismReferenceValue>) candidateRolesFilter.getValue());
if (!candidateGroups.isEmpty()) {
taskQuery = taskQuery.taskCandidateGroupIn(candidateGroups);
} else {
return null; // no groups -> no result
}
}
if (query != null && query.getPaging() != null) {
ObjectPaging paging = query.getPaging();
if (paging.getOrderingInstructions().size() > 1) {
throw new UnsupportedOperationException("Ordering by more than one property is not supported: " + paging.getOrderingInstructions());
} else if (paging.getOrderingInstructions().size() == 1) {
ItemPath orderBy = paging.getOrderBy();
if (CREATED_PATH.equivalent(orderBy)) {
taskQuery = taskQuery.orderByTaskCreateTime();
} else {
throw new UnsupportedOperationException("Ordering by " + orderBy + " is not currently supported");
}
switch (paging.getDirection()) {
case DESCENDING: taskQuery = taskQuery.desc(); break;
case ASCENDING:
default: taskQuery = taskQuery.asc(); break;
}
}
}
if (includeVariables) {
return taskQuery
.includeTaskLocalVariables()
.includeProcessVariables();
} else {
return taskQuery;
}
}
private TaskQuery addAssigneesToQuery(TaskQuery taskQuery, Map.Entry<ItemPath, Collection<? extends PrismValue>> assigneeFilter) {
@SuppressWarnings("unchecked")
Collection<PrismReferenceValue> assigneeRefs = (Collection<PrismReferenceValue>) assigneeFilter.getValue();
if (isEmpty(assigneeRefs)) {
return taskQuery.taskUnassigned();
} else {
List<String> values = MiscDataUtil.prismRefsToStrings(assigneeRefs);
return taskQuery.taskInvolvedUser(StringUtils.join(values, ';'));
}
}
// special interface for ProcessInstanceProvider - TODO align with other interfaces
public SearchResultList<WorkItemType> getWorkItemsForProcessInstanceId(String processInstanceId, OperationResult result) {
TaskService ts = activitiEngine.getTaskService();
List<Task> tasks = ts.createTaskQuery()
.processInstanceId(processInstanceId)
.includeTaskLocalVariables()
.includeProcessVariables()
.list();
return tasksToWorkItems(tasks, null, false, true, true, true, result);
}
public WorkItemType getWorkItem(String workItemId, OperationResult result) {
TaskService ts = activitiEngine.getTaskService();
Task task = ts.createTaskQuery()
.taskId(workItemId)
.includeTaskLocalVariables()
.includeProcessVariables()
.singleResult();
return taskToWorkItem(task, null, false, false, false, false, result);
}
private SearchResultList<WorkItemType> tasksToWorkItems(List<Task> tasks, Map<String, Object> processVariables,
boolean resolveTask, boolean resolveAssignee, boolean resolveCandidates, boolean fetchAllVariables, OperationResult result) {
SearchResultList<WorkItemType> retval = new SearchResultList<>(new ArrayList<WorkItemType>());
for (Task task : tasks) {
try {
retval.add(taskToWorkItem(task, processVariables, resolveTask, resolveAssignee, resolveCandidates, fetchAllVariables, result));
} catch (RuntimeException e) {
// operation result already contains corresponding error record
LoggingUtils.logUnexpectedException(LOGGER, "Couldn't get information on activiti task {}", e, task.getId());
}
}
return retval;
}
@NotNull
public List<ObjectReferenceType> getMidpointAssignees(TaskExtract taskExtract) {
List<ObjectReferenceType> rv = new ArrayList<>();
for (IdentityLink link : taskExtract.getTaskIdentityLinks()) {
if (CommonProcessVariableNames.MIDPOINT_ASSIGNEE.equals(link.getType())) {
if (link.getUserId() != null) {
rv.add(MiscDataUtil.stringToRef(link.getUserId()));
}
if (link.getGroupId() != null) { // just for completeness (currently we don't expect groups to be here)
rv.add(MiscDataUtil.stringToRef(link.getGroupId()));
}
}
}
return rv;
}
/**
* Helper class to carry relevant data from both Task and DelegateTask (to avoid code duplication)
*/
private static class TaskExtract {
private String id;
private String assignee;
private String name;
private String processInstanceId;
private Date createTime;
private Date dueDate;
private String owner;
private String executionId;
private Map<String,Object> variables;
private List<String> candidateUsers;
private List<String> candidateGroups;
private final List<IdentityLink> taskIdentityLinks;
TaskExtract(TaskEvent task, Map<String, Object> processVariables, List<IdentityLink> taskIdentityLinks) {
id = task.getTaskId();
assignee = task.getAssigneeOid();
name = task.getTaskName();
processInstanceId = task.getProcessInstanceId();
createTime = task.getCreateTime();
dueDate = task.getDueDate();
owner = task.getOwner();
executionId = task.getExecutionId();
variables = task.getVariables();
candidateUsers = task.getCandidateUsers();
candidateGroups = task.getCandidateGroups();
addProcessVariables(processVariables);
this.taskIdentityLinks = taskIdentityLinks;
}
TaskExtract(Task task, Map<String, Object> processVariables, List<IdentityLink> taskIdentityLinks) {
id = task.getId();
assignee = task.getAssignee();
name = task.getName();
processInstanceId = task.getProcessInstanceId();
createTime = task.getCreateTime();
dueDate = task.getDueDate();
owner = task.getOwner();
executionId = task.getExecutionId();
variables = new HashMap<>();
if (task.getProcessVariables() != null) {
variables.putAll(task.getProcessVariables());
}
if (task.getTaskLocalVariables() != null) {
variables.putAll(task.getTaskLocalVariables());
}
candidateUsers = new ArrayList<>();
candidateGroups = new ArrayList<>();
for (IdentityLink link : taskIdentityLinks) {
if (IdentityLinkType.CANDIDATE.equals(link.getType())) {
if (link.getUserId() != null) {
candidateUsers.add(link.getUserId());
} else if (link.getGroupId() != null) {
candidateGroups.add(link.getGroupId());
}
}
}
addProcessVariables(processVariables);
this.taskIdentityLinks = taskIdentityLinks;
}
private void addProcessVariables(Map<String, Object> processVariables) {
if (processVariables != null) {
for (Map.Entry<String, Object> variable: processVariables.entrySet()) {
if (!variables.containsKey(variable.getKey())) {
variables.put(variable.getKey(), variable.getValue());
}
}
}
}
String getId() {
return id;
}
ObjectReferenceType getAssignee() {
return assignee != null ? MiscDataUtil.stringToRef(assignee) : null;
}
String getName() {
return name;
}
String getProcessInstanceId() {
return processInstanceId;
}
Date getCreateTime() {
return createTime;
}
Date getDueDate() {
return dueDate;
}
String getOwner() {
return owner;
}
String getExecutionId() {
return executionId;
}
Map<String,Object> getVariables() {
return variables;
}
public List<String> getCandidateUsers() {
return candidateUsers;
}
public List<String> getCandidateGroups() {
return candidateGroups;
}
public List<IdentityLink> getTaskIdentityLinks() {
return taskIdentityLinks;
}
@Override
public String toString() {
return "Task{" +
"id='" + id + '\'' +
", name='" + name + '\'' +
", processInstanceId='" + processInstanceId + '\'' +
'}';
}
}
private WorkItemType taskToWorkItem(Task task, Map<String, Object> processVariables, boolean resolveTask, boolean resolveAssignee,
boolean resolveCandidates, boolean fetchAllVariables, OperationResult result) {
if (task == null) {
return null;
}
TaskExtract taskExtract = new TaskExtract(task, processVariables, getTaskIdentityLinks(task.getId()));
return taskExtractToWorkItem(taskExtract, resolveTask, resolveAssignee, resolveCandidates, fetchAllVariables, result);
}
private List<IdentityLink> getTaskIdentityLinks(String taskId) {
return activitiEngine.getTaskService().getIdentityLinksForTask(taskId);
}
public WorkItemType taskEventToWorkItemNew(TaskEvent taskEvent, Map<String, Object> processVariables, boolean resolveTask,
boolean resolveAssignee, boolean resolveCandidates, OperationResult result) {
TaskExtract taskExtract = new TaskExtract(taskEvent, processVariables, getTaskIdentityLinks(taskEvent.getTaskId()));
return taskExtractToWorkItem(taskExtract, resolveTask, resolveAssignee, resolveCandidates, false, result);
}
public WorkItemType taskExtractToWorkItem(TaskExtract task, boolean resolveTask, boolean resolveAssignee,
boolean resolveCandidates, boolean fetchAllVariables, OperationResult parentResult) {
OperationResult result = parentResult.createSubresult(OPERATION_ACTIVITI_TASK_TO_WORK_ITEM);
result.addParam("activitiTaskId", task.getId());
result.addParam("resolveTask", resolveTask);
result.addParam("resolveAssignee", resolveAssignee);
result.addParam("resolveCandidates", resolveCandidates);
try {
WorkItemType wi = new WorkItemType(prismContext);
final Map<String, Object> variables = task.getVariables();
wi.setExternalId(task.getId());
wi.setName(task.getName());
wi.setCreateTimestamp(XmlTypeConverter.createXMLGregorianCalendar(task.getCreateTime()));
wi.setDeadline(XmlTypeConverter.createXMLGregorianCalendar(task.getDueDate()));
String taskOid = ActivitiUtil.getRequiredVariable(variables, CommonProcessVariableNames.VARIABLE_MIDPOINT_TASK_OID, String.class, null);
com.evolveum.midpoint.task.api.Task mpTask;
try {
mpTask = taskManager.getTask(taskOid, result);
if (mpTask.getWorkflowContext() == null) {
throw new IllegalStateException("No workflow context in task " + mpTask + " that owns " + wi);
}
mpTask.getWorkflowContext().getWorkItem().add(wi);
} catch (ObjectNotFoundException|SchemaException e) {
LoggingUtils.logUnexpectedException(LOGGER, "Couldn't retrieve owning task for {}", e, wi);
}
// assignees
wi.getAssigneeRef().addAll(getMidpointAssignees(task));
String originalAssigneeString = ActivitiUtil.getVariable(variables,
CommonProcessVariableNames.VARIABLE_ORIGINAL_ASSIGNEE, String.class, prismContext);
if (originalAssigneeString != null) {
wi.setOriginalAssigneeRef(MiscDataUtil.stringToRef(originalAssigneeString));
}
if (resolveAssignee) {
miscDataUtil.resolveAndStoreObjectReferences(wi.getAssigneeRef(), result);
miscDataUtil.resolveAndStoreObjectReference(wi.getOriginalAssigneeRef(), result);
}
// candidates
task.getCandidateUsers().forEach(s -> wi.getCandidateRef().add(createObjectRef(s, USER)));
task.getCandidateGroups().forEach(s -> wi.getCandidateRef().add(MiscDataUtil.stringToRef(s)));
if (resolveCandidates) {
miscDataUtil.resolveAndStoreObjectReferences(wi.getCandidateRef(), result);
}
// other
ProcessMidPointInterface pmi = processInterfaceFinder.getProcessInterface(variables);
wi.setOutput(pmi.extractWorkItemResult(variables));
String completedBy = ActivitiUtil.getVariable(variables, CommonProcessVariableNames.VARIABLE_WORK_ITEM_COMPLETED_BY, String.class, prismContext);
if (completedBy != null) {
wi.setPerformerRef(ObjectTypeUtil.createObjectRef(completedBy, ObjectTypes.USER));
}
wi.setStageNumber(pmi.getStageNumber(variables));
wi.setEscalationLevel(WfContextUtil.createEscalationLevel(pmi.getEscalationLevelNumber(variables),
pmi.getEscalationLevelName(variables),
pmi.getEscalationLevelDisplayName(variables)));
// This is just because 'variables' switches in task query DO NOT fetch all required variables...
if (fetchAllVariables) { // TODO can we do this e.g. in the task completion listener?
Map<String, Object> allVariables = activitiEngine.getTaskService().getVariables(task.getId());
wi.setProcessSpecificPart(pmi.extractProcessSpecificWorkItemPart(allVariables));
wi.getAdditionalInformation().addAll(pmi.getAdditionalInformation(allVariables));
}
return wi;
} catch (RuntimeException e) {
result.recordFatalError("Couldn't convert activiti task " + task.getId() + " to midPoint WorkItem: " + e.getMessage(), e);
throw e;
} finally {
result.computeStatusIfUnknown();
}
}
}