Add an interface that can be customized for the variable length verifier

Author: filiphr

modules/flowable-app-engine/src/main/java/org/flowable/app/engine/AppEngineConfiguration.java

@@ -392,8 +392,8 @@ public void initVariableTypes() {
                 }
             }
             variableTypes.addType(new NullType());
-            variableTypes.addType(new StringType(getMaxLengthString(), maxAllowedLengthVariableType));
-            variableTypes.addType(new LongStringType(getMaxLengthString() + 1, maxAllowedLengthVariableType));
+            variableTypes.addType(new StringType(getMaxLengthString(), variableLengthVerifier));
+            variableTypes.addType(new LongStringType(getMaxLengthString() + 1, variableLengthVerifier));
             variableTypes.addType(new BooleanType());
             variableTypes.addType(new ShortType());
             variableTypes.addType(new IntegerType());
@@ -408,12 +408,12 @@ public void initVariableTypes() {
             variableTypes.addType(new BigDecimalType());
             variableTypes.addType(new BigIntegerType());
             variableTypes.addType(new UUIDType());
-            variableTypes.addType(new JsonType(getMaxLengthString(), maxAllowedLengthVariableType, objectMapper, jsonVariableTypeTrackObjects));
+            variableTypes.addType(new JsonType(getMaxLengthString(), variableLengthVerifier, objectMapper, jsonVariableTypeTrackObjects));
             // longJsonType only needed for reading purposes
-            variableTypes.addType(JsonType.longJsonType(getMaxLengthString(), maxAllowedLengthVariableType, objectMapper, jsonVariableTypeTrackObjects));
-            variableTypes.addType(new ByteArrayType(maxAllowedLengthVariableType));
+            variableTypes.addType(JsonType.longJsonType(getMaxLengthString(), variableLengthVerifier, objectMapper, jsonVariableTypeTrackObjects));
+            variableTypes.addType(new ByteArrayType(variableLengthVerifier));
             variableTypes.addType(new EmptyCollectionType());
-            variableTypes.addType(new SerializableType(serializableVariableTypeTrackDeserializedObjects, maxAllowedLengthVariableType));
+            variableTypes.addType(new SerializableType(serializableVariableTypeTrackDeserializedObjects, variableLengthVerifier));
             if (customPostVariableTypes != null) {
                 for (VariableType customVariableType : customPostVariableTypes) {
                     variableTypes.addType(customVariableType);

modules/flowable-app-rest/src/test/java/org/flowable/rest/app/variable/MaxAllowedShortStringVariableLengthTest.java

@@ -23,6 +23,7 @@
 import org.flowable.cmmn.engine.test.CmmnDeployment;
 import org.flowable.cmmn.spring.impl.test.FlowableCmmnSpringExtension;
 import org.flowable.common.engine.api.FlowableIllegalArgumentException;
+import org.flowable.common.engine.impl.variable.MaxAllowedLengthVariableVerifier;
 import org.flowable.engine.RuntimeService;
 import org.flowable.engine.TaskService;
 import org.flowable.engine.runtime.ProcessInstance;
@@ -181,7 +182,7 @@ static class CustomConfiguration {
         @Bean
         public EngineConfigurationConfigurer<SpringAppEngineConfiguration> customAppEngineConfigurationConfigurer() {
             return appEngineConfiguration -> {
-                appEngineConfiguration.setMaxAllowedLengthVariableType(500);
+                appEngineConfiguration.setVariableLengthVerifier(new MaxAllowedLengthVariableVerifier(500));
             };
         }
     }

modules/flowable-app-rest/src/test/java/org/flowable/rest/app/variable/MaxAllowedVariableLengthTest.java

@@ -29,6 +29,7 @@
 import org.flowable.cmmn.engine.test.CmmnDeployment;
 import org.flowable.cmmn.spring.impl.test.FlowableCmmnSpringExtension;
 import org.flowable.common.engine.api.FlowableIllegalArgumentException;
+import org.flowable.common.engine.impl.variable.MaxAllowedLengthVariableVerifier;
 import org.flowable.engine.RuntimeService;
 import org.flowable.engine.TaskService;
 import org.flowable.engine.runtime.ProcessInstance;
@@ -302,7 +303,7 @@ static class CustomConfiguration {
         @Bean
         public EngineConfigurationConfigurer<SpringAppEngineConfiguration> customAppEngineConfigurationConfigurer() {
             return appEngineConfiguration -> {
-                appEngineConfiguration.setMaxAllowedLengthVariableType(5000);
+                appEngineConfiguration.setVariableLengthVerifier(new MaxAllowedLengthVariableVerifier(5000));
             };
         }
     }

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/CmmnEngineConfiguration.java

@@ -1395,8 +1395,8 @@ public void initVariableTypes() {
                 }
             }
             variableTypes.addType(new NullType());
-            variableTypes.addType(new StringType(getMaxLengthString(), maxAllowedLengthVariableType));
-            variableTypes.addType(new LongStringType(getMaxLengthString() + 1, maxAllowedLengthVariableType));
+            variableTypes.addType(new StringType(getMaxLengthString(), variableLengthVerifier));
+            variableTypes.addType(new LongStringType(getMaxLengthString() + 1, variableLengthVerifier));
             variableTypes.addType(new BooleanType());
             variableTypes.addType(new ShortType());
             variableTypes.addType(new IntegerType());
@@ -1411,13 +1411,13 @@ public void initVariableTypes() {
             variableTypes.addType(new BigDecimalType());
             variableTypes.addType(new BigIntegerType());
             variableTypes.addType(new UUIDType());
-            variableTypes.addType(new JsonType(getMaxLengthString(), maxAllowedLengthVariableType, objectMapper, jsonVariableTypeTrackObjects));
+            variableTypes.addType(new JsonType(getMaxLengthString(), variableLengthVerifier, objectMapper, jsonVariableTypeTrackObjects));
             // longJsonType only needed for reading purposes
-            variableTypes.addType(JsonType.longJsonType(getMaxLengthString(), maxAllowedLengthVariableType, objectMapper, jsonVariableTypeTrackObjects));
+            variableTypes.addType(JsonType.longJsonType(getMaxLengthString(), variableLengthVerifier, objectMapper, jsonVariableTypeTrackObjects));
             variableTypes.addType(new CmmnAggregatedVariableType(this));
-            variableTypes.addType(new ByteArrayType(maxAllowedLengthVariableType));
+            variableTypes.addType(new ByteArrayType(variableLengthVerifier));
             variableTypes.addType(new EmptyCollectionType());
-            variableTypes.addType(new SerializableType(serializableVariableTypeTrackDeserializedObjects, maxAllowedLengthVariableType));
+            variableTypes.addType(new SerializableType(serializableVariableTypeTrackDeserializedObjects, variableLengthVerifier));
 
         } else {
             if (customPreVariableTypes != null) {

modules/flowable-cmmn-engine/src/test/java/org/flowable/cmmn/test/runtime/MaxAllowedShortStringVariableLengthTest.java

@@ -21,6 +21,7 @@
 import org.flowable.cmmn.engine.test.CmmnDeployment;
 import org.flowable.cmmn.test.impl.CustomCmmnConfigurationFlowableTestCase;
 import org.flowable.common.engine.api.FlowableIllegalArgumentException;
+import org.flowable.common.engine.impl.variable.MaxAllowedLengthVariableVerifier;
 import org.flowable.task.api.Task;
 import org.junit.Test;
 
@@ -36,7 +37,7 @@ protected String getEngineName() {
 
     @Override
     protected void configureConfiguration(CmmnEngineConfiguration cmmnEngineConfiguration) {
-        cmmnEngineConfiguration.setMaxAllowedLengthVariableType(500);
+        cmmnEngineConfiguration.setVariableLengthVerifier(new MaxAllowedLengthVariableVerifier(500));
     }
 
     @Test

modules/flowable-cmmn-engine/src/test/java/org/flowable/cmmn/test/runtime/MaxAllowedVariableLengthTest.java

@@ -27,6 +27,7 @@
 import org.flowable.cmmn.engine.test.CmmnDeployment;
 import org.flowable.cmmn.test.impl.CustomCmmnConfigurationFlowableTestCase;
 import org.flowable.common.engine.api.FlowableIllegalArgumentException;
+import org.flowable.common.engine.impl.variable.MaxAllowedLengthVariableVerifier;
 import org.flowable.task.api.Task;
 import org.junit.Test;
 
@@ -44,7 +45,7 @@ protected String getEngineName() {
 
     @Override
     protected void configureConfiguration(CmmnEngineConfiguration cmmnEngineConfiguration) {
-        cmmnEngineConfiguration.setMaxAllowedLengthVariableType(5000);
+        cmmnEngineConfiguration.setVariableLengthVerifier(new MaxAllowedLengthVariableVerifier(5000));
     }
 
     @Test

modules/flowable-engine-common/src/main/java/org/flowable/common/engine/impl/AbstractEngineConfiguration.java

@@ -122,6 +122,8 @@
 import org.flowable.common.engine.impl.util.DefaultClockImpl;
 import org.flowable.common.engine.impl.util.IoUtil;
 import org.flowable.common.engine.impl.util.ReflectUtil;
+import org.flowable.common.engine.impl.variable.NoopVariableLengthVerifier;
+import org.flowable.common.engine.impl.variable.VariableLengthVerifier;
 import org.flowable.eventregistry.api.EventRegistryEventConsumer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -401,10 +403,10 @@ public static Properties getDefaultDatabaseTypeMappings() {
     protected int maxLengthStringVariableType = -1;
 
     /**
-     * Define a max allowed length for storing large variables, e.g. String, JSON, etc. in the database.
-     * If the length of the variable exceeds this value, there will be an exception thrown when trying to store the variable.
+     * Define variable length for variables that have length, e.g. String, JSON, etc.
+     * The length verifier can be used to throw an exception if the length exceeds a certain threshold and / or it can log a warning.
      */
-    protected int maxAllowedLengthVariableType = -1;
+    protected VariableLengthVerifier variableLengthVerifier = NoopVariableLengthVerifier.INSTANCE;
 
     protected void initEngineConfigurations() {
         addEngineConfiguration(getEngineCfgKey(), getEngineScopeType(), this);
@@ -1941,12 +1943,12 @@ public AbstractEngineConfiguration setMaxLengthStringVariableType(int maxLengthS
         return this;
     }
 
-    public int getMaxAllowedLengthVariableType() {
-        return maxAllowedLengthVariableType;
+    public VariableLengthVerifier getVariableLengthVerifier() {
+        return variableLengthVerifier;
     }
 
-    public AbstractEngineConfiguration setMaxAllowedLengthVariableType(int maxAllowedLengthVariableType) {
-        this.maxAllowedLengthVariableType = maxAllowedLengthVariableType;
+    public AbstractEngineConfiguration setVariableLengthVerifier(VariableLengthVerifier variableLengthVerifier) {
+        this.variableLengthVerifier = variableLengthVerifier;
         return this;
     }
 

…service/impl/util/VariableTypeUtils.java …le/MaxAllowedLengthVariableVerifier.javamodules/flowable-variable-service/src/main/java/org/flowable/variable/service/impl/util/VariableTypeUtils.java renamed to modules/flowable-engine-common/src/main/java/org/flowable/common/engine/impl/variable/MaxAllowedLengthVariableVerifier.java modules/flowable-variable-service/src/main/java/org/flowable/variable/service/impl/util/VariableTypeUtils.java renamed to modules/flowable-engine-common/src/main/java/org/flowable/common/engine/impl/variable/MaxAllowedLengthVariableVerifier.java

@@ -10,26 +10,31 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.flowable.variable.service.impl.util;
+package org.flowable.common.engine.impl.variable;
 
 import org.apache.commons.lang3.StringUtils;
 import org.flowable.common.engine.api.FlowableIllegalArgumentException;
-import org.flowable.common.engine.api.FlowableIllegalStateException;
 import org.flowable.common.engine.api.scope.ScopeTypes;
 import org.flowable.variable.api.types.ValueFields;
 import org.flowable.variable.api.types.VariableType;
 
 /**
  * @author Filip Hrisafov
  */
-public class VariableTypeUtils {
+public class MaxAllowedLengthVariableVerifier implements VariableLengthVerifier {
 
-    public static void validateMaxAllowedLength(int maxAllowedLength, int length, ValueFields valueFields, VariableType variableType) {
-        if (maxAllowedLength < 0) {
-            return;
+    protected final int maxAllowedLength;
+
+    public MaxAllowedLengthVariableVerifier(int maxAllowedLength) {
+        if (maxAllowedLength <= 0) {
+            throw new FlowableIllegalArgumentException("The maximum allowed length must be greater than 0");
         }
+        this.maxAllowedLength = maxAllowedLength;
+    }
 
-        if (maxAllowedLength > 0 && length > maxAllowedLength) {
+    @Override
+    public void verifyLength(int length, ValueFields valueFields, VariableType variableType) {
+        if (length > maxAllowedLength) {
             String scopeId;
             String scopeType;
             if (StringUtils.isNotEmpty(valueFields.getTaskId())) {

modules/flowable-engine-common/src/main/java/org/flowable/common/engine/impl/variable/NoopVariableLengthVerifier.java

@@ -0,0 +1,29 @@
+/* Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.flowable.common.engine.impl.variable;
+
+import org.flowable.variable.api.types.ValueFields;
+import org.flowable.variable.api.types.VariableType;
+
+/**
+ * @author Filip Hrisafov
+ */
+public class NoopVariableLengthVerifier implements VariableLengthVerifier {
+
+    public static final VariableLengthVerifier INSTANCE = new NoopVariableLengthVerifier();
+
+    @Override
+    public void verifyLength(int length, ValueFields valueFields, VariableType variableType) {
+        // Nothing to do
+    }
+}

modules/flowable-engine-common/src/main/java/org/flowable/common/engine/impl/variable/VariableLengthVerifier.java

@@ -0,0 +1,25 @@
+/* Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.flowable.common.engine.impl.variable;
+
+import org.flowable.variable.api.types.ValueFields;
+import org.flowable.variable.api.types.VariableType;
+
+/**
+ * @author Filip Hrisafov
+ */
+public interface VariableLengthVerifier {
+
+    void verifyLength(int length, ValueFields valueFields, VariableType variableType);
+
+}