From 7bf7db6d936ca855a6ebac9a9b80795d9c4d17e8 Mon Sep 17 00:00:00 2001
From: Alberto Codutti <alberto.codutti@eurotech.com>
Date: Thu, 19 Dec 2024 16:53:15 +0100
Subject: [PATCH] :sparkles: [Job] Support for JSON-formatted in
 JobStepProperties.value for complex properties

Signed-off-by: Alberto Codutti <alberto.codutti@eurotech.com>
---
 .../commons/wrappers/StepContextWrapper.java  | 11 ++++++----
 ...viceConfigurationPutJobStepDefinition.java |  2 +-
 .../job/step/internal/JobStepServiceImpl.java | 22 +++++++++++++++----
 3 files changed, 26 insertions(+), 9 deletions(-)

diff --git a/job-engine/commons/src/main/java/org/eclipse/kapua/job/engine/commons/wrappers/StepContextWrapper.java b/job-engine/commons/src/main/java/org/eclipse/kapua/job/engine/commons/wrappers/StepContextWrapper.java
index fe70fbd9207..bd82796ca4e 100644
--- a/job-engine/commons/src/main/java/org/eclipse/kapua/job/engine/commons/wrappers/StepContextWrapper.java
+++ b/job-engine/commons/src/main/java/org/eclipse/kapua/job/engine/commons/wrappers/StepContextWrapper.java
@@ -19,14 +19,12 @@
 import javax.batch.runtime.Metric;
 import javax.batch.runtime.context.StepContext;
 import javax.xml.bind.DatatypeConverter;
-import javax.xml.bind.JAXBException;
 
 import org.eclipse.kapua.KapuaIllegalArgumentException;
 import org.eclipse.kapua.KapuaRuntimeException;
 import org.eclipse.kapua.commons.util.xml.XmlUtil;
 import org.eclipse.kapua.model.id.KapuaId;
 import org.eclipse.kapua.model.id.KapuaIdFactory;
-import org.xml.sax.SAXException;
 
 import com.google.common.base.Strings;
 
