> =
+ variableConditions.flatMap { it.evaluate(runtimeService, executionId) }
+
+ /**
+ * Retrieves a list of local variables addressed by this guard.
+ * @return variable factories extracted from condition with scope local.
+ */
+ fun getLocalVariables() = variableConditions.filter { it.local }.map { it.variableFactory }
+
+ /**
+ * Retrieves a list of variables addressed by this guard.
+ * @return variable factories extracted from condition with scope global.
+ */
+ fun getVariables() = variableConditions.filter { !it.local }.map { it.variableFactory }
+
+
+ override fun equals(other: Any?): Boolean {
+ if (this === other) return true
+ if (javaClass != other?.javaClass) return false
+
+ other as VariablesGuard
+
+ if (variableConditions != other.variableConditions) return false
+
+ return true
+ }
+
+ override fun hashCode(): Int {
+ return variableConditions.hashCode()
+ }
+
+ override fun toString(): String {
+ return "VariablesGuard(variableConditions=$variableConditions)"
+ }
}
diff --git a/extension/core/src/main/kotlin/guard/condition/VariableExistsGuardCondition.kt b/extension/core/src/main/kotlin/guard/condition/VariableExistsGuardCondition.kt
index 21dea549..bc4716ef 100644
--- a/extension/core/src/main/kotlin/guard/condition/VariableExistsGuardCondition.kt
+++ b/extension/core/src/main/kotlin/guard/condition/VariableExistsGuardCondition.kt
@@ -6,6 +6,7 @@ import java.util.*
/**
* Condition to check if the variable exists.
+ * @constructor Creates a condition.
* @param variableFactory factory to work on.
* @param local flag indicating if local or global scope is required.
*/
diff --git a/extension/core/src/main/kotlin/guard/condition/VariableGuardCondition.kt b/extension/core/src/main/kotlin/guard/condition/VariableGuardCondition.kt
index a6c9f053..3e78a851 100644
--- a/extension/core/src/main/kotlin/guard/condition/VariableGuardCondition.kt
+++ b/extension/core/src/main/kotlin/guard/condition/VariableGuardCondition.kt
@@ -10,13 +10,14 @@ import java.util.*
/**
* Abstract guard condition.
- * @since 0.0.6
- * @param T variable type.
- * @param variableFactory factory to work on.
- * @param local flag indicating the variable scope (global/local). Defaults to global.
*
* This class is intended to be subclassed by developers of new variable guards.
*
+ * @constructor Creates a condition.
+ * @since 0.0.6
+ * @param T variable type.
+ * @property variableFactory factory to work on.
+ * @property local flag indicating the variable scope (global/local). Defaults to global.
*/
abstract class VariableGuardCondition(
internal val variableFactory: VariableFactory,
diff --git a/extension/core/src/main/kotlin/guard/condition/VariableMatchesGuardCondition.kt b/extension/core/src/main/kotlin/guard/condition/VariableMatchesGuardCondition.kt
index 1da3946c..22c333fb 100644
--- a/extension/core/src/main/kotlin/guard/condition/VariableMatchesGuardCondition.kt
+++ b/extension/core/src/main/kotlin/guard/condition/VariableMatchesGuardCondition.kt
@@ -6,10 +6,11 @@ import java.util.*
/**
* Guard for testing a condition passed by a matcher-function.
+ * @constructor Creates a condition.
* @param T variable type.
* @param variableFactory Factory to work with.
* @param local flag indicating the variable scope (global/local). Defaults to global.
- * @param matcher matcher function, specifying the condition.
+ * @property matcher matcher function, specifying the condition.
*/
class VariableMatchesGuardCondition(
/**
@@ -48,4 +49,4 @@ class VariableMatchesGuardCondition(
* @param matcher function that must match the value.
* @return instance of [VariableMatchesGuardCondition] on current factory.
*/
-fun VariableFactory.matches(local: Boolean = false, matcher: (value: T) -> Boolean) = VariableMatchesGuardCondition(this, local, matcher)
\ No newline at end of file
+fun VariableFactory.matches(local: Boolean = false, matcher: (value: T) -> Boolean) = VariableMatchesGuardCondition(this, local, matcher)
diff --git a/extension/core/src/main/kotlin/guard/condition/VariableNotExistsGuardCondition.kt b/extension/core/src/main/kotlin/guard/condition/VariableNotExistsGuardCondition.kt
index fdcf8cb6..2858ddfa 100644
--- a/extension/core/src/main/kotlin/guard/condition/VariableNotExistsGuardCondition.kt
+++ b/extension/core/src/main/kotlin/guard/condition/VariableNotExistsGuardCondition.kt
@@ -6,6 +6,7 @@ import java.util.*
/**
* Condition to check if the variable doesn't exist.
+ * @constructor Creates a condition.
* @param variableFactory factory to work on.
* @param local flag indicating if local or global scope is required.
*/
diff --git a/extension/core/src/main/kotlin/guard/condition/VariableValueGuardCondition.kt b/extension/core/src/main/kotlin/guard/condition/VariableValueGuardCondition.kt
index 754538ba..c719167e 100644
--- a/extension/core/src/main/kotlin/guard/condition/VariableValueGuardCondition.kt
+++ b/extension/core/src/main/kotlin/guard/condition/VariableValueGuardCondition.kt
@@ -6,6 +6,7 @@ import java.util.*
/**
* Condition to check if the variable has provided value.
+ * @constructor Creates a condition.
* @param variableFactory factory to work on.
* @param value set of values to compare with.
* @param local flag indicating if local or global scope is required.
diff --git a/extension/core/src/main/kotlin/guard/condition/VariableValueOneOfGuardCondition.kt b/extension/core/src/main/kotlin/guard/condition/VariableValueOneOfGuardCondition.kt
index c621f4ea..979b9cd0 100644
--- a/extension/core/src/main/kotlin/guard/condition/VariableValueOneOfGuardCondition.kt
+++ b/extension/core/src/main/kotlin/guard/condition/VariableValueOneOfGuardCondition.kt
@@ -6,6 +6,7 @@ import java.util.*
/**
* Condition to check if the variable has on of the provided values.
+ * @constructor Creates a condition.
* @param variableFactory factory to work on.
* @param values set of values to compare with.
* @param local flag indicating if local or global scope is required.
diff --git a/extension/core/src/main/kotlin/guard/integration/DefaultGuardExecutionListener.kt b/extension/core/src/main/kotlin/guard/integration/DefaultGuardExecutionListener.kt
index 98e6e494..775166dd 100644
--- a/extension/core/src/main/kotlin/guard/integration/DefaultGuardExecutionListener.kt
+++ b/extension/core/src/main/kotlin/guard/integration/DefaultGuardExecutionListener.kt
@@ -8,8 +8,9 @@ import org.slf4j.LoggerFactory
/**
* Default guard execution listener, evaluating the given guard conditions on the execution.
- * @param guard guard to check.
- * @param throwViolations flag controlling if the violation should lead to an exception.
+ * @constructor Creates a listener.
+ * @property guard guard to check.
+ * @property throwViolations flag controlling if the violation should lead to an exception.
*/
class DefaultGuardExecutionListener(
val guard: VariablesGuard,
@@ -39,4 +40,4 @@ class DefaultGuardExecutionListener(
}
}
}
-}
\ No newline at end of file
+}
diff --git a/extension/core/src/main/kotlin/guard/integration/DefaultGuardTaskListener.kt b/extension/core/src/main/kotlin/guard/integration/DefaultGuardTaskListener.kt
index 8bea4d32..8a2a8862 100644
--- a/extension/core/src/main/kotlin/guard/integration/DefaultGuardTaskListener.kt
+++ b/extension/core/src/main/kotlin/guard/integration/DefaultGuardTaskListener.kt
@@ -8,8 +8,9 @@ import org.slf4j.LoggerFactory
/**
* Default guard execution listener, evaluating the given guard conditions on the task.
- * @param guard guard to check.
- * @param throwViolations flag controlling if the violation should lead to an exception.
+ * @constructor Creates a listener.
+ * @property guard guard to check.
+ * @property throwViolations flag controlling if the violation should lead to an exception.
*/
class DefaultGuardTaskListener(
val guard: VariablesGuard,
@@ -45,4 +46,4 @@ class DefaultGuardTaskListener(
*/
private fun String.removeNewLines() = this
.replace("\n", " ")
-}
\ No newline at end of file
+}
diff --git a/extension/core/src/main/kotlin/guard/integration/GuardViolationException.kt b/extension/core/src/main/kotlin/guard/integration/GuardViolationException.kt
index db164443..aad37442 100644
--- a/extension/core/src/main/kotlin/guard/integration/GuardViolationException.kt
+++ b/extension/core/src/main/kotlin/guard/integration/GuardViolationException.kt
@@ -5,6 +5,7 @@ import org.camunda.bpm.engine.ProcessEngineException
/**
* Exception indicating a guard violation.
+ * @constructor Creates the exception.
* @param violations list of guard violations.
* @param reason reason of failure.
*/
@@ -24,4 +25,4 @@ class GuardViolationException(
return "$message\n" + violations.joinToString(separator = ",\n") { "\t${it.message}" }
}
}
-}
\ No newline at end of file
+}
diff --git a/extension/core/src/main/kotlin/guard/package-info.kt b/extension/core/src/main/kotlin/guard/package-info.kt
deleted file mode 100644
index 4307db83..00000000
--- a/extension/core/src/main/kotlin/guard/package-info.kt
+++ /dev/null
@@ -1,7 +0,0 @@
-/**
- * Package providing resources for building Variable Guards.
- *
- * @since 0.0.4
- * @see io.holunda.camunda.bpm.data.guard.CamundaBpmDataGuards for more details.
- */
-package io.holunda.camunda.bpm.data.guard
diff --git a/extension/core/src/main/kotlin/package-info.kt b/extension/core/src/main/kotlin/package-info.kt
deleted file mode 100644
index 6a97145d..00000000
--- a/extension/core/src/main/kotlin/package-info.kt
+++ /dev/null
@@ -1,7 +0,0 @@
-/**
- * Top-level package of the library.
- *
- * @see io.holunda.camunda.bpm.data.CamundaBpmData as entry point for variable factory definition.
- * @since 0.0.2
- */
-package io.holunda.camunda.bpm.data
diff --git a/extension/core/src/main/kotlin/packages.md b/extension/core/src/main/kotlin/packages.md
new file mode 100644
index 00000000..98c2acf1
--- /dev/null
+++ b/extension/core/src/main/kotlin/packages.md
@@ -0,0 +1,21 @@
+# Package io.holunda.camunda.bpm.data
+
+Top-level package of the library.
+
+check [io.holunda.camunda.bpm.data.CamundaBpmDataKotlin] as entry point for variable factory definition.
+@since 0.0.2
+
+
+# Package io.holunda.camunda.bpm.data.guard
+
+Package providing resources for building Variable Guards.
+@since 0.0.4
+check [io.holunda.camunda.bpm.data.guard.CamundaBpmDataGuards] for more details.
+
+# Package io.holunda.camunda.bpm.data.acl
+
+Package providing resources for building of Anti-Corruption-Layer (ACL).
+@since 1.0.0
+@see [io.holunda.camunda.bpm.data.acl.CamundaBpmDataACL] for more details.
+
+
diff --git a/extension/core/src/test/java/io/holunda/camunda/bpm/data/CamundaBpmDataTest.java b/extension/core/src/test/java/io/holunda/camunda/bpm/data/CamundaBpmDataTest.java
new file mode 100644
index 00000000..282c28c4
--- /dev/null
+++ b/extension/core/src/test/java/io/holunda/camunda/bpm/data/CamundaBpmDataTest.java
@@ -0,0 +1,263 @@
+package io.holunda.camunda.bpm.data;
+
+
+import io.holunda.camunda.bpm.data.builder.VariableMapBuilder;
+import io.holunda.camunda.bpm.data.factory.*;
+import io.holunda.camunda.bpm.data.reader.*;
+import io.holunda.camunda.bpm.data.writer.*;
+import org.camunda.bpm.engine.RuntimeService;
+import org.camunda.bpm.engine.TaskService;
+import org.camunda.bpm.extension.mockito.delegate.DelegateExecutionFake;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.util.Date;
+
+import static io.holunda.camunda.bpm.data.CamundaBpmData.*;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.camunda.bpm.engine.variable.Variables.createVariables;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+public class CamundaBpmDataTest {
+
+ private final String VAR_NAME = "foo";
+ private final RuntimeService runtimeService = mock(RuntimeService.class);
+ private final TaskService taskService = mock(TaskService.class);
+
+
+ @Before
+ public void setupStubs() {
+ when(runtimeService.getVariablesLocalTyped(any())).thenReturn(createVariables());
+ when(runtimeService.getVariablesTyped(any())).thenReturn(createVariables());
+
+ when(taskService.getVariablesLocalTyped(any())).thenReturn(createVariables());
+ when(taskService.getVariablesTyped(any())).thenReturn(createVariables());
+ }
+
+ @Test
+ public void shouldCreateStringVariableFactory() {
+
+ VariableFactory factory = stringVariable(VAR_NAME);
+ assertThat(factory).isInstanceOf(BasicVariableFactory.class);
+
+ BasicVariableFactory basicFactory = (BasicVariableFactory) factory;
+ assertThat(basicFactory.getName()).isEqualTo(VAR_NAME);
+ assertThat(basicFactory.getVariableClass()).isEqualTo(String.class);
+ }
+
+ @Test
+ public void shouldCreateDateVariableFactory() {
+
+ VariableFactory factory = dateVariable(VAR_NAME);
+ assertThat(factory).isInstanceOf(BasicVariableFactory.class);
+
+ BasicVariableFactory basicFactory = (BasicVariableFactory) factory;
+ assertThat(basicFactory.getName()).isEqualTo(VAR_NAME);
+ assertThat(basicFactory.getVariableClass()).isEqualTo(Date.class);
+ }
+
+ @Test
+ public void shouldCreateIntVariableFactory() {
+
+ VariableFactory factory = intVariable(VAR_NAME);
+ assertThat(factory).isInstanceOf(BasicVariableFactory.class);
+
+ BasicVariableFactory basicFactory = (BasicVariableFactory) factory;
+ assertThat(basicFactory.getName()).isEqualTo(VAR_NAME);
+ assertThat(basicFactory.getVariableClass()).isEqualTo(Integer.class);
+ }
+
+
+ @Test
+ public void shouldCreateLongVariableFactory() {
+
+ VariableFactory factory = longVariable(VAR_NAME);
+ assertThat(factory).isInstanceOf(BasicVariableFactory.class);
+
+ BasicVariableFactory basicFactory = (BasicVariableFactory) factory;
+ assertThat(basicFactory.getName()).isEqualTo(VAR_NAME);
+ assertThat(basicFactory.getVariableClass()).isEqualTo(Long.class);
+ }
+
+ @Test
+ public void shouldCreateShortVariableFactory() {
+
+ VariableFactory factory = shortVariable(VAR_NAME);
+ assertThat(factory).isInstanceOf(BasicVariableFactory.class);
+
+ BasicVariableFactory basicFactory = (BasicVariableFactory) factory;
+ assertThat(basicFactory.getName()).isEqualTo(VAR_NAME);
+ assertThat(basicFactory.getVariableClass()).isEqualTo(Short.class);
+ }
+
+ @Test
+ public void shouldCreateDoubleVariableFactory() {
+
+ VariableFactory factory = doubleVariable(VAR_NAME);
+ assertThat(factory).isInstanceOf(BasicVariableFactory.class);
+
+ BasicVariableFactory basicFactory = (BasicVariableFactory) factory;
+ assertThat(basicFactory.getName()).isEqualTo(VAR_NAME);
+ assertThat(basicFactory.getVariableClass()).isEqualTo(Double.class);
+ }
+
+ @Test
+ public void shouldCreateBooleanVariableFactory() {
+
+ VariableFactory factory = booleanVariable(VAR_NAME);
+ assertThat(factory).isInstanceOf(BasicVariableFactory.class);
+
+ BasicVariableFactory basicFactory = (BasicVariableFactory) factory;
+ assertThat(basicFactory.getName()).isEqualTo(VAR_NAME);
+ assertThat(basicFactory.getVariableClass()).isEqualTo(Boolean.class);
+ }
+
+ @Test
+ public void shouldCreateCustomVariableFactory() {
+
+ VariableFactory factory = customVariable(VAR_NAME, MyCustomType.class);
+ assertThat(factory).isInstanceOf(BasicVariableFactory.class);
+
+ BasicVariableFactory basicFactory = (BasicVariableFactory) factory;
+ assertThat(basicFactory.getName()).isEqualTo(VAR_NAME);
+ assertThat(basicFactory.getVariableClass()).isEqualTo(MyCustomType.class);
+ }
+
+ @Test
+ public void shouldCreateListVariableFactory() {
+
+ VariableFactory factory = listVariable(VAR_NAME, MyCustomType.class);
+ assertThat(factory).isInstanceOf(ListVariableFactory.class);
+
+ ListVariableFactory basicFactory = (ListVariableFactory) factory;
+ assertThat(basicFactory.getName()).isEqualTo(VAR_NAME);
+ assertThat(basicFactory.getMemberClass()).isEqualTo(MyCustomType.class);
+ }
+
+ @Test
+ public void shouldCreateSetVariableFactory() {
+
+ VariableFactory factory = setVariable(VAR_NAME, MyCustomType.class);
+ assertThat(factory).isInstanceOf(SetVariableFactory.class);
+
+ SetVariableFactory setFactory = (SetVariableFactory) factory;
+ assertThat(setFactory.getName()).isEqualTo(VAR_NAME);
+ assertThat(setFactory.getMemberClass()).isEqualTo(MyCustomType.class);
+ }
+
+ @Test
+ public void shouldCreateMapVariableFactory() {
+
+ VariableFactory factory = mapVariable(VAR_NAME, String.class, MyCustomType.class);
+ assertThat(factory).isInstanceOf(MapVariableFactory.class);
+
+ MapVariableFactory mapFactory = (MapVariableFactory) factory;
+ assertThat(mapFactory.getName()).isEqualTo(VAR_NAME);
+ assertThat(mapFactory.getKeyClass()).isEqualTo(String.class);
+ assertThat(mapFactory.getValueClass()).isEqualTo(MyCustomType.class);
+ }
+
+
+ @Test
+ public void shouldCreateBuilder() {
+
+ VariableMapBuilder builder = builder();
+ VariableMapBuilder builder2 = builder();
+ assertThat(builder).isEqualTo(builder2);
+ assertThat(builder).isNotSameAs(builder2);
+ }
+
+ @Test
+ public void shouldCreateWriterRuntimeService() {
+
+ VariableWriter writer = writer(runtimeService, "4711");
+ VariableWriter writer2 = writer(runtimeService, "4711");
+ assertThat(writer).isNotSameAs(writer2);
+ assertThat(writer).isEqualTo(writer2);
+ assertThat(writer).isInstanceOf(RuntimeServiceVariableWriter.class);
+ assertThat(writer.variablesLocal()).isNotNull();
+ assertThat(writer.variables()).isNotNull();
+ }
+
+ @Test
+ public void shouldCreateWriterTaskService() {
+
+ VariableWriter writer = writer(taskService, "4711");
+ VariableWriter writer2 = writer(taskService, "4711");
+ assertThat(writer).isNotSameAs(writer2);
+ assertThat(writer).isEqualTo(writer2);
+ assertThat(writer).isInstanceOf(TaskServiceVariableWriter.class);
+ assertThat(writer.variablesLocal()).isNotNull();
+ assertThat(writer.variables()).isNotNull();
+ }
+
+ @Test
+ public void shouldCreateWriterVariableScope() {
+
+ DelegateExecutionFake execution = new DelegateExecutionFake();
+
+ VariableWriter writer = writer(execution);
+ VariableWriter writer2 = writer(execution);
+ assertThat(writer).isNotSameAs(writer2).isEqualTo(writer2);
+ assertThat(writer).isInstanceOf(VariableScopeWriter.class);
+ assertThat(writer.variablesLocal()).isNotNull();
+ assertThat(writer.variables()).isNotNull();
+ }
+
+ @Test
+ public void shouldCreateWriterVariableMap() {
+ GlobalVariableWriter writer = writer(createVariables());
+ GlobalVariableWriter writer2 = writer(createVariables());
+ assertThat(writer).isNotSameAs(writer2).isEqualTo(writer2);
+ assertThat(writer).isInstanceOf(VariableMapWriter.class);
+ assertThat(writer.variables()).isNotNull();
+ }
+
+ @Test
+ public void shouldCreateReaderRuntimeService() {
+
+ VariableReader reader = reader(runtimeService, "4711");
+ VariableReader reader2 = reader(runtimeService, "4711");
+ assertThat(reader).isNotSameAs(reader2);
+ assertThat(reader).isEqualTo(reader2);
+ assertThat(reader).isInstanceOf(RuntimeServiceVariableReader.class);
+ }
+
+ @Test
+ public void shouldCreateReaderTaskService() {
+
+ VariableReader reader = reader(taskService, "4711");
+ VariableReader reader2 = reader(taskService, "4711");
+ assertThat(reader).isNotSameAs(reader2);
+ assertThat(reader).isEqualTo(reader2);
+ assertThat(reader).isInstanceOf(TaskServiceVariableReader.class);
+
+ }
+
+ @Test
+ public void shouldCreateReaderVariableScope() {
+
+ DelegateExecutionFake execution = new DelegateExecutionFake();
+ VariableReader reader = reader(execution);
+ VariableReader reader2 = reader(execution);
+ assertThat(reader).isNotSameAs(reader2);
+ assertThat(reader).isEqualTo(reader2);
+ assertThat(reader).isInstanceOf(VariableScopeReader.class);
+ }
+
+ @Test
+ public void shouldCreateReaderVariableMap() {
+ VariableReader reader = reader(createVariables());
+ VariableReader reader2 = reader(createVariables());
+ assertThat(reader).isNotSameAs(reader2);
+ assertThat(reader).isEqualTo(reader2);
+ assertThat(reader).isInstanceOf(VariableMapReader.class);
+ }
+
+
+ static class MyCustomType {
+
+ }
+}
diff --git a/extension/test/pom.xml b/extension/test/pom.xml
index efc3f1be..08c61f76 100644
--- a/extension/test/pom.xml
+++ b/extension/test/pom.xml
@@ -6,7 +6,7 @@
io.holunda.data
camunda-bpm-data-parent
- 1.0.0
+ 1.0.1
../..
@@ -99,27 +99,4 @@
-
-
- release
-
-
- release
-
-
-
-
-
- org.jetbrains.dokka
- dokka-maven-plugin
-
-
- org.codehaus.mojo
- build-helper-maven-plugin
-
-
-
-
-
-
diff --git a/pom.xml b/pom.xml
index b36e999d..a01ee667 100644
--- a/pom.xml
+++ b/pom.xml
@@ -4,7 +4,7 @@
io.holunda.data
camunda-bpm-data-parent
- 1.0.0
+ 1.0.1
${project.artifactId}
Camunda BPM Data
https://github.com/holunda-io/camunda-bpm-data/
@@ -350,16 +350,26 @@
org.jetbrains.dokka
dokka-maven-plugin
- 0.10.0
+ 0.10.1
- test
attach-javadocs
+ pre-site
javadocJar
+
+
+ packages.md
+
+ 8
+
+ ${project.basedir}/src/main/kotlin
+ ${project.basedir}/src/main/java
+
+
org.apache.maven.plugins
@@ -662,6 +672,14 @@
org.sonatype.plugins
nexus-staging-maven-plugin
+
+ org.jetbrains.dokka
+ dokka-maven-plugin
+
+
+ org.codehaus.mojo
+ build-helper-maven-plugin
+