feat(wire.CloudPublisher): Set as body a property removing it from metrics

kura/org.eclipse.kura.wire.component.provider/OSGI-INF/metatype/org.eclipse.kura.wire.CloudPublisher.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-    Copyright (c) 2016, 2020 Eurotech and/or its affiliates and others
+    Copyright (c) 2016, 2023 Eurotech and/or its affiliates and others
 
     This program and the accompanying materials are made
     available under the terms of the Eclipse Public License 2.0
@@ -47,6 +47,15 @@
             default=""
             description="If set to a non empty value, the publisher will set the message body to the value of the provided STRING or BYTE_ARRAY metric.">
         </AD>
+
+        <AD id="remove.body.from.metrics"
+            name="Remove body envelope property from metrics"
+            type="Boolean"
+            cardinality="0"
+            required="true"
+            default="false"
+            description="Set true to remove the metric that is sent as body of the message.">
+        </AD>
     </OCD>
 
     <Designate pid="org.eclipse.kura.wire.CloudPublisher" factoryPid="org.eclipse.kura.wire.CloudPublisher">

kura/org.eclipse.kura.wire.component.provider/src/main/java/org/eclipse/kura/internal/wire/publisher/CloudPublisher.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2016, 2020 Eurotech and/or its affiliates and others
+ * Copyright (c) 2016, 2023 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -60,8 +60,6 @@ public final class CloudPublisher implements WireReceiver, ConfigurableComponent
 
     private static final Logger logger = LogManager.getLogger(CloudPublisher.class);
 
-    private static final String ASSET_NAME_PROPERTY_KEY = "assetName";
-
     private CloudPublisherOptions cloudPublisherOptions;
 
     private volatile WireHelperService wireHelperService;
@@ -235,6 +233,12 @@ private void publishBody(final KuraPayload kuraPayload, final Map<String, TypedV
         } catch (final Exception e) {
             logger.warn("failed to publish body", e);
         }
+
+        boolean isRemoveBodyPropertyFromMetrics = this.cloudPublisherOptions.getRemoveBodyPropertyFromMetrics();
+
+        if (isRemoveBodyPropertyFromMetrics) {
+            kuraPayload.removeMetric(bodyProperty);
+        }
     }
 
     private KuraPosition getPosition() {
@@ -286,6 +290,14 @@ private Map<String, Object> buildKuraMessageProperties(final WireRecord wireReco
         for (String s : l) {
             properties.put(s, wireRecordProps.get(s).getValue());
         }
+
+        Optional<String> bodyProperty = this.cloudPublisherOptions.getBodyProperty();
+        boolean isRemoveBodyPropertyFromMetrics = this.cloudPublisherOptions.getRemoveBodyPropertyFromMetrics();
+
+        if (bodyProperty.isPresent() && isRemoveBodyPropertyFromMetrics) {
+            properties.remove(bodyProperty.get());
+        }
+
         return properties;
     }
 }

kura/org.eclipse.kura.wire.component.provider/src/main/java/org/eclipse/kura/internal/wire/publisher/CloudPublisherOptions.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2016, 2020 Eurotech and/or its affiliates and others
+ * Copyright (c) 2016, 2023 Eurotech and/or its affiliates and others
  * 
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -32,6 +32,7 @@ final class CloudPublisherOptions {
 
     private static final String CONF_POSITION = "publish.position";
     private static final String CONF_BODY_PROPERTY = "set.body.from.property";
+    private static final String CONF_REMOVE_BODY_PROPERTY = "remove.body.from.metrics";
 
     private final Map<String, Object> properties;
 
@@ -82,4 +83,8 @@ Optional<String> getBodyProperty() {
 
         return Optional.of(property);
     }
+
+    boolean getRemoveBodyPropertyFromMetrics() {
+        return (boolean) this.properties.getOrDefault(CONF_REMOVE_BODY_PROPERTY, false);
+    }
 }