@@ -96,10 +94,15 @@ public <T, E extends Enum<E>> T getStepProperty(String stepPropertyName, Class<T
                     throw new KapuaIllegalArgumentException(stepPropertyName, stepPropertyString);
                 }
             } else {
+                // Try both formats: XML - JSON
                 try {
                     stepProperty = xmlUtil.unmarshal(stepPropertyString, type);
-                } catch (JAXBException | SAXException e) {
-                    throw new KapuaIllegalArgumentException(stepPropertyName, stepPropertyString);
+                } catch (Exception eXml) {
+                    try {
+                        stepProperty = xmlUtil.unmarshalJson(stepPropertyString, type);
+                    } catch (Exception eJson) {
+                        throw new KapuaIllegalArgumentException(stepPropertyName, stepPropertyString);
+                    }
                 }
             }
         } else {
diff --git a/service/device/management/configuration/job/src/main/java/org/eclipse/kapua/service/device/management/configuration/job/definition/DeviceConfigurationPutJobStepDefinition.java b/service/device/management/configuration/job/src/main/java/org/eclipse/kapua/service/device/management/configuration/job/definition/DeviceConfigurationPutJobStepDefinition.java
index c0df4cd3407..60fdd078328 100644
--- a/service/device/management/configuration/job/src/main/java/org/eclipse/kapua/service/device/management/configuration/job/definition/DeviceConfigurationPutJobStepDefinition.java
+++ b/service/device/management/configuration/job/src/main/java/org/eclipse/kapua/service/device/management/configuration/job/definition/DeviceConfigurationPutJobStepDefinition.java
@@ -43,7 +43,7 @@ public DeviceConfigurationPutJobStepDefinition() {
                 Lists.newArrayList(
                         new JobStepPropertyRecord(
                                 DeviceConfigurationPutPropertyKeys.CONFIGURATION,
-                                "XML string that defines the configuration update sent",
+                                "XML or JSON string that defines the configuration update sent to the target devices",
                                 DeviceConfiguration.class.getName(),
                                 null,
                                 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<deviceConfigurations xmlns:ns0=\"http://www.osgi.org/xmlns/metatype/v1.2.0\">\n    <configuration>\n    <id>org.eclipse.kura.demo.heater.Heater</id>\n    <properties>\n        <property name=\"temperature.increment\" array=\"false\" encrypted=\"false\" type=\"Float\">\n            <value>0.25</value>\n        </property>\n        <property name=\"publish.rate\" array=\"false\" encrypted=\"false\" type=\"Integer\">\n            <value>60</value>\n        </property>\n        <property name=\"program.stopTime\" array=\"false\" encrypted=\"false\" type=\"String\">\n            <value>22:00</value>\n        </property>\n        <property name=\"publish.retain\" array=\"false\" encrypted=\"false\" type=\"Boolean\">\n            <value>false</value>\n        </property>\n        <property name=\"service.pid\" array=\"false\" encrypted=\"false\" type=\"String\">\n            <value>org.eclipse.kura.demo.heater.Heater</value>\n        </property>\n        <property name=\"kura.service.pid\" array=\"false\" encrypted=\"false\" type=\"String\">\n            <value>org.eclipse.kura.demo.heater.Heater</value>\n        </property>\n        <property name=\"program.startTime\" array=\"false\" encrypted=\"false\" type=\"String\">\n            <value>06:00</value>\n        </property>\n        <property name=\"mode\" array=\"false\" encrypted=\"false\" type=\"String\">\n            <value>Program</value>\n        </property>\n        <property name=\"publish.semanticTopic\" array=\"false\" encrypted=\"false\" type=\"String\">\n            <value>data/210</value>\n        </property>\n        <property name=\"manual.setPoint\" array=\"false\" encrypted=\"false\" type=\"Float\">\n            <value>30.0</value>\n        </property>\n        <property name=\"publish.qos\" array=\"false\" encrypted=\"false\" type=\"Integer\">\n            <value>2</value>\n        </property>\n        <property name=\"temperature.initial\" array=\"false\" encrypted=\"false\" type=\"Float\">\n            <value>13.0</value>\n        </property>\n        <property name=\"program.setPoint\" array=\"false\" encrypted=\"false\" type=\"Float\">\n            <value>30.0</value>\n        </property>\n    </properties>\n    </configuration>\n</deviceConfigurations>",
diff --git a/service/job/internal/src/main/java/org/eclipse/kapua/service/job/step/internal/JobStepServiceImpl.java b/service/job/internal/src/main/java/org/eclipse/kapua/service/job/step/internal/JobStepServiceImpl.java
index f50bed40469..ead07713317 100644
--- a/service/job/internal/src/main/java/org/eclipse/kapua/service/job/step/internal/JobStepServiceImpl.java
+++ b/service/job/internal/src/main/java/org/eclipse/kapua/service/job/step/internal/JobStepServiceImpl.java
@@ -129,6 +129,7 @@ public JobStep create(JobStepCreator jobStepCreator) throws KapuaException {
         return txManager.execute(tx -> {
             // Check job step definition
             validateJobStepProperties(tx, jobStepCreator);
+
             // Check duplicate name
             if (jobStepRepository.countEntitiesWithNameInScope(
                     tx,
@@ -420,9 +421,17 @@ private void validateJobStepProperties(List<JobStepProperty> jobStepProperties,
                     }
 
                     if (jobStepProperty.getPropertyValue() != null) {
-                        ArgumentValidator.areEqual(jobStepProperty.getPropertyType(), jobStepDefinitionProperty.getPropertyType(), "stepProperties[]." + jobStepProperty.getName());
-                        ArgumentValidator.lengthRange(jobStepProperty.getPropertyValue(), jobStepDefinitionProperty.getMinLength(), jobStepDefinitionProperty.getMaxLength(),
-                                                      "stepProperties[]." + jobStepProperty.getName());
+                        ArgumentValidator.areEqual(
+                                jobStepProperty.getPropertyType(),
+                                jobStepDefinitionProperty.getPropertyType(),
+                                "stepProperties[]." + jobStepProperty.getName()
+                        );
+                        ArgumentValidator.lengthRange(
+                                jobStepProperty.getPropertyValue(),
+                                jobStepDefinitionProperty.getMinLength(),
+                                jobStepDefinitionProperty.getMaxLength(),
+                                "stepProperties[]." + jobStepProperty.getName()
+                        );
 
                         validateJobStepPropertyValue(jobStepProperty, jobStepDefinitionProperty);
                     }
@@ -455,7 +464,12 @@ private <C extends Comparable<C>, E extends Enum<E>> void validateJobStepPropert
                 Class<E> jobStepDefinitionPropertyClassEnum = (Class<E>) jobStepDefinitionPropertyClass;
                 Enum.valueOf(jobStepDefinitionPropertyClassEnum, jobStepProperty.getPropertyValue());
             } else {
-                xmlUtil.unmarshal(jobStepProperty.getPropertyValue(), jobStepDefinitionPropertyClass);
+                // Try both formats: XML - JSON
+                try {
+                    xmlUtil.unmarshal(jobStepProperty.getPropertyValue(), jobStepDefinitionPropertyClass);
+                } catch (Exception e) {
+                    xmlUtil.unmarshalJson(jobStepProperty.getPropertyValue(), jobStepDefinitionPropertyClass);
+                }
             }
 
         } catch (KapuaIllegalArgumentException kiae) {