refactor: remove birth.cert.policy from standard cloud service implem…

…entations (#4859) * refactor(core.cloud): removed birth.cert.policy option Signed-off-by: Marcello Martina <[email protected]> * refactor: updated snapshots to remove birth.cert.policy option from cloud connections Signed-off-by: Marcello Martina <[email protected]> * test: adjusted tests for missing property Signed-off-by: Marcello Martina <[email protected]> * refactor: remove unused class Signed-off-by: Marcello Martina <[email protected]> * refactor: removed lefovers in tests Signed-off-by: Marcello Martina <[email protected]> --------- Signed-off-by: Marcello Martina <[email protected]>
eclipse-kura · Sep 15, 2023 · 613779f · 613779f
1 parent a9ed3b3
commit 613779f
Show file tree

Hide file tree

Showing 22 changed files with 6 additions and 336 deletions.
diff --git a/kura/distrib/src/main/resources/common/snapshots/snapshot_0.xml-generic-device b/kura/distrib/src/main/resources/common/snapshots/snapshot_0.xml-generic-device
@@ -384,9 +384,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Unknown Generic Device</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/common/snapshots/snapshot_0.xml-intelup2 b/kura/distrib/src/main/resources/common/snapshots/snapshot_0.xml-intelup2
@@ -339,9 +339,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Intel UP²</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/common/snapshots/snapshot_0.xml-jetson-nano b/kura/distrib/src/main/resources/common/snapshots/snapshot_0.xml-jetson-nano
@@ -303,9 +303,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Nvidia Jetson Nano</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/common/snapshots/snapshot_0.xml-raspberry b/kura/distrib/src/main/resources/common/snapshots/snapshot_0.xml-raspberry
@@ -384,9 +384,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Raspberry Pi</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/docker-x86_64-nn/snapshot_0.xml b/kura/distrib/src/main/resources/docker-x86_64-nn/snapshot_0.xml
@@ -220,9 +220,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Intel UP²</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/intel-up2-ubuntu-20-nn/snapshot_0.xml b/kura/distrib/src/main/resources/intel-up2-ubuntu-20-nn/snapshot_0.xml
@@ -220,9 +220,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Intel UP²</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/intel-up2-ubuntu-20/snapshot_0.xml b/kura/distrib/src/main/resources/intel-up2-ubuntu-20/snapshot_0.xml
@@ -327,9 +327,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Intel UP²</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/nvidia-jetson-nano-nn/snapshot_0.xml b/kura/distrib/src/main/resources/nvidia-jetson-nano-nn/snapshot_0.xml
@@ -220,9 +220,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Nvidia Jetson Nano</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/nvidia-jetson-nano/snapshot_0.xml b/kura/distrib/src/main/resources/nvidia-jetson-nano/snapshot_0.xml
@@ -294,9 +294,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Nvidia Jetson Nano</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/raspberry-pi-arm64-nn/snapshot_0.xml b/kura/distrib/src/main/resources/raspberry-pi-arm64-nn/snapshot_0.xml
@@ -220,9 +220,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Raspberry Pi 3/4</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/raspberry-pi-arm64/snapshot_0.xml b/kura/distrib/src/main/resources/raspberry-pi-arm64/snapshot_0.xml
@@ -381,9 +381,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Raspberry Pi 3/4</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/raspberry-pi-armhf-nn/snapshot_0.xml b/kura/distrib/src/main/resources/raspberry-pi-armhf-nn/snapshot_0.xml
@@ -220,9 +220,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Raspberry Pi 2</esf:value>
             </esf:property>

diff --git a/kura/distrib/src/main/resources/raspberry-pi-armhf/snapshot_0.xml b/kura/distrib/src/main/resources/raspberry-pi-armhf/snapshot_0.xml
@@ -387,9 +387,6 @@
             <esf:property array="false" encrypted="false" name="topic.control-prefix" type="String">
                 <esf:value>$EDC</esf:value>
             </esf:property>
-            <esf:property array="false" encrypted="false" name="birth.cert.policy" type="String">
-                <esf:value>birth-connect-reconnect</esf:value>
-            </esf:property>
             <esf:property array="false" encrypted="false" name="device.custom-name" type="String">
                 <esf:value>Raspberry Pi 2</esf:value>
             </esf:property>

diff --git a/.../OSGI-INF/metatype/org.eclipse.kura.cloudconnection.eclipseiot.mqtt.ConnectionManager.xml b/.../OSGI-INF/metatype/org.eclipse.kura.cloudconnection.eclipseiot.mqtt.ConnectionManager.xml
@@ -65,18 +65,6 @@
             required="true"
             default="false"
             description="Whether or not to republish the MQTT Birth Certificate on modem detection event"/>
-
-        <AD id="birth.cert.policy"
-            name="Birth Cert Policy"
-            type="String"
-            cardinality="0"
-            required="true"
-            default="birth-connect-reconnect"
-            description="Specify the birth certificate policy.">
-            <Option label="Disable publishing" value="disable" />
-            <Option label="Publish birth on connect" value="birth-connect" />
-            <Option label="Publish birth on connect and reconnect" value="birth-connect-reconnect" />
-        </AD>
 
         <AD id="payload.encoding"
             name="Payload Encoding"

diff --git a/...lipse/kura/internal/cloudconnection/eclipseiot/mqtt/cloud/CloudConnectionManagerImpl.java b/...lipse/kura/internal/cloudconnection/eclipseiot/mqtt/cloud/CloudConnectionManagerImpl.java
@@ -120,7 +120,6 @@ public class CloudConnectionManagerImpl
     String rssi;
     String modemFwVer;
 
-    private boolean birthPublished;
     private String ownPid;
 
     private final AtomicInteger messageId;
@@ -443,8 +442,6 @@ public void onDisconnecting() {
         } catch (KuraException e) {
             logger.warn("Cannot publish disconnect certificate");
         }
-
-        this.birthPublished = false;
     }
 
     @Override
