/
ProcessService.java
518 lines (461 loc) · 23.6 KB
/
ProcessService.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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
/*
* Copyright 2019 Red Hat, Inc. and/or its affiliates.
*
* 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 org.jbpm.services.api;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.kie.api.command.Command;
import org.kie.api.runtime.manager.Context;
import org.kie.api.runtime.process.ProcessInstance;
import org.kie.api.runtime.process.WorkItem;
import org.kie.internal.process.CorrelationKey;
public interface ProcessService {
/**
* Starts a process with no variables
*
* @param deploymentId deployment information for the process's kjar
* @param processId The process's identifier
* @return process instance identifier
* @throws RuntimeException in case of encountered errors
* @throws DeploymentNotFoundException in case deployment with given deployment id does not exist
* @throws DeploymentNotActiveException in case deployment with given deployment id is not active
*/
Long startProcess(String deploymentId, String processId);
/**
* Starts a process with no variables
*
* @param deploymentId deployment information for the process's kjar
* @param processId The process's identifier
* @param params process variables
* @return process instance identifier
* @throws RuntimeException in case of encountered errors
* @throws DeploymentNotFoundException in case deployment with given deployment id does not exist
* @throws DeploymentNotActiveException in case deployment with given deployment id is not active
*/
Long startProcess(String deploymentId, String processId, Map<String, Object> params);
/**
* compute the process outcome for those process designed to start and finish in the same transaction. This functionality allows
* to retrieve the outcome of process variables
* @param deploymentId deployment information for the process's kjar
* @param processId the process identifier
* @param params process variables
* @return last modification of process variables.
*/
Map<String, Object> computeProcessOutcome(String deploymentId, String processId, Map<String, Object> params);
/**
* Starts a process with no variables
*
* @param deploymentId deployment information for the process's kjar
* @param processId The process's identifier
* @param correlationKey correlation key to be assigned to process instance - must be unique
* @return process instance identifier
* @throws RuntimeException in case of encountered errors
* @throws DeploymentNotFoundException in case deployment with given deployment id does not exist
* @throws DeploymentNotActiveException in case deployment with given deployment id is not active
*/
Long startProcess(String deploymentId, String processId, CorrelationKey correlationKey);
/**
* Starts a process with no variables
*
* @param deploymentId deployment information for the process's kjar
* @param processId The process's identifier
* @param correlationKey correlation key to be assigned to process instance - must be unique
* @param params process variables
* @return process instance identifier
* @throws RuntimeException in case of encountered errors
* @throws DeploymentNotFoundException in case deployment with given deployment id does not exist
* @throws DeploymentNotActiveException in case deployment with given deployment id is not active
*/
Long startProcess(String deploymentId, String processId, CorrelationKey correlationKey, Map<String, Object> params);
/**
* Starts a process with the values supplied from the current nodes
*
* @param deploymentId deployment information for the process's kjar
* @param processId The process's identifier
* @param params process variables
* @param nodeIds list of bpmn node id list where the process is going to start
* @return process instance identifier
* @throws RuntimeException in case of encountered errors
* @throws DeploymentNotFoundException in case deployment with given deployment id does not exist
* @throws DeploymentNotActiveException in case deployment with given deployment id is not active
*/
Long startProcessFromNodeIds(String deploymentId, String processId, Map<String, Object> params, String... nodeIds);
/**
* Starts a process with the values supplied from the current nodes
*
* @param deploymentId deployment information for the process's kjar
* @param processId The process's identifier
* @param key correlation key (must be unique)
* @param params process variables
* @param nodeIds list of bpmn node id list where the process is going to start.
* @return process instance identifier
* @throws RuntimeException in case of encountered errors
* @throws DeploymentNotFoundException in case deployment with given deployment id does not exist
* @throws DeploymentNotActiveException in case deployment with given deployment id is not active
*/
Long startProcessFromNodeIds(String deploymentId, String processId, CorrelationKey key, Map<String, Object> params, String... nodeIds);
/**
* Aborts the specified process
*
* @param processInstanceId process instance's unique identifier
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void abortProcessInstance(Long processInstanceId);
/**
* Aborts the specified process
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId process instance's unique identifier
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void abortProcessInstance(String deploymentId, Long processInstanceId);
/**
* Aborts all specified processes
*
* @param processInstanceIds list of process instance unique identifiers
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void abortProcessInstances(List<Long> processInstanceIds);
/**
* Aborts all specified processes
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceIds list of process instance unique identifiers
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void abortProcessInstances(String deploymentId, List<Long> processInstanceIds);
/**
* Signal an event to a single process instance
*
* @param processInstanceId the process instance's unique identifier
* @param signalName the signal's id in the process
* @param event the event object to be passed in with the event
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void signalProcessInstance(Long processInstanceId, String signalName, Object event);
/**
* Signal an event to a single process instance
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId the process instance's unique identifier
* @param signalName the signal's id in the process
* @param event the event object to be passed in with the event
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void signalProcessInstance(String deploymentId, Long processInstanceId, String signalName, Object event);
/**
* Signal an event to given list of process instances
*
* @param processInstanceIds list of process instance unique identifiers
* @param signalName the signal's id in the process
* @param event the event object to be passed in with the event
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void signalProcessInstances(List<Long> processInstanceIds, String signalName, Object event);
/**
* Signal an event to given list of process instances
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceIds list of process instance unique identifiers
* @param signalName the signal's id in the process
* @param event the event object to be passed in with the event
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void signalProcessInstances(String deploymentId, List<Long> processInstanceIds, String signalName, Object event);
/**
* Signal an event to a single process instance by correlation key
*
* @param correlationKey the process instances unique correlation key
* @param signalName the signals id in the process
* @param event the event object to be passed in with the event
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void signalProcessInstanceByCorrelationKey(CorrelationKey correlationKey, String signalName, Object event);
/**
* Signal an event to a single process instance by correlation key
*
* @param deploymentId deployment that process instance belongs to
* @param correlationKey the process instances unique correlation key
* @param signalName the signals id in the process
* @param event the event object to be passed in with the event
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void signalProcessInstanceByCorrelationKey(String deploymentId, CorrelationKey correlationKey, String signalName, Object event);
/**
* Signal an event to given list of correlation keys
*
* @param correlationKeys list of process instance unique correlation keys
* @param signalName the signal's id in the process
* @param event the event object to be passed in with the event
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void signalProcessInstancesByCorrelationKeys(List<CorrelationKey> correlationKeys, String signalName, Object event);
/**
* Signal an event to given list of correlation keys
*
* @param deploymentId deployment that process instance belongs to
* @param correlationKeys list of process instance unique correlation keys
* @param signalName the signal's id in the process
* @param event the event object to be passed in with the event
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void signalProcessInstancesByCorrelationKeys(String deploymentId, List<CorrelationKey> correlationKeys, String signalName, Object event);
/**
* Signal an event to a any process instance that listens to give signal that belongs to given deployment
*
* @param deployment information for the process's kjar
* @param signalName the signal's id in the process
* @param event the event object to be passed in with the event
* @throws DeploymentNotFoundException in case deployment unit was not found
*/
void signalEvent(String deployment, String signalName, Object event);
/**
* Returns process instance information. Will return null if no
* active process with that id is found
*
* @param processInstanceId The process instance's unique identifier
* @return Process instance information
* @throws DeploymentNotFoundException in case deployment unit was not found
*/
ProcessInstance getProcessInstance(Long processInstanceId);
/**
* Returns process instance information. Will return null if no
* active process with that id is found
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId The process instance's unique identifier
* @return Process instance information
* @throws DeploymentNotFoundException in case deployment unit was not found
*/
ProcessInstance getProcessInstance(String deploymentId, Long processInstanceId);
/**
* Returns process instance information. Will return null if no
* active process with that correlation key is found
*
* @param correlationKey correlation key assigned to process instance
* @return Process instance information
* @throws DeploymentNotFoundException in case deployment unit was not found
*/
ProcessInstance getProcessInstance(CorrelationKey correlationKey);
/**
* Returns process instance information. Will return null if no
* active process with that correlation key is found
*
* @param deploymentId deployment that process instance belongs to
* @param correlationKey correlation key assigned to process instance
* @return Process instance information
* @throws DeploymentNotFoundException in case deployment unit was not found
*/
ProcessInstance getProcessInstance(String deploymentId, CorrelationKey correlationKey);
/**
* Sets a process variable.
* @param processInstanceId The process instance's unique identifier.
* @param variableId The variable id to set.
* @param value The variable value.
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void setProcessVariable(Long processInstanceId, String variableId, Object value);
/**
* Sets a process variable.
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId The process instance's unique identifier.
* @param variableId The variable id to set.
* @param value The variable value.
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void setProcessVariable(String deploymentId, Long processInstanceId, String variableId, Object value);
/**
* Sets process variables.
*
* @param processInstanceId The process instance's unique identifier.
* @param variables map of process variables (key - variable name, value - variable value)
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void setProcessVariables(Long processInstanceId, Map<String, Object> variables);
/**
* Sets process variables.
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId The process instance's unique identifier.
* @param variables map of process variables (key - variable name, value - variable value)
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
void setProcessVariables(String deploymentId, Long processInstanceId, Map<String, Object> variables);
/**
* Gets a process instance's variable.
*
* @param processInstanceId the process instance's unique identifier.
* @param variableName the variable name to get from the process.
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
Object getProcessInstanceVariable(Long processInstanceId, String variableName);
/**
* Gets a process instance's variable.
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId the process instance's unique identifier.
* @param variableName the variable name to get from the process.
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
Object getProcessInstanceVariable(String deploymentId, Long processInstanceId, String variableName);
/**
* Gets a process instance's variable values.
*
* @param processInstanceId The process instance's unique identifier.
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
Map<String, Object> getProcessInstanceVariables(Long processInstanceId);
/**
* Gets a process instance's variable values.
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId The process instance's unique identifier.
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
Map<String, Object> getProcessInstanceVariables(String deploymentId, Long processInstanceId);
/**
* Returns all signals available in current state of given process instance
*
* @param processInstanceId process instance id
* @return list of available signals or empty list if no signals are available
*/
Collection<String> getAvailableSignals(Long processInstanceId);
/**
* Returns all signals available in current state of given process instance
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId process instance id
* @return list of available signals or empty list if no signals are available
*/
Collection<String> getAvailableSignals(String deploymentId, Long processInstanceId);
/**
* Completes the specified WorkItem with the given results
*
* @param id workItem id
* @param results results of the workItem
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws WorkItemNotFoundException in case work item with given id was not found
*/
void completeWorkItem(Long id, Map<String, Object> results);
/**
* Completes the specified WorkItem with the given results
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId process instance id that work item belongs to
* @param id workItem id
* @param results results of the workItem
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws WorkItemNotFoundException in case work item with given id was not found
*/
void completeWorkItem(String deploymentId, Long processInstanceId, Long id, Map<String, Object> results);
/**
* Abort the specified workItem
*
* @param id workItem id
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws WorkItemNotFoundException in case work item with given id was not found
*/
void abortWorkItem(Long id);
/**
* Abort the specified workItem
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId process instance id that work item belongs to
* @param id workItem id
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws WorkItemNotFoundException in case work item with given id was not found
*/
void abortWorkItem(String deploymentId, Long processInstanceId, Long id);
/**
* Returns the specified workItem
*
* @param id workItem id
* @return The specified workItem
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws WorkItemNotFoundException in case work item with given id was not found
*/
WorkItem getWorkItem(Long id);
/**
* Returns the specified workItem
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId process instance id that work item belongs to
* @param id workItem id
* @return The specified workItem
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws WorkItemNotFoundException in case work item with given id was not found
*/
WorkItem getWorkItem(String deploymentId, Long processInstanceId, Long id);
/**
* Returns active work items by process instance id.
*
* @param processInstanceId process instance id
* @return The list of active workItems for the process instance
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
List<WorkItem> getWorkItemByProcessInstance(Long processInstanceId);
/**
* Returns active work items by process instance id.
*
* @param deploymentId deployment that process instance belongs to
* @param processInstanceId process instance id
* @return The list of active workItems for the process instance
* @throws DeploymentNotFoundException in case deployment unit was not found
* @throws ProcessInstanceNotFoundException in case process instance with given id was not found
*/
List<WorkItem> getWorkItemByProcessInstance(String deploymentId, Long processInstanceId);
/**
* Executes provided command on the underlying command executor (usually KieSession)
* @param deploymentId deployment information for the process's kjar
* @param command actual command for execution
* @return results of command execution
* @throws DeploymentNotFoundException in case deployment with given deployment id does not exist
* @throws DeploymentNotActiveException in case deployment with given deployment id is not active for restricted commands (e.g. start process)
*/
public <T> T execute(String deploymentId, Command<T> command);
/**
* Executes provided command on the underlying command executor (usually KieSession)
* @param deploymentId deployment information for the process's kjar
* @param context context implementation to be used to get runtime engine
* @param command actual command for execution
* @return results of command execution
* @throws DeploymentNotFoundException in case deployment with given deployment id does not exist
* @throws DeploymentNotActiveException in case deployment with given deployment id is not active for restricted commands (e.g. start process)
*/
public <T> T execute(String deploymentId, Context<?> context, Command<T> command);
}