ee.telekom.workflow.web.rest

Class RestController

java.lang.Object

ee.telekom.workflow.web.rest.RestController

@Controller
@RequestMapping(value="/api")
public class RestController
extends Object

Controller that implements a REST API. For details on individual API methods, please refer to the RequestMapping methods. Some method expect/support an argument/arguments/result field in the request body. Regardless of the deserializer (JSON: e.g. Jackson or GSON, XML:...), the values of these fields are forwarded to lower level engine methods such that maps are implemented using LinkedHashMap's and lists or arrays are implemented using ArrayList's. Furthermore, do not mix up plain JSON with the JSON base format that the engine internally uses to store, e.g., workflow instance attributes.

  {"arg1":{"refNum":1, "date":"22.09.2014"}, "arg2":[true, 1, "text"]} is forwarded by the following map:
  Map map = new LinkedHashMap<>();
  Map arg1 = new LinkedHashMap<>();
  arg1.put("refNum",1);
  arg1.put("date","22.09.2014");
  List arg2 = new ArrayList<>();
  arg2.add(true);
  arg2.add(1);
  arg2.add("text");
  map.put("arg1",arg1);
  map.put("arg2",arg2);
 

Constructor Summary

Constructors

Constructor and Description
RestController()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<WorkflowInstanceRestModel>	create(String body) Creates a new workflow instance.
String	errorHandler(Exception e)
org.springframework.http.ResponseEntity<WorkflowInstanceRestModel>	find(long woinRefNum) Finds a workflow instance.
org.springframework.http.ResponseEntity<List<HumanTaskModel>>	findActiveHumanTasks(String role, String user) Searches active human tasks by role and/or user.
org.springframework.http.ResponseEntity<List<WorkflowInstanceRestModel>>	findInstances(String label1, String label2, Boolean activeOnly) Searches workflow instance's that match the given criteria.
void	init()
org.springframework.http.ResponseEntity<Void>	sendSignal(long woinRefNum, String signal, String argument) Notifies all waiting signal work items of the given workflow instance and the given signal name.
org.springframework.http.ResponseEntity<HumanTaskModel>	updateHumanTask(long woinRefNum, int tokenId, String body) (Un)assigns a human task to a user or submits its result.
org.springframework.http.ResponseEntity<WorkflowInstanceRestModel>	updateIntance(long woinRefNum, UpdateInstanceStatusForm form) Aborts, suspends or resumes a workflow instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestController

public RestController()

Method Detail

init

@PostConstruct
public void init()

errorHandler

@ExceptionHandler
@ResponseStatus(value=INTERNAL_SERVER_ERROR)
@ResponseBody
public String errorHandler(Exception e)

create

@RequestMapping(method=POST,
                value="/workflowInstance",
                produces={"application/json","text/xml"})
public org.springframework.http.ResponseEntity<WorkflowInstanceRestModel> create(@RequestBody
                                                                                       String body)

Creates a new workflow instance.

 Request:  POST /workflowInstance {workflowName: "credit.step1", workflowVersion: null, arguments: {"arg1":{"refNum":1, "date":"22.09.2014"}, "arg2":[true, 1, "text"]}, label1: "one", label2: null }
 Response: OK, {refNum: 1, workflowName: "credit.step1", workflowVersion: null, label1: "one", label2: null, status: NEW}
 

find

@RequestMapping(method=GET,
                value="/workflowInstance/{woinRefNum}",
                produces={"application/json","text/xml"})
public org.springframework.http.ResponseEntity<WorkflowInstanceRestModel> find(@PathVariable
                                                                                     long woinRefNum)

Finds a workflow instance.

 Request:  GET /workflowInstance/1
 Response: OK {refNum: 1, workflowName: "credit.step1", workflowVersion: null, label1: "one", label2: null, status: NEW}
 Response: NOT_FOUND, if no such workflow instance exists
 

updateIntance

@RequestMapping(method=POST,
                value="/workflowInstance/{woinRefNum}",
                produces={"application/json","text/xml"})