@@ -602,20 +599,7 @@ public KuraPayload buildFromByteArray(byte[] payload) throws KuraException {
     // ----------------------------------------------------------------
 
     private void setupCloudConnection(boolean isNewConnection) throws KuraException {
-        // publish birth certificate unless it has already been published
-        // and republish is disabled
-        boolean publishBirth = true;
-        if (this.birthPublished && !this.options.getRepubBirthCertOnReconnect()) {
-            publishBirth = false;
-            logger.info("Birth certificate republish is disabled in configuration");
-        }
-
-        // publish birth certificate
-        if (publishBirth) {
-            publishBirthCertificate(isNewConnection);
-            this.birthPublished = true;
-        }
-
+        publishBirthCertificate(isNewConnection);
         setupDeviceSubscriptions();
     }
 
@@ -630,10 +614,6 @@ private void setupDeviceSubscriptions() throws KuraException {
     }
 
     private void publishBirthCertificate(boolean isNewConnection) throws KuraException {
-        if (this.options.isLifecycleCertsDisabled()) {
-            return;
-        }
-
         LifecycleMessage birthToPublish = new LifecycleMessage(this.options, this).asBirthCertificateMessage();
 
         if (isNewConnection) {
@@ -644,10 +624,6 @@ private void publishBirthCertificate(boolean isNewConnection) throws KuraExcepti
     }
 
     private void publishDisconnectCertificate() throws KuraException {
-        if (this.options.isLifecycleCertsDisabled()) {
-            return;
-        }
-
         publishLifeCycleMessage(new LifecycleMessage(this.options, this).asDisconnectCertificateMessage());
     }
 

diff --git a/...se/kura/internal/cloudconnection/eclipseiot/mqtt/cloud/CloudConnectionManagerOptions.java b/...se/kura/internal/cloudconnection/eclipseiot/mqtt/cloud/CloudConnectionManagerOptions.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2020 Eurotech and/or its affiliates and others
+ * Copyright (c) 2011, 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
@@ -12,9 +12,6 @@
  *******************************************************************************/
 package org.eclipse.kura.internal.cloudconnection.eclipseiot.mqtt.cloud;
 
-import static org.eclipse.kura.internal.cloudconnection.eclipseiot.mqtt.cloud.CloudServiceLifecycleCertsPolicy.DISABLE_PUBLISHING;
-import static org.eclipse.kura.internal.cloudconnection.eclipseiot.mqtt.cloud.CloudServiceLifecycleCertsPolicy.PUBLISH_BIRTH_CONNECT_RECONNECT;
-
 import java.util.Map;
 
 import org.eclipse.kura.cloud.CloudPayloadEncoding;
@@ -37,7 +34,6 @@ public class CloudConnectionManagerOptions {
     private static final String ENCODE_GZIP = "encode.gzip";
     private static final String REPUB_BIRTH_ON_GPS_LOCK = "republish.mqtt.birth.cert.on.gps.lock";
     private static final String REPUB_BIRTH_ON_MODEM_DETECT = "republish.mqtt.birth.cert.on.modem.detect";
-    private static final String BIRTH_CERT_POLICY = "birth.cert.policy";
     private static final String PAYLOAD_ENCODING = "payload.encoding";
 
     private static final int LIFECYCLE_QOS = 1;
@@ -133,45 +129,6 @@ public boolean getRepubBirthCertOnModemDetection() {
         return repubBirth;
     }
 
-    /**
-     * This method parses the Cloud Service configuration and returns true if the Cloud Service instance should
-     * not publish lifecycle messages.
-     *
-     * @return a boolean value.
-     */
-    public boolean isLifecycleCertsDisabled() {
-        boolean birthPubDisabled = false;
-        String birthPubPolicy = "";
-        if (this.properties != null && this.properties.get(BIRTH_CERT_POLICY) != null
-                && this.properties.get(BIRTH_CERT_POLICY) instanceof String) {
-            birthPubPolicy = (String) this.properties.get(BIRTH_CERT_POLICY);
-        }
-        if (DISABLE_PUBLISHING.getValue().equals(birthPubPolicy)) {
-            birthPubDisabled = true;
-        }
-        return birthPubDisabled;
-    }
-
-    /**
-     * This method parses the Cloud Service configuration and returns true if the Cloud Service instance should
-     * republish the birth message on a reconnection.
-     * By default, this method returns true.
-     *
-     * @return a boolean value.
-     */
-    public boolean getRepubBirthCertOnReconnect() {
-        boolean republishBirt = true;
-        String birthPubPolicy = "";
-        if (this.properties != null && this.properties.get(BIRTH_CERT_POLICY) != null
-                && this.properties.get(BIRTH_CERT_POLICY) instanceof String) {
-            birthPubPolicy = (String) this.properties.get(BIRTH_CERT_POLICY);
-        }
-        if (!PUBLISH_BIRTH_CONNECT_RECONNECT.getValue().equals(birthPubPolicy)) {
-            republishBirt = false;
-        }
-        return republishBirt;
-    }
-
     /**
      * This method parses the Cloud Service configuration and returns the selected cloud payload encoding.
      * By default, this method returns {@link CloudPayloadEncoding} {@code KURA_PROTOBUF}.

diff --git a/kura/org.eclipse.kura.core.cloud/OSGI-INF/metatype/org.eclipse.kura.cloud.CloudService.xml b/kura/org.eclipse.kura.core.cloud/OSGI-INF/metatype/org.eclipse.kura.cloud.CloudService.xml
@@ -93,19 +93,7 @@
             required="true"
             default="true"
             description="Manages the default subscriptions to the gateway management MQTT topics. When disabled, the gateway will not be remotely manageable."/>
-
-        <AD id="birth.cert.policy"
-            name="Birth Cert Policy"
-            type="String"
-            cardinality="0"
-            required="true"
-            default="birth-connect-reconnect"
-            description="Specify the birth certificate policy.">
-            <Option label="Disable publishing" value="disable" />
-            <Option label="Publish birth on connect" value="birth-connect" />
-            <Option label="Publish birth on connect and reconnect" value="birth-connect-reconnect" />
-        </AD>
-
+
         <AD id="payload.encoding"
             name="Payload Encoding"
             type="String"

diff --git a/...g.eclipse.kura.core.cloud/src/main/java/org/eclipse/kura/core/cloud/CloudServiceImpl.java b/...g.eclipse.kura.core.cloud/src/main/java/org/eclipse/kura/core/cloud/CloudServiceImpl.java
@@ -154,7 +154,6 @@ public class CloudServiceImpl
     String modemFwVer;
 
     private boolean subscribed;
-    private boolean birthPublished;
 
     private final AtomicInteger messageId;
 
@@ -572,8 +571,6 @@ public void onDisconnecting() {
         } catch (KuraException e) {
             logger.warn("Cannot publish disconnect certificate");
         }
-
-        this.birthPublished = false;
     }
 
     @Override
@@ -808,19 +805,7 @@ private void setupCloudConnection(boolean isNewConnection) throws KuraException
             this.subscribed = false;
         }
 
-        // publish birth certificate unless it has already been published
-        // and republish is disabled
-        boolean publishBirth = true;
-        if (this.birthPublished && !this.options.getRepubBirthCertOnReconnect()) {
-            publishBirth = false;
-            logger.info("Birth certificate republish is disabled in configuration");
-        }
-
-        // publish birth certificate
-        if (publishBirth) {
-            publishBirthCertificate(isNewConnection);
-            this.birthPublished = true;
-        }
+        publishBirthCertificate(isNewConnection);
 
         // restore or remove default subscriptions
         if (this.options.getEnableDefaultSubscriptions()) {
@@ -838,10 +823,6 @@ private void setupCloudConnection(boolean isNewConnection) throws KuraException
     }
 
     private void publishBirthCertificate(boolean isNewConnection) throws KuraException {
-        if (this.options.isLifecycleCertsDisabled()) {
-            return;
-        }
-
         LifecycleMessage birthToPublish = new LifecycleMessage(this.options, this).asBirthCertificateMessage();
 
         if (isNewConnection) {
@@ -852,18 +833,10 @@ private void publishBirthCertificate(boolean isNewConnection) throws KuraExcepti
     }
 
     private void publishDisconnectCertificate() throws KuraException {
-        if (this.options.isLifecycleCertsDisabled()) {
-            return;
-        }
-
         publishLifeCycleMessage(new LifecycleMessage(this.options, this).asDisconnectCertificateMessage());
     }
 
     private void publishAppCertificate() {
-        if (this.options.isLifecycleCertsDisabled()) {
-            return;
-        }
-
         publishWithDelay(new LifecycleMessage(this.options, this).asAppCertificateMessage());
     }