Skip to content

Latest commit

 

History

History
112 lines (94 loc) · 9.09 KB

README.md

File metadata and controls

112 lines (94 loc) · 9.09 KB
Raw

KadaiAdapter

Build Status Maven Central License

Adapter to sync tasks between KADAI and an external workflow system, e.g. Camunda BPM.

Components

The Kadai Adapter repository consists of the kadai adapter, sample connectors to camunda and kadai as well as an outbox REST-service and it's SpringBoot-Starter and listeners for camunda. In addition to that there are various example and test modules

The sample implementation of the camunda-system-connector uses the outbox-pattern. The general concept of this pattern can be found here: Transactional-Outbox-Pattern.

+------------------------------------------+--------------------------------------------------------------+
| Component                                | Description                                                  |
+------------------------------------------+--------------------------------------------------------------+
| kadai-adapter                          | The adapter. Defines the service provider SPIs and APIs for  |
|                                          | - SystemConnector (connects to the external system)          |
|                                          | - KadaiConnector (connects to kadai)                     |
|                                          | These connectors are plugged in at runtime via SPI mechanisms|
+------------------------------------------+--------------------------------------------------------------+
| kadai-adapter-camunda-system-connector | Sample implementation of SystemConnector SPI.                |
|                                          | Connects to a camunda systems via camunda's REST API         |
+------------------------------------------+--------------------------------------------------------------+
| kadai-adapter-kadai-connector        | Sample implementation of KadaiConnector SPI. Connects      |
|                                          | to one kadai system via kadai's java api which           |
|                                          | accesses the database directly.                              |
+------------------------------------------+--------------------------------------------------------------+
| kadai-adapter-camunda-listener         | Contains a TaskListener, ParseListener,                      |
|                                          | ParseListenerProcessEnginePlugin and OutboxSchemaCreator as  |
|                                          | client-side components of camunda-system-connector           |
|                                          |                                   |
+------------------------------------------+--------------------------------------------------------------+
| kadai-adapter-camunda-outbox-rest      | An outbox REST-Service which allows the adapter to           | 
|                                          | query events from the outbox tables, implemented using JAX-RS|
|                                          | The concept of the outbox-pattern can be found under the     |
|                                          | "Notes for sample implementation of camunda-system-connector"|  
|                                          | section                                                      |  
+------------------------------------------+--------------------------------------------------------------+
| kadai-adapter-camunda-outbox-rest-     | SpringBoot-Starter in case the REST-Service is used within a |
| spring-boot-starter                      | SpringBoot-Application                                       |
|                                          |                                                              | 
+------------------------------------------+--------------------------------------------------------------+
| kadai-adapter-camunda-spring-boot      | SpringBoot-Application containg the adapter with the sample  |
|  -sample                                 | camunda-system-connector implementation                      |
+------------------------------------------+--------------------------------------------------------------+
| kadai-adapter-camunda-spring-boot-test | SpringBoot-Application containing camunda, the adapter and   | 
|                                          |   the outbox REST-Service to test a complete scenario        |
+------------------------------------------+--------------------------------------------------------------+
| kadai-adapter-camunda-wildfly-example  | Example that can be deployed on Wildfly and contains         |
|                                          |  the adapter with the sample camunda-system-connector        |
|                                          |  implementation                                              |
+------------------------------------------+--------------------------------------------------------------+
| kadai-adapter-camunda-listener-example | Example Process-Application that can be deployed to camunda  |
+------------------------------------------+--------------------------------------------------------------+

The Adapter defines two SPIs

  • SystemConnector SPI connects the adapter to an external system like e.g. camunda.
  • KadaiConnector SPI connects the adapter to kadai.

Both SPI implementations are loaded by the adapter at initialization time via the Java SPI mechanism. They provide plug points where custom code can be plugged in.
Please note, that the term ‘referenced task’ is used in this document to refer to tasks in the external system that is accessed via the SystemConnector

Overall Function

The adapter performs periodically the following tasks

  •     retrieveNewReferencedTasksAndCreateCorrespondingKadaiTasks
    *       retrieve newly created referenced tasks via SystemConnector.retrieveNewStartedReferencedTasks
    *       get the task’s variables via SystemConnector.retrieveVariables
    *       map referenced task to KADAI task via KadaiConnector.convertToKadaiTask
    *       create an associated KADAI task via KadaiConnector.createKadaiTask
    *	    clean the corresponding create-event in the outbox via SystemConnector.kadaiTasksHaveBeenCreatedForNewReferencedTasks

  •   retrieveFinishedReferencedTasksAndTerminateCorrespondingKadaiTasks
    *       retrieve finished referenced tasks via SystemConnector.retrieveFinishedTasks
    *       terminate corresponding KADAI tasks via KadaiConnector.terminateKadaiTask
    * 	    clean the corresponding complete/delete-event in the outbox via SystemConnector.kadaiTasksHaveBeenCompletedForTerminatedReferencedTasks

  •   retrieveFinishedKadaiTasksAndCompleteCorrespondingReferencedTasks
    *       retrieve finished KADAI tasks via KadaiConnector.retrieveCompletedKadaiTasksAsReferencedTasks
    *       complete the corresponding referenced tasks in the external system via SystemConnector.completeReferencedTask
    *       change the CallbackState of the corresponding task in KADAI to completed via KadaiConnector.changeReferencedTaskCallbackState

  •   retrieveClaimedKadaiTasksAndClaimCorrespondingReferencedTasks
    *       retrieve claimed KADAI tasks via KadaiConnector.retrieveCompletedKadaiTasksAsReferencedTasks
    *       claim the corresponding referenced tasks in the external system via SystemConnector.claimReferencedTask
    *       change the CallbackState of the corresponding task in KADAI to claimed via KadaiConnector.changeReferencedTaskCallbackState

  •   retrieveCancelledClaimKadaiTasksAndCancelClaimCorrespondingReferencedTasks
    *       retrieve cancel claimed KADAI tasks via KadaiConnector.retrieveCancelledClaimKadaiTasksAsReferencedTasks
    *       cancel the claim of the corresponding referenced tasks in the external system via SystemConnector.cancelClaimReferencedTask
    *       change the CallbackState of the corresponding task in KADAI to processing required via KadaiConnector.changeReferencedTaskCallbackState

Notes

  1. Variables
    When the adapter finds a referenced task for which a kadai task must be started, it checks the variables of the referenced task's process. If they are not already present due to retrieval from the outbox it will attempt to retrieve them from the referenced task's process. These variables are stored in the custom attributes of the corresponding kadai task in a HashMap with key * referenced_task_variables* and value of type String that contains the Json representation of the variables.
  2. Workbaskets
    The Adapter does not perform routing of tasks to workbaskets but instead relies on a SPI.