holunda-io · zambrovski · Nov 21, 2023 · Nov 21, 2023 · Nov 23, 2023 · Nov 23, 2023
diff --git a/.gitignore b/.gitignore
@@ -7,6 +7,7 @@
 .meta-data/
 .DS_Store
 target/
+site/
 pom.xml.versionsBackup
 
 # java mem

diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -61,10 +61,10 @@ class JavaDelegates {
   @Bean
   public JavaDelegate calculateOrderPositions() {
     return execution -> {
-      OrderPosition orderPosition = ORDER_POSITION.from(execution).get();
-      BigDecimal oldTotal = ORDER_TOTAL.from(execution).getOptional().orElse(BigDecimal.ZERO);
+      OrderPosition orderPosition = VariableScopeReader.of(ORDER_POSITION, execution).get();
+      BigDecimal oldTotal = VariableScopeReader.of(ORDER_TOTAL, execution).getOptional().orElse(BigDecimal.ZERO);
       BigDecimal newTotal = oldTotal.add(orderPosition.getNetCost().multiply(BigDecimal.valueOf(orderPosition.getAmount())));
-      ORDER_TOTAL.on(execution).setLocal(newTotal);
+      VariableScopeWriter.of(ORDER_TOTAL, execution).setLocal(newTotal);
     };
   }
 }
