Expose the variable names on the VariableContainer

flowable · Jan 20, 2025 · d96d588 · d96d588
1 parent 10bee31
commit d96d588
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 0 deletions.
diff --git a/...ain/java/org/flowable/cmmn/engine/impl/delegate/ReadOnlyDelegatePlanItemInstanceImpl.java b/...ain/java/org/flowable/cmmn/engine/impl/delegate/ReadOnlyDelegatePlanItemInstanceImpl.java
@@ -15,6 +15,7 @@
 import java.util.Date;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Set;
 import java.util.StringJoiner;
 
 import org.flowable.cmmn.api.delegate.DelegatePlanItemInstance;
@@ -284,6 +285,11 @@ public String getTenantId() {
         return tenantId;
     }
 
+    @Override
+    public Set<String> getVariableNames() {
+        return variables.keySet();
+    }
+
     @Override
     public Map<String, Object> getPlanItemInstanceLocalVariables() {
         return localVariables;

diff --git a/...mon-api/src/main/java/org/flowable/common/engine/api/variable/EmptyVariableContainer.java b/...mon-api/src/main/java/org/flowable/common/engine/api/variable/EmptyVariableContainer.java
@@ -12,6 +12,9 @@
  */
 package org.flowable.common.engine.api.variable;
 
+import java.util.Collections;
+import java.util.Set;
+
 /**
  * @author Arthur Hupka-Merle
  */
@@ -43,4 +46,9 @@ public void setTransientVariable(String variableName, Object variableValue) {
     public String getTenantId() {
         return null;
     }
+
+    @Override
+    public Set<String> getVariableNames() {
+        return Collections.emptySet();
+    }
 }
diff --git a/...e-common-api/src/main/java/org/flowable/common/engine/api/variable/VariableContainer.java b/...e-common-api/src/main/java/org/flowable/common/engine/api/variable/VariableContainer.java
@@ -12,6 +12,8 @@
  */
 package org.flowable.common.engine.api.variable;
 
+import java.util.Set;
+
 /**
  * @author Joram Barrez
  */
@@ -34,4 +36,6 @@ public static VariableContainer empty(){
 
     String getTenantId();
 
+    Set<String> getVariableNames();
+
 }
diff --git a/...ine-common/src/main/java/org/flowable/common/engine/impl/el/VariableContainerWrapper.java b/...ine-common/src/main/java/org/flowable/common/engine/impl/el/VariableContainerWrapper.java
@@ -12,8 +12,11 @@
  */
 package org.flowable.common.engine.impl.el;
 
+import java.util.Collection;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.StringJoiner;
 
 import org.flowable.common.engine.api.variable.VariableContainer;
@@ -79,6 +82,11 @@ public void setTenantId(String tenantId) {
         this.tenantId = tenantId;
     }
 
+    @Override
+    public Set<String> getVariableNames() {
+        return variables.keySet();
+    }
+
     @Override
     public String toString() {
         return new StringJoiner(", ", getClass().getSimpleName() + "[", "]")

diff --git a/.../src/main/java/org/flowable/common/engine/impl/variable/MapDelegateVariableContainer.java b/.../src/main/java/org/flowable/common/engine/impl/variable/MapDelegateVariableContainer.java
@@ -13,7 +13,9 @@
 package org.flowable.common.engine.impl.variable;
 
 import java.util.HashMap;
+import java.util.LinkedHashSet;
 import java.util.Map;
+import java.util.Set;
 import java.util.StringJoiner;
 
 import org.flowable.common.engine.api.variable.VariableContainer;
@@ -147,6 +149,19 @@ public String getTenantId() {
         return this.delegate.getTenantId();
     }
 
+    @Override
+    public Set<String> getVariableNames() {
+        if (delegate == null || delegate == VariableContainer.empty()) {
+            return this.transientVariables.keySet();
+        }
+        if (transientVariables.isEmpty()) {
+            return delegate.getVariableNames();
+        }
+        Set<String> keys = new LinkedHashSet<>(delegate.getVariableNames());
+        keys.addAll(transientVariables.keySet());
+        return keys;
+    }
+
     @Override
     public String toString() {
         return new StringJoiner(", ", getClass().getSimpleName() + "[", "]")

diff --git a/.../flowable-engine/src/main/java/org/flowable/engine/impl/bpmn/helper/ErrorPropagation.java b/.../flowable-engine/src/main/java/org/flowable/engine/impl/bpmn/helper/ErrorPropagation.java
@@ -16,6 +16,7 @@
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -623,6 +624,19 @@ public String getTenantId() {
             return tenantId;
         }
 
+        @Override
+        public Set<String> getVariableNames() {
+            if (additionalDataContainer == null) {
+                return Set.of(ERROR_CODE_VARIABLE_NAME, ERROR_VARIABLE_NAME, ERROR_MESSAGE_VARIABLE_NAME);
+            }
+
+            Set<String> variableKeys = new LinkedHashSet<>(additionalDataContainer.getVariableNames());
+            variableKeys.add(ERROR_CODE_VARIABLE_NAME);
+            variableKeys.add(ERROR_VARIABLE_NAME);
+            variableKeys.add(ERROR_MESSAGE_VARIABLE_NAME);
+            return variableKeys;
+        }
+
         @Override
         public String toString() {
             return new StringJoiner(", ", getClass().getSimpleName() + "[", "]")

diff --git a/...engine/src/main/java/org/flowable/engine/impl/delegate/ReadOnlyDelegateExecutionImpl.java b/...engine/src/main/java/org/flowable/engine/impl/delegate/ReadOnlyDelegateExecutionImpl.java
@@ -14,6 +14,7 @@
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Set;
 import java.util.StringJoiner;
 
 import org.flowable.bpmn.model.FlowElement;
@@ -174,6 +175,11 @@ public boolean hasVariable(String variableName) {
         return variables.containsKey(variableName);
     }
 
+    @Override
+    public Set<String> getVariableNames() {
+        return variables.keySet();
+    }
+
     @Override
     public String toString() {
         return new StringJoiner(", ", getClass().getSimpleName() + "[", "]")