#1021: Make last will message optional

Signed-off-by: Vadim Guenther <vadim.guenther@bosch.io>
eclipse-ditto · Apr 8, 2021 · 5fc8763 · 5fc8763
1 parent 4c394dd
commit 5fc8763
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 20 deletions.
diff --git a/.../main/java/org/eclipse/ditto/services/connectivity/messaging/mqtt/MqttSpecificConfig.java b/.../main/java/org/eclipse/ditto/services/connectivity/messaging/mqtt/MqttSpecificConfig.java
@@ -23,7 +23,6 @@
 
 import org.eclipse.ditto.model.connectivity.Connection;
 
-import com.hivemq.client.internal.mqtt.message.connect.MqttConnect;
 import com.typesafe.config.Config;
 import com.typesafe.config.ConfigException;
 import com.typesafe.config.ConfigFactory;
@@ -47,11 +46,11 @@ public final class MqttSpecificConfig {
 
     private static final String LAST_WILL_TOPIC = "lastWillTopic";
     private static final String LAST_WILL_QOS = "lastWillQos";
-    private static final String DEFAULT_LAST_WILL_QOS = "AT_MOST_ONCE";
-    private static final String LAST_WILL_MESSAGE = "lastWillMessage";
-    private static final String DEFAULT_LAST_WILL_MESSAGE = "";
     private static final String LAST_WILL_RETAIN = "lastWillRetain";
+    private static final String LAST_WILL_MESSAGE = "lastWillMessage";
+
     private static final boolean DEFAULT_LAST_WILL_RETAIN = false;
+    private static final String DEFAULT_LAST_WILL_QOS = "AT_MOST_ONCE";
 
     private final Config specificConfig;
 
@@ -142,8 +141,8 @@ public String getMqttWillQos() {
     /**
      * @return the optional publisherId which should be used as the client ID of the publisher actor.
      */
-    public String getMqttWillMessage() {
-        return getSafely(() -> specificConfig.getString(LAST_WILL_MESSAGE), DEFAULT_LAST_WILL_MESSAGE);
+    public Optional<String> getMqttWillMessage() {
+        return getStringOptional(LAST_WILL_MESSAGE);
     }
 
     /**

diff --git a/...ipse/ditto/services/connectivity/messaging/mqtt/hivemq/AbstractHiveMqttClientFactory.java b/...ipse/ditto/services/connectivity/messaging/mqtt/hivemq/AbstractHiveMqttClientFactory.java
@@ -26,8 +26,8 @@
 import org.eclipse.ditto.services.connectivity.messaging.internal.ssl.DittoTrustManagerFactory;
 import org.eclipse.ditto.services.connectivity.messaging.internal.ssl.KeyManagerFactoryFactory;
 import org.eclipse.ditto.services.connectivity.messaging.monitoring.logs.ConnectionLogger;
-import org.eclipse.ditto.services.connectivity.messaging.tunnel.SshTunnelState;
 import org.eclipse.ditto.services.connectivity.messaging.mqtt.MqttSpecificConfig;
+import org.eclipse.ditto.services.connectivity.messaging.tunnel.SshTunnelState;
 
 import com.hivemq.client.mqtt.MqttClientBuilderBase;
 import com.hivemq.client.mqtt.MqttClientSslConfig;
@@ -83,23 +83,30 @@ void configureSimpleAuth(final Mqtt5SimpleAuthBuilder.Nested<?> simpleAuth, fina
     void configureWillPublish(final Mqtt3WillPublishBuilder.Nested<? extends Mqtt3ClientBuilder> willPublish,
             final Connection connection) {
         final MqttSpecificConfig mqttSpecificConfig = MqttSpecificConfig.fromConnection(connection);
-        mqttSpecificConfig.getMqttWillTopic().ifPresent(topic -> willPublish
-                .topic(topic)
-                .qos(MqttQos.valueOf(mqttSpecificConfig.getMqttWillQos()))
-                .payload(mqttSpecificConfig.getMqttWillMessage().getBytes(StandardCharsets.UTF_8))
-                .retain(mqttSpecificConfig.getMqttWillRetain())
-                .applyWillPublish());
+        //Since topic is required, the other LWT parameter will only be applied if the topic is set
+        mqttSpecificConfig.getMqttWillTopic().ifPresent(topic -> {
+            final Mqtt3WillPublishBuilder.Nested.Complete<? extends Mqtt3ClientBuilder> willPublishStep = willPublish
+                    .topic(topic)
+                    .qos(MqttQos.valueOf(mqttSpecificConfig.getMqttWillQos()))
+                    .retain(mqttSpecificConfig.getMqttWillRetain());
+
+            mqttSpecificConfig.getMqttWillMessage().ifPresent(message -> willPublishStep.payload(message.getBytes()));
+            willPublishStep.applyWillPublish();
+        });
     }
 
     void configureWillPublish(final Mqtt5WillPublishBuilder.Nested<? extends Mqtt5ClientBuilder> willPublish,
-            Connection connection){
+            Connection connection) {
         final MqttSpecificConfig mqttSpecificConfig = MqttSpecificConfig.fromConnection(connection);
-        mqttSpecificConfig.getMqttWillTopic().ifPresent(topic -> willPublish
-                .topic(topic)
-                .qos(MqttQos.valueOf(mqttSpecificConfig.getMqttWillQos()))
-                .payload(mqttSpecificConfig.getMqttWillMessage().getBytes(StandardCharsets.UTF_8))
-                .retain(mqttSpecificConfig.getMqttWillRetain())
-                .applyWillPublish());
+        //Since topic is required, the other LWT parameter will only be applied if the topic is set
+        mqttSpecificConfig.getMqttWillTopic().ifPresent(topic -> {
+            final Mqtt5WillPublishBuilder.Nested.Complete<? extends Mqtt5ClientBuilder> willPublishStep = willPublish
+                    .topic(topic)
+                    .qos(MqttQos.valueOf(mqttSpecificConfig.getMqttWillQos()))
+                    .retain(mqttSpecificConfig.getMqttWillRetain());
+            mqttSpecificConfig.getMqttWillMessage().ifPresent(message -> willPublishStep.payload(message.getBytes()));
+            willPublishStep.applyWillPublish();
+        });
     }
 
     <T extends MqttClientBuilderBase<T>> T configureClientBuilder(