public org.springframework.http.ResponseEntity<WorkflowInstanceRestModel> updateIntance(@PathVariable
                                                                                              long woinRefNum,
                                                                                              @RequestBody
                                                                                              UpdateInstanceStatusForm form)

Aborts, suspends or resumes a workflow instance.

 Request:  POST /workflowInstance/{woinRefNum} {status: "ABORT"}
 Response: OK, {refNum: 1, workflowName: "credit.step1", workflowVersion: null, label1: "one", label2: null, status: ABORT}
 Response: NOT_FOUND, if no such workflow instance exists
 Response: CONFLICT, if the workflow's current status does not allow the requested status transition
 Response: BAD_REQUEST, if the new status is not allowed.
 

sendSignal

@RequestMapping(method=POST,
                value="/workflowInstance/{woinRefNum}/signal/{signal}",
                produces={"application/json","text/xml"})
public org.springframework.http.ResponseEntity<Void> sendSignal(@PathVariable
                                                                      long woinRefNum,
                                                                      @PathVariable
                                                                      String signal,
                                                                      @RequestBody
                                                                      String argument)

Notifies all waiting signal work items of the given workflow instance and the given signal name. Technically, sets the work item's result value and updates the status to EXECUTED.

 Request:  POST /workflowInstance/1/signal/invoice {argument: {refNum:3, invoiceAmount: "10 Euro"}}
 Response: NO_CONTENT
 

updateHumanTask

@RequestMapping(method=POST,
                value="/workflowInstance/{woinRefNum}/humanTask/{tokenId}",
                produces={"application/json","text/xml"})
public org.springframework.http.ResponseEntity<HumanTaskModel> updateHumanTask(@PathVariable
                                                                                     long woinRefNum,
                                                                                     @PathVariable
                                                                                     int tokenId,
                                                                                     @RequestBody
                                                                                     String body)

(Un)assigns a human task to a user or submits its result. In order to unassign a human task from a user, set an empty user name. Technically, assigning means updating the user field while submitting means to update the status field to EXECUTED and setting the result value.

 Request:  POST /workflowInstance/1/humanTask/2 {result: {resolution: "completed"}}
 Response: OK, {refNum:3, woinRefNum:1, tokenId:2, status:EXECUTED, role:"auditor", user:"hans", arguments:{task:"audit customer 500"}, result: {resolution: "completed"}}
 Response: NOT_FOUND, if no such human task exists
 Response: CONFLICT, if the human task's status does not allow the requested status transition
 

findInstances

@RequestMapping(method=GET,
                value="/workflowInstance/search",
                produces={"application/json","text/xml"})
public org.springframework.http.ResponseEntity<List<WorkflowInstanceRestModel>> findInstances(@RequestParam(required=false)
                                                                                                    String label1,
                                                                                                    @RequestParam(required=false)
                                                                                                    String label2,
                                                                                                    @RequestParam(required=false)
                                                                                                    Boolean activeOnly)

Searches workflow instance's that match the given criteria.

 Request:  GET /workflowInstance/search?label1=aClientId
 Response: OK, [{refNum: 1, workflowName: "credit.step1", workflowVersion: null, label1: "aClientId", label2: null, status: NEW}, {refNum: 2, workflowName: "credit.client.step1", workflowVersion: null, label1: "aClientId", label2: "anotherIdentificator", status: NEW}]
 

findActiveHumanTasks

@RequestMapping(method=GET,
                value="/humanTask/search",
                produces={"application/json","text/xml"})
public org.springframework.http.ResponseEntity<List<HumanTaskModel>> findActiveHumanTasks(@RequestParam(required=false)
                                                                                                String role,
                                                                                                @RequestParam(required=false)
                                                                                                String user)

Searches active human tasks by role and/or user.

 Request:  GET /humanTask/search?role=auditor&user=hans
 Response: OK, [{refNum:3, woinRefNum:1, tokenId:2, status:EXECUTED, role:"auditor", user:"hans", arguments:{task:"audit customer 500"}}]