Merge pull request #5282 from supriyoMondal/mqtt-position-forwarding

feat: add configuration for event forwarding with mqtt

4 files changed, 139 insertions, 60 deletions

diff --git a/src/main/java/org/traccar/MainModule.java b/src/main/java/org/traccar/MainModule.java
index acdf48874..26654947e 100644
--- a/src/main/java/org/traccar/MainModule.java
+++ b/src/main/java/org/traccar/MainModule.java
@@ -46,6 +46,7 @@ import org.traccar.forward.PositionForwarderAmqp;
 import org.traccar.forward.PositionForwarderKafka;
 import org.traccar.forward.PositionForwarderRedis;
 import org.traccar.forward.PositionForwarderUrl;
+import org.traccar.forward.PositionForwarderMqtt;
 import org.traccar.geocoder.AddressFormat;
 import org.traccar.geocoder.BanGeocoder;
 import org.traccar.geocoder.BingMapsGeocoder;
@@ -383,6 +384,8 @@ public class MainModule extends AbstractModule {
                     return new PositionForwarderAmqp(config, objectMapper);
                 case "kafka":
                     return new PositionForwarderKafka(config, objectMapper);
+                case "mqtt":
+                    return new PositionForwarderMqtt(config, objectMapper);
                 case "redis":
                     return new PositionForwarderRedis(config, objectMapper);
                 case "url":
diff --git a/src/main/java/org/traccar/forward/EventForwarderMqtt.java b/src/main/java/org/traccar/forward/EventForwarderMqtt.java
index 7f4e29384..7d1c7dd3c 100644
--- a/src/main/java/org/traccar/forward/EventForwarderMqtt.java
+++ b/src/main/java/org/traccar/forward/EventForwarderMqtt.java
@@ -15,86 +15,34 @@
  */
 package org.traccar.forward;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.hivemq.client.mqtt.datatypes.MqttQos;
-import com.hivemq.client.mqtt.mqtt5.Mqtt5AsyncClient;
-import com.hivemq.client.mqtt.mqtt5.Mqtt5Client;
-import com.hivemq.client.mqtt.mqtt5.message.auth.Mqtt5SimpleAuth;
 import org.traccar.config.Config;
 import org.traccar.config.Keys;
 
-import java.net.URI;
-import java.net.URISyntaxException;
-import java.util.UUID;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
 
 public class EventForwarderMqtt implements EventForwarder {
 
-    private final Mqtt5AsyncClient client;
+    private final MqttClient mqttClient;
     private final ObjectMapper objectMapper;
 
     private final String topic;
 
     public EventForwarderMqtt(Config config, ObjectMapper objectMapper) {
-        URI url;
-        try {
-            url = new URI(config.getString(Keys.EVENT_FORWARD_URL));
-        } catch (URISyntaxException e) {
-            throw new RuntimeException(e);
-        }
-
-        String userInfo = url.getUserInfo();
-        Mqtt5SimpleAuth simpleAuth = null;
-        if (userInfo != null) {
-            int delimiter = userInfo.indexOf(':');
-            if (delimiter == -1) {
-                throw new IllegalArgumentException("Wrong credentials. Should be in format \"username:password\"");
-            } else {
-                simpleAuth = Mqtt5SimpleAuth.builder()
-                        .username(userInfo.substring(0, delimiter++))
-                        .password(userInfo.substring(delimiter).getBytes())
-                        .build();
-            }
-        }
-
-        String host = url.getHost();
-        int port = url.getPort();
-        client = Mqtt5Client.builder()
-                .identifier("traccar-" + UUID.randomUUID())
-                .serverHost(host)
-                .serverPort(port)
-                .simpleAuth(simpleAuth)
-                .automaticReconnectWithDefaultConfig()
-                .buildAsync();
-
-        client.connectWith()
-                .send()
-                .whenComplete((message, e) -> {
-                    if (e != null) {
-                        throw new RuntimeException(e);
-                    }
-                });
-
+        this.topic = config.getString(Keys.EVENT_FORWARD_TOPIC);
+        mqttClient = new MqttClient(config.getString(Keys.FORWARD_URL));
         this.objectMapper = objectMapper;
-        topic = config.getString(Keys.EVENT_FORWARD_TOPIC);
     }
 
     @Override
     public void forward(EventData eventData, ResultHandler resultHandler) {
-        byte[] payload;
+        String payload;
         try {
-            payload = objectMapper.writeValueAsString(eventData).getBytes();
+            payload = objectMapper.writeValueAsString(eventData);
+            mqttClient.publish(topic, payload, (message, e) -> resultHandler.onResult(e == null, e));
         } catch (JsonProcessingException e) {
             resultHandler.onResult(false, e);
-            return;
         }
-
-        client.publishWith()
-                .topic(topic)
-                .qos(MqttQos.AT_LEAST_ONCE)
-                .payload(payload)
-                .send()
-                .whenComplete((message, e) -> resultHandler.onResult(e == null, e));
     }
 
 }
diff --git a/src/main/java/org/traccar/forward/MqttClient.java b/src/main/java/org/traccar/forward/MqttClient.java
new file mode 100644
index 000000000..ad3065b58
--- /dev/null
+++ b/src/main/java/org/traccar/forward/MqttClient.java
@@ -0,0 +1,76 @@
+/*
+ * Copyright 2024 Anton Tananaev (anton@traccar.org)
+ *
+ * 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.traccar.forward;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.UUID;
+import java.util.function.BiConsumer;
+
+import com.hivemq.client.mqtt.datatypes.MqttQos;
+import com.hivemq.client.mqtt.mqtt5.Mqtt5AsyncClient;
+import com.hivemq.client.mqtt.mqtt5.Mqtt5Client;
+import com.hivemq.client.mqtt.mqtt5.Mqtt5ClientBuilder;
+import com.hivemq.client.mqtt.mqtt5.message.auth.Mqtt5SimpleAuth;
+import com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5PublishResult;
+
+public class MqttClient {
+    private final Mqtt5AsyncClient client;
+    MqttClient(String url) {
+        URI uri;
+        try {
+            uri = new URI(url);
+        } catch (URISyntaxException e) {
+            throw new RuntimeException(e);
+        }
+
+        Mqtt5SimpleAuth simpleAuth = this.getSimpleAuth(uri);
+
+        String host = uri.getHost();
+        int port = uri.getPort();
+        Mqtt5ClientBuilder builder = Mqtt5Client.builder().identifier("traccar-" + UUID.randomUUID())
+                .serverHost(host).serverPort(port).simpleAuth(simpleAuth).automaticReconnectWithDefaultConfig();
+
+        client = builder.buildAsync();
+        client.connectWith().send().whenComplete((message, e) -> {
+            throw new RuntimeException(e);
+        });
+    }
+
+
+    private Mqtt5SimpleAuth getSimpleAuth(final URI uri) {
+        String userInfo = uri.getUserInfo();
+        Mqtt5SimpleAuth simpleAuth = null;
+        if (userInfo != null) {
+            int delimiter = userInfo.indexOf(':');
+            if (delimiter == -1) {
+                throw new IllegalArgumentException("Wrong MQTT credentials. Should be in format \"username:password\"");
+            } else {
+                simpleAuth = Mqtt5SimpleAuth.builder().username(userInfo.substring(0, delimiter++))
+                        .password(userInfo.substring(delimiter).getBytes()).build();
+            }
+        }
+        return simpleAuth;
+    }
+
+    public void publish(final String pubTopic, final String payload,
+                               final BiConsumer<? super Mqtt5PublishResult,
+                                       ? super Throwable> whenComplete) {
+        client.publishWith().topic(pubTopic).qos(MqttQos.AT_LEAST_ONCE).payload(payload.getBytes()).send()
+                .whenComplete(whenComplete);
+    }
+
+}
diff --git a/src/main/java/org/traccar/forward/PositionForwarderMqtt.java b/src/main/java/org/traccar/forward/PositionForwarderMqtt.java
new file mode 100644
index 000000000..abbdc538a
--- /dev/null
+++ b/src/main/java/org/traccar/forward/PositionForwarderMqtt.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright 2024 Anton Tananaev (anton@traccar.org)
+ *
+ * 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.traccar.forward;
+
+import org.traccar.config.Config;
+import org.traccar.config.Keys;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+public class PositionForwarderMqtt implements PositionForwarder {
+    private final MqttClient mqttClient;
+
+    @Override
+    public void forward(final PositionData positionData, final ResultHandler resultHandler) {
+        publish(topic, positionData, resultHandler);
+    }
+    private final ObjectMapper objectMapper;
+
+    protected final String topic;
+
+
+    public PositionForwarderMqtt(final Config config, final ObjectMapper objectMapper) {
+        this.topic = config.getString(Keys.FORWARD_TOPIC);
+        mqttClient = new MqttClient(config.getString(Keys.FORWARD_URL));
+        this.objectMapper = objectMapper;
+    }
+
+    protected void publish(final String pubTopic, final Object object, final ResultHandler resultHandler) {
+        final String payload;
+        try {
+            payload = objectMapper.writeValueAsString(object);
+            mqttClient.publish(pubTopic, payload, (message, e) -> resultHandler.onResult(e == null, e));
+        } catch (JsonProcessingException e) {
+            resultHandler.onResult(false, e);
+        }
+    }
+
+}