MQTT for SubmodelService (#339)

* submodelservice-feature-mqtt added Signed-off-by: rana <[email protected]> * submodelservice-feature-mqtt read.me file removed Signed-off-by: rana <[email protected]> * submodelservice-feature-mqtt restructred Signed-off-by: rana <[email protected]> * submodelservice-feature-mqtt changed according to feedback Signed-off-by: rana <[email protected]> * submodelservice-feature-mqtt code-format changed Signed-off-by: rana <[email protected]> * submodelservice-feature-mqtt pom.xml chnaged Signed-off-by: rana <[email protected]> --------- Signed-off-by: rana <[email protected]>
eclipse-basyx · Aug 27, 2024 · b34d232 · b34d232
1 parent af2318b
commit b34d232
Show file tree

Hide file tree

Showing 10 changed files with 823 additions and 0 deletions.
diff --git a/basyx.submodelservice/basyx.submodelservice-feature-mqtt/pom.xml b/basyx.submodelservice/basyx.submodelservice-feature-mqtt/pom.xml
@@ -0,0 +1,50 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>org.eclipse.digitaltwin.basyx</groupId>
+		<artifactId>basyx.submodelservice</artifactId>
+		<version>${revision}</version>
+	</parent>
+	<artifactId>basyx.submodelservice-feature-mqtt</artifactId>
+	<name>BaSyx submodelservice-feature-mqtt</name>
+	<description>BaSyx submodelservice-feature-mqtt</description>
+
+	<dependencies>
+		<dependency>
+			<groupId>org.eclipse.digitaltwin.basyx</groupId>
+			<artifactId>basyx.submodelservice-core</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.eclipse.digitaltwin.basyx</groupId>
+			<artifactId>basyx.mqttcore</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.eclipse.digitaltwin.basyx</groupId>
+			<artifactId>basyx.submodelservice-core</artifactId>
+			<classifier>tests</classifier>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.eclipse.digitaltwin.basyx</groupId>
+			<artifactId>basyx.submodelservice-backend-inmemory</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>io.moquette</groupId>
+			<artifactId>moquette-broker</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.eclipse.paho</groupId>
+			<artifactId>org.eclipse.paho.client.mqttv3</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.eclipse.digitaltwin.basyx</groupId>
+			<artifactId>basyx.submodelservice-backend-inmemory</artifactId>
+		</dependency>
+	</dependencies>
+</project>
diff --git a/.../java/org/eclipse/digitaltwin/basyx/submodelservice/feature/mqtt/MqttSubmodelService.java b/.../java/org/eclipse/digitaltwin/basyx/submodelservice/feature/mqtt/MqttSubmodelService.java
@@ -0,0 +1,192 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ * SPDX-License-Identifier: MIT
+ ******************************************************************************/
+
+package org.eclipse.digitaltwin.basyx.submodelservice.feature.mqtt;
+
+import java.io.File;
+import java.io.InputStream;
+import java.util.List;
+
+import org.eclipse.digitaltwin.aas4j.v3.model.OperationVariable;
+import org.eclipse.digitaltwin.aas4j.v3.model.Submodel;
+import org.eclipse.digitaltwin.aas4j.v3.model.SubmodelElement;
+import org.eclipse.digitaltwin.basyx.common.mqttcore.serializer.SubmodelElementSerializer;
+import org.eclipse.digitaltwin.basyx.core.exceptions.ElementDoesNotExistException;
+import org.eclipse.digitaltwin.basyx.core.exceptions.ElementNotAFileException;
+import org.eclipse.digitaltwin.basyx.core.exceptions.FileDoesNotExistException;
+import org.eclipse.digitaltwin.basyx.core.pagination.CursorResult;
+import org.eclipse.digitaltwin.basyx.core.pagination.PaginationInfo;
+import org.eclipse.digitaltwin.basyx.submodelservice.SubmodelService;
+import org.eclipse.digitaltwin.basyx.submodelservice.value.SubmodelElementValue;
+import org.eclipse.paho.client.mqttv3.IMqttClient;
+import org.eclipse.paho.client.mqttv3.MqttException;
+import org.eclipse.paho.client.mqttv3.MqttMessage;
+import org.eclipse.paho.client.mqttv3.MqttPersistenceException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Service decorator for the MQTT eventing on the submodel level.
+ * 
+ * @author rana
+ */
+public class MqttSubmodelService implements SubmodelService {
+
+	private static Logger logger = LoggerFactory.getLogger(MqttSubmodelService.class);
+	private MqttSubmodelServiceTopicFactory topicFactory;
+	private SubmodelService decorated;
+	private IMqttClient mqttClient;
+
+	public MqttSubmodelService(SubmodelService decorated, IMqttClient mqttClient, MqttSubmodelServiceTopicFactory topicFactory) {
+		this.topicFactory = topicFactory;
+		this.decorated = decorated;
+		this.mqttClient = mqttClient;
+	}
+
+	@Override
+	public Submodel getSubmodel() {
+		return decorated.getSubmodel();
+	}
+
+	@Override
+	public CursorResult<List<SubmodelElement>> getSubmodelElements(PaginationInfo pInfo) {
+		return decorated.getSubmodelElements(pInfo);
+	}
+
+	@Override
+	public SubmodelElement getSubmodelElement(String idShortPath) throws ElementDoesNotExistException {
+		return decorated.getSubmodelElement(idShortPath);
+	}
+
+	@Override
+	public SubmodelElementValue getSubmodelElementValue(String idShortPath) throws ElementDoesNotExistException {
+		return decorated.getSubmodelElementValue(idShortPath);
+	}
+
+	@Override
+	public void setSubmodelElementValue(String idShortPath, SubmodelElementValue value) throws ElementDoesNotExistException {
+		decorated.setSubmodelElementValue(idShortPath, value);
+		SubmodelElement submodelElement = decorated.getSubmodelElement(idShortPath);
+		submodelElementUpdated(submodelElement, idShortPath);
+	}
+
+	@Override
+	public void createSubmodelElement(SubmodelElement submodelElement) {
+		decorated.createSubmodelElement(submodelElement);
+		SubmodelElement smElement = decorated.getSubmodelElement(submodelElement.getIdShort());
+		submodelElementCreated(submodelElement, smElement.getIdShort());
+	}
+
+	@Override
+	public void createSubmodelElement(String idShortPath, SubmodelElement submodelElement) throws ElementDoesNotExistException {
+
+		decorated.createSubmodelElement(idShortPath, submodelElement);
+
+		SubmodelElement smElement = decorated.getSubmodelElement(submodelElement.getIdShort());
+		submodelElementCreated(smElement, idShortPath);
+	}
+
+	@Override
+	public void updateSubmodelElement(String idShortPath, SubmodelElement submodelElement) throws ElementDoesNotExistException {
+
+		decorated.updateSubmodelElement(idShortPath, submodelElement);
+		SubmodelElement smElement = decorated.getSubmodelElement(submodelElement.getIdShort());
+		submodelElementUpdated(smElement, submodelElement.getIdShort());
+	}
+
+	@Override
+	public void deleteSubmodelElement(String idShortPath) throws ElementDoesNotExistException {
+
+		SubmodelElement smElement = decorated.getSubmodelElement(idShortPath);
+		decorated.deleteSubmodelElement(idShortPath);
+		submodelElementDeleted(smElement, idShortPath);
+	}
+
+	@Override
+	public void patchSubmodelElements(List<SubmodelElement> submodelElementList) {
+		decorated.patchSubmodelElements(submodelElementList);
+	}
+
+	@Override
+	public OperationVariable[] invokeOperation(String idShortPath, OperationVariable[] input) throws ElementDoesNotExistException {
+		return decorated.invokeOperation(idShortPath, input);
+	}
+
+	@Override
+	public File getFileByPath(String idShortPath) throws ElementDoesNotExistException, ElementNotAFileException, FileDoesNotExistException {
+		return decorated.getFileByPath(idShortPath);
+	}
+
+	@Override
+	public void setFileValue(String idShortPath, String fileName, InputStream inputStream) throws ElementDoesNotExistException, ElementNotAFileException {
+		decorated.setFileValue(idShortPath, fileName, inputStream);
+	}
+
+	@Override
+	public void deleteFileValue(String idShortPath) throws ElementDoesNotExistException, ElementNotAFileException, FileDoesNotExistException {
+		decorated.deleteFileValue(idShortPath);
+	}
+
+	private void submodelElementCreated(SubmodelElement submodelElement, String idShort) {
+		sendMqttMessage(topicFactory.createCreateSubmodelElementTopic(idShort), SubmodelElementSerializer.serializeSubmodelElement(submodelElement));
+	}
+
+	private void submodelElementUpdated(SubmodelElement submodelElement, String idShortPath) {
+		sendMqttMessage(topicFactory.createUpdateSubmodelElementTopic(idShortPath), SubmodelElementSerializer.serializeSubmodelElement(submodelElement));
+	}
+
+	private void submodelElementDeleted(SubmodelElement submodelElement, String idShort) {
+		sendMqttMessage(topicFactory.createDeleteSubmodelElementTopic(idShort), SubmodelElementSerializer.serializeSubmodelElement(submodelElement));
+	}
+
+	/**
+	 * Sends MQTT message to connected broker
+	 * 
+	 * @param topic
+	 *            in which the message will be published
+	 * @param payload
+	 *            the actual message
+	 */
+	private void sendMqttMessage(String topic, String payload) {
+		MqttMessage msg = createMqttMessage(payload);
+
+		try {
+			logger.debug("Send MQTT message to " + topic + ": " + payload);
+			mqttClient.publish(topic, msg);
+		} catch (MqttPersistenceException e) {
+			logger.error("Could not persist mqtt message", e);
+		} catch (MqttException e) {
+			logger.error("Could not send mqtt message", e);
+		}
+	}
+
+	private MqttMessage createMqttMessage(String payload) {
+		if (payload == null) {
+			return new MqttMessage();
+		} else {
+			return new MqttMessage(payload.getBytes());
+		}
+	}
+}
diff --git a/...ipse/digitaltwin/basyx/submodelservice/feature/mqtt/MqttSubmodelServiceConfiguration.java b/...ipse/digitaltwin/basyx/submodelservice/feature/mqtt/MqttSubmodelServiceConfiguration.java
@@ -0,0 +1,68 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ * SPDX-License-Identifier: MIT
+ ******************************************************************************/
+
+package org.eclipse.digitaltwin.basyx.submodelservice.feature.mqtt;
+
+import org.eclipse.paho.client.mqttv3.IMqttClient;
+import org.eclipse.paho.client.mqttv3.MqttClient;
+import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
+import org.eclipse.paho.client.mqttv3.MqttException;
+import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * MQTT configuration to allow for the automatic enable of the feature using the
+ * config file.
+ * 
+ * @author rana
+ */
+@ConditionalOnExpression("#{${" + MqttSubmodelServiceFeature.FEATURENAME + ".enabled:false} or ${basyx.feature.mqtt.enabled:false}}")
+@Configuration
+public class MqttSubmodelServiceConfiguration {
+
+	@ConditionalOnMissingBean
+	@Bean
+	public IMqttClient mqttClient(@Value("${mqtt.clientId}") String clientId, @Value("${mqtt.hostname}") String hostname, @Value("${mqtt.port}") int port) throws MqttException {
+		IMqttClient mqttClient = new MqttClient("tcp://" + hostname + ":" + port, clientId, new MemoryPersistence());
+
+		mqttClient.connect(mqttConnectOptions());
+
+		return mqttClient;
+	}
+
+	@ConditionalOnMissingBean
+	@Bean
+	@ConfigurationProperties(prefix = "mqtt")
+	public MqttConnectOptions mqttConnectOptions() {
+		MqttConnectOptions mqttConceptOptions = new MqttConnectOptions();
+		mqttConceptOptions.setAutomaticReconnect(true);
+		return mqttConceptOptions;
+	}
+}
diff --git a/...rg/eclipse/digitaltwin/basyx/submodelservice/feature/mqtt/MqttSubmodelServiceFactory.java b/...rg/eclipse/digitaltwin/basyx/submodelservice/feature/mqtt/MqttSubmodelServiceFactory.java
@@ -0,0 +1,54 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ * SPDX-License-Identifier: MIT
+ ******************************************************************************/
+
+package org.eclipse.digitaltwin.basyx.submodelservice.feature.mqtt;
+
+import org.eclipse.digitaltwin.aas4j.v3.model.Submodel;
+import org.eclipse.digitaltwin.basyx.submodelservice.SubmodelService;
+import org.eclipse.digitaltwin.basyx.submodelservice.SubmodelServiceFactory;
+import org.eclipse.paho.client.mqttv3.IMqttClient;
+
+/**
+ * Service factory for the MQTT eventing on the submodel level.
+ * 
+ * @author rana
+ */
+public class MqttSubmodelServiceFactory implements SubmodelServiceFactory {
+
+	private SubmodelServiceFactory decorated;
+	private IMqttClient client;
+	private MqttSubmodelServiceTopicFactory topicFactory;
+
+	public MqttSubmodelServiceFactory(SubmodelServiceFactory decorated, IMqttClient client, MqttSubmodelServiceTopicFactory topicFactory) {
+		this.decorated = decorated;
+		this.client = client;
+		this.topicFactory = topicFactory;
+	}
+
+	@Override
+	public SubmodelService create(Submodel submodel) {
+		return new MqttSubmodelService(decorated.create(submodel), client, topicFactory);
+	}
+}