@@ -92,7 +92,7 @@ public class ApproveOrderTaskController {
 
     @GetMapping("/{taskId}")
     public ResponseEntity<ApproveTaskDto> loadTask(@PathVariable("taskId") String taskId) {
-        Order order = ORDER.from(taskService, taskId).get();
+        Order order = VariableScopeReader.of(ORDER, taskService, taskId).get();
         return ResponseEntity.ok(new ApproveTaskDto(order));
     }
 

diff --git a/docs/user-guide/examples-kotlin.md b/docs/user-guide/examples-kotlin.md
@@ -23,7 +23,7 @@ class JavaDelegates {
 
     @Bean
     fun calculateOrderPositions() = JavaDelegate { execution ->
-        val orderPosition = ORDER_POSITION.from(execution).get()
+        val orderPosition = VariableScopeReader.of(ORDER_POSITION, execution).get()
         // order position is of type OrderPosition
     }
 }
@@ -39,8 +39,8 @@ class JavaDelegates {
 
     @Bean
     fun calculateOrderPositions() = JavaDelegate { execution ->
-        val orderPosition = ORDER_POSITION.from(execution).get()
-        ORDER_TOTAL.on(execution).set {
+        val orderPosition = VariableScopeReader.of(ORDER_POSITION, execution).get()
+        VariableScopeWriter.of(ORDER_TOTAL, execution).set {
             orderPosition.netCost.times(BigDecimal.valueOf(orderPosition.amount))
         }
     }
@@ -55,7 +55,7 @@ class JavaDelegates {
 
     @Bean
     fun removeTotal() = JavaDelegate { execution ->
-        ORDER_TOTAL.on(execution).remove()
+        VariableScopeWriter.of(ORDER_TOTAL, execution).remove()
     }
 }
 ```
@@ -69,8 +69,8 @@ class JavaDelegates {
 
     @Bean
     fun calculateOrderPositions() = JavaDelegate { execution ->
-        val orderPosition = ORDER_POSITION.from(execution).get()
-        ORDER_TOTAL.on(execution).update {
+        val orderPosition = VariableScopeReader.of(ORDER_POSITION, execution).get()
+        VariableScopeWriter.of(ORDER_TOTAL, execution).update {
             it.plus(orderPosition.netCost.times(BigDecimal.valueOf(orderPosition.amount)))
         }
     }

diff --git a/docs/user-guide/examples-no-engine.md b/docs/user-guide/examples-no-engine.md
@@ -22,9 +22,9 @@ In the same time, we started a discussion with Camunda Team to provide a dedicat
 
 ``` xml
 <dependency>
-      <groupId>io.holunda.camunda-api</groupId>
-      <artifactId>camunda-bpm-engine-api</artifactId>
-      <version>${camunda.version}</version>
+  <groupId>io.holunda.camunda-api</groupId>
+  <artifactId>camunda-bpm-engine-api</artifactId>
+  <version>${camunda.version}</version>
 </dependency>
 ```
 

diff --git a/docs/user-guide/motivation.md b/docs/user-guide/motivation.md
@@ -5,6 +5,8 @@ This consists of:
 
 * `RuntimeService` methods
 * `TaskService` methods
+* `CaseService` methods
+* `ExernalTaskService` methods
 * Methods on `DelegateExecution`
 * Methods on `DelegateTask`
 * `VariableMap`

diff --git a/example/coverage-report-aggregator/pom.xml b/example/coverage-report-aggregator/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.holunda.data.example</groupId>
     <artifactId>camunda-bpm-data-example-parent</artifactId>
-    <version>1.5.1-SNAPSHOT</version>
+    <version>1.6.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>camunda-bpm-data-coverage-report</artifactId>
@@ -20,7 +20,7 @@
   <dependencies>
     <dependency>
       <groupId>io.holunda.data</groupId>
-      <artifactId>camunda-bpm-data</artifactId>
+      <artifactId>camunda-bpm-data-c7</artifactId>
       <version>${project.version}</version>
       <scope>compile</scope>
     </dependency>

diff --git a/example/example-java/pom.xml b/example/example-java/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.holunda.data.example</groupId>
     <artifactId>camunda-bpm-data-example-parent</artifactId>
-    <version>1.5.1-SNAPSHOT</version>
+    <version>1.6.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>camunda-bpm-data-example-java</artifactId>

diff --git a/example/example-kotlin/pom.xml b/example/example-kotlin/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.holunda.data.example</groupId>
     <artifactId>camunda-bpm-data-example-parent</artifactId>
-    <version>1.5.1-SNAPSHOT</version>
+    <version>1.6.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>camunda-bpm-data-example-kotlin</artifactId>

diff --git a/example/example-kotlin/src/main/kotlin/process/OrderApproval.kt b/example/example-kotlin/src/main/kotlin/process/OrderApproval.kt
@@ -16,6 +16,8 @@ import io.holunda.camunda.bpm.data.guard.VariablesGuard
 import io.holunda.camunda.bpm.data.guard.condition.exists
 import io.holunda.camunda.bpm.data.guard.condition.matches
 import io.holunda.camunda.bpm.data.guard.integration.DefaultGuardTaskListener
+import io.holunda.camunda.bpm.data.reader.VariableScopeReader
+import io.holunda.camunda.bpm.data.writer.VariableScopeWriter
 import mu.KLogging
 import org.camunda.bpm.engine.delegate.DelegateExecution
 import org.camunda.bpm.engine.delegate.DelegateTask
@@ -54,29 +56,28 @@ class OrderApproval {
    */
   @Bean
   fun loadOrder() = JavaDelegate { execution ->
-    val orderId = ORDER_ID.from(execution).get()
+    val orderId = VariableScopeReader.of(ORDER_ID, execution).get()
     val order = orderRepository.loadOrder(orderId)
-    ORDER.on(execution).set(order)
-    ORDER_TOTAL.on(execution).set(BigDecimal.ZERO)
+    VariableScopeWriter.of(ORDER, execution).set(order)
+    VariableScopeWriter.of(ORDER_TOTAL, execution).set(BigDecimal.ZERO)
   }
 
   /**
    * Load a local order position, write a local variable.
    */
   @Bean
   fun calculateOrderPositions() = JavaDelegate { execution ->
-    val orderPosition = ORDER_POSITION.from(execution).get()
-
-    ORDER_TOTAL.on(execution).update { total -> total.plus(orderPosition.netCost.times(BigDecimal.valueOf(orderPosition.amount))) }
+    val orderPosition = VariableScopeReader.of(ORDER_POSITION, execution).get()
+    VariableScopeWriter.of(ORDER_TOTAL, execution).update { total -> total.plus(orderPosition.netCost.times(BigDecimal.valueOf(orderPosition.amount))) }
   }
 
   /**
    * Read a local variable and store it in global variable.
    */
   @Bean
   fun writeOrderTotal() = ExecutionListener { execution ->
-    val total = ORDER_TOTAL.from(execution).get()
-    ORDER_TOTAL.on(execution).set(total)
+    val total = VariableScopeReader.of(ORDER_TOTAL, execution).get()
+    VariableScopeWriter.of(ORDER_TOTAL, execution).set(total)
   }
 
   /**

diff --git a/example/example-kotlin/src/main/kotlin/rest/ApproveOrderTaskController.kt b/example/example-kotlin/src/main/kotlin/rest/ApproveOrderTaskController.kt
@@ -4,6 +4,8 @@ import io.holunda.camunda.bpm.data.example.kotlin.domain.Order
 import io.holunda.camunda.bpm.data.example.kotlin.process.OrderApproval.Variables.ORDER
 import io.holunda.camunda.bpm.data.example.kotlin.process.OrderApproval.Variables.ORDER_APPROVED
 import io.holunda.camunda.bpm.data.example.kotlin.process.OrderApproval.Variables.ORDER_TOTAL
+import io.holunda.camunda.bpm.data.reader.TaskServiceVariableReader
+import io.holunda.camunda.bpm.data.writer.VariableMapWriter
 import org.camunda.bpm.engine.TaskService
 import org.camunda.bpm.engine.variable.Variables.createVariables
 import org.springframework.http.ResponseEntity
@@ -18,15 +20,15 @@ class ApproveOrderTaskController(
 
   @GetMapping("/{taskId}")
   fun loadTask(@PathVariable("taskId") taskId: String): ResponseEntity<ApproveTaskDto> {
-    val order = ORDER.from(taskService, taskId).get()
-    val orderTotal = ORDER_TOTAL.from(taskService, taskId).get()
+    val order = TaskServiceVariableReader.of(ORDER, taskService, taskId).get()
+    val orderTotal = TaskServiceVariableReader.of(ORDER_TOTAL, taskService, taskId).get()
     return ResponseEntity.ok(ApproveTaskDto(order, orderTotal))
   }
 
   @PostMapping("/{taskId}")
   fun completeTask(@PathVariable("taskId") taskId: String, @RequestBody approveTaskComplete: ApproveTaskCompleteDto): ResponseEntity<Void> {
     val vars = createVariables()
-    ORDER_APPROVED.on(vars).set(approveTaskComplete.approved)
+    VariableMapWriter.of(ORDER_APPROVED, vars).set(approveTaskComplete.approved)
     taskService.complete(taskId, vars)
     return ResponseEntity.noContent().build()
   }

diff --git a/example/example-no-engine/pom.xml b/example/example-no-engine/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.holunda.data.example</groupId>
     <artifactId>camunda-bpm-data-example-parent</artifactId>
-    <version>1.5.1-SNAPSHOT</version>
+    <version>1.6.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>camunda-bpm-data-example-no-engine</artifactId>

diff --git a/example/itest/pom.xml b/example/itest/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.holunda.data.example</groupId>
     <artifactId>camunda-bpm-data-example-parent</artifactId>
-    <version>1.5.1-SNAPSHOT</version>
+    <version>1.6.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>camunda-bpm-data-integration-test</artifactId>

diff --git a/example/itest/src/test/kotlin/itest/CamundaBpmDataITestBase.kt b/example/itest/src/test/kotlin/itest/CamundaBpmDataITestBase.kt
@@ -73,6 +73,7 @@ fun <G, W, T> ScenarioTestBase<G, W, T>.whenever(): W = `when`()
 @ExtendWith(SpringExtension::class)
 @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = [CamundaBpmDataITestBase.TestApplication::class])
 @ActiveProfiles("itest")
+@Suppress("DEPRECATION") // FIXME: remove this suppression as soon as deprecation is removed
 abstract class CamundaBpmDataITestBase : SpringScenarioTest<ActionStage, ActionStage, AssertStage>() {
 
   companion object {

diff --git a/example/itest/src/test/kotlin/itest/RuntimeServiceAdapterITest.kt b/example/itest/src/test/kotlin/itest/RuntimeServiceAdapterITest.kt
@@ -19,6 +19,7 @@ import org.junit.jupiter.api.Test
 import org.springframework.beans.factory.annotation.Autowired
 import java.util.*
 
+@Suppress("DEPRECATION") // FIXME: remove this suppression as soon as deprecation is removed
 class RuntimeServiceAdapterITest : CamundaBpmDataITestBase() {
 
   @Autowired

diff --git a/example/itest/src/test/kotlin/itest/TaskServiceAdapterITest.kt b/example/itest/src/test/kotlin/itest/TaskServiceAdapterITest.kt
@@ -28,6 +28,7 @@ import org.springframework.beans.factory.annotation.Autowired
 import java.util.*
 import kotlin.collections.HashMap
 
+@Suppress("DEPRECATION") // FIXME: remove this suppression as soon as deprecation is removed
 class TaskServiceAdapterITest : CamundaBpmDataITestBase() {
 
   @Autowired

diff --git a/example/itest/src/test/kotlin/itest/VariableMapAdapterITest.kt b/example/itest/src/test/kotlin/itest/VariableMapAdapterITest.kt
@@ -25,6 +25,8 @@ import org.junit.jupiter.api.Test
 import org.springframework.beans.factory.annotation.Autowired
 import java.util.*
 
+
+@Suppress("DEPRECATION") // FIXME: remove this suppression as soon as deprecation is removed
 class VariableMapAdapterITest : CamundaBpmDataITestBase() {
 
   @Autowired

diff --git a/example/itest/src/test/kotlin/itest/VariableScopeAdapterITest.kt b/example/itest/src/test/kotlin/itest/VariableScopeAdapterITest.kt
@@ -6,6 +6,7 @@ import org.junit.jupiter.api.Test
 import org.springframework.beans.factory.annotation.Autowired
 import java.util.*
 
+@Suppress("DEPRECATION") // FIXME: remove this suppression as soon as deprecation is removed
 class VariableScopeAdapterITest : CamundaBpmDataITestBase() {
 
   @Autowired

diff --git a/example/pom.xml b/example/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.holunda.data</groupId>
     <artifactId>camunda-bpm-data-parent</artifactId>
-    <version>1.5.1-SNAPSHOT</version>
+    <version>1.6.0-SNAPSHOT</version>
   </parent>
 
   <groupId>io.holunda.data.example</groupId>

diff --git a/example/spin-type-detector/pom.xml b/example/spin-type-detector/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.holunda.data.example</groupId>
     <artifactId>camunda-bpm-data-example-parent</artifactId>
-    <version>1.5.1-SNAPSHOT</version>
+    <version>1.6.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>camunda-bpm-data-spin-type-detector</artifactId>

diff --git a/extension/api/pom.xml b/extension/api/pom.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>io.holunda.data</groupId>
+    <artifactId>camunda-bpm-data-parent</artifactId>
+    <version>1.6.0-SNAPSHOT</version>
+    <relativePath>../../pom.xml</relativePath>
+  </parent>
+
+  <artifactId>camunda-bpm-data-api</artifactId>
+  <name>${project.artifactId}</name>
+  <packaging>jar</packaging>
+
+  <properties>
+    <jacoco.skip>false</jacoco.skip>
+    <dokka.skip>false</dokka.skip>
+  </properties>
+
+  <dependencies>
+    <!-- Kotlin -->
+    <dependency>
+      <groupId>org.jetbrains.kotlin</groupId>
+      <artifactId>kotlin-stdlib-common</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.jetbrains.kotlin</groupId>
+      <artifactId>kotlin-reflect</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.camunda.bpm</groupId>
+      <artifactId>camunda-engine</artifactId>
+      <scope>provided</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.jetbrains.kotlin</groupId>
+        <artifactId>kotlin-maven-plugin</artifactId>
+      </plugin>
+    </plugins>
+  </build>
+</project>
diff --git a/...a/camunda/bpm/data/adapter/ReadAdapter.kt → ...a/camunda/bpm/data/adapter/ReadAdapter.kt b/...a/camunda/bpm/data/adapter/ReadAdapter.kt → ...a/camunda/bpm/data/adapter/ReadAdapter.kt
diff --git a/...data/adapter/VariableNotFoundException.kt → ...data/adapter/VariableNotFoundException.kt b/...data/adapter/VariableNotFoundException.kt → ...data/adapter/VariableNotFoundException.kt
diff --git a/.../camunda/bpm/data/adapter/WriteAdapter.kt → .../camunda/bpm/data/adapter/WriteAdapter.kt b/.../camunda/bpm/data/adapter/WriteAdapter.kt → .../camunda/bpm/data/adapter/WriteAdapter.kt
diff --git a/...ata/adapter/WrongVariableTypeException.kt → ...ata/adapter/WrongVariableTypeException.kt b/...ata/adapter/WrongVariableTypeException.kt → ...ata/adapter/WrongVariableTypeException.kt