Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

Added ability to force close MQTT connections and added provisioning config change handling logic to UserAssetProvisioningMQTTHandler

Rich Turnerec1887d493ba
diff --git a/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java b/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java
index 57fce11d9..de1f54206 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java
@@ -88,7 +88,7 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<S
.useMqttVersion3()
.identifier(clientId)
.addConnectedListener(context -> {
- LOG.info("Client is connected from the broker '" + getClientUri() + "'");
+ LOG.info("Client is connected to the broker '" + getClientUri() + "'");
onConnectionStatusChanged(ConnectionStatus.CONNECTED);
})
.addDisconnectedListener(context -> {
@@ -349,6 +349,7 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<S
if (throwable != null) {
LOG.log(Level.INFO, "Connection failed:" + getClientUri(), throwable);
} else {
+
if (!this.cleanSession && !connAck.isSessionPresent()) {
// Need to re-instate the subscriptions as HiveMQ client doesn't do it
executorService.execute(() -> {
diff --git a/manager/src/main/java/org/openremote/manager/event/ClientEventService.java b/manager/src/main/java/org/openremote/manager/event/ClientEventService.java
index a2d55f1d7..c5369e4fd 100644
--- a/manager/src/main/java/org/openremote/manager/event/ClientEventService.java
+++ b/manager/src/main/java/org/openremote/manager/event/ClientEventService.java
@@ -419,7 +419,6 @@ public class ClientEventService implements ContainerService {
'}';
}
- // TODO: Implement MQTT close once supported by Moquette (https://github.com/moquette-io/moquette/issues/469)
protected static SessionInfo createSessionInfo(String sessionKey, Exchange exchange) {
String connectionType = (String) exchange.getIn().getHeader(HEADER_CONNECTION_TYPE);
@@ -434,6 +433,8 @@ public class ClientEventService implements ContainerService {
LOG.log(Level.INFO, "Failed to close client session: " + sessionKey);
}
};
+ } else if (HEADER_CONNECTION_TYPE_MQTT.equals(connectionType)) {
+ closeRunnable = exchange.getIn().getHeader(SESSION, Runnable.class);
}
return new SessionInfo(connectionType, closeRunnable);
diff --git a/manager/src/main/java/org/openremote/manager/mqtt/DefaultMQTTHandler.java b/manager/src/main/java/org/openremote/manager/mqtt/DefaultMQTTHandler.java
index 04cfa00e7..640fd4ba9 100644
--- a/manager/src/main/java/org/openremote/manager/mqtt/DefaultMQTTHandler.java
+++ b/manager/src/main/java/org/openremote/manager/mqtt/DefaultMQTTHandler.java
@@ -121,6 +121,9 @@ public class DefaultMQTTHandler extends MQTTHandler {
Map<String, Object> headers = prepareHeaders(connection);
headers.put(ConnectionConstants.SESSION_OPEN, true);
+ // Put a close connection runnable into the headers for the client event service
+ Runnable closeRunnable = () -> mqttBrokerService.forceDisconnect(connection.getClientId());
+ headers.put(ConnectionConstants.SESSION, closeRunnable);
messageBrokerService.getProducerTemplate().sendBodyAndHeaders(ClientEventService.CLIENT_EVENT_QUEUE, null, headers);
LOG.fine("Connected: " + connection);
}
diff --git a/manager/src/main/java/org/openremote/manager/mqtt/MqttBrokerService.java b/manager/src/main/java/org/openremote/manager/mqtt/MqttBrokerService.java
index 8b190735d..b904e102a 100644
--- a/manager/src/main/java/org/openremote/manager/mqtt/MqttBrokerService.java
+++ b/manager/src/main/java/org/openremote/manager/mqtt/MqttBrokerService.java
@@ -44,6 +44,7 @@ import org.openremote.model.util.TextUtil;
import org.openremote.model.util.ValueUtil;
import java.lang.reflect.Field;
+import java.lang.reflect.Method;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.*;
@@ -79,6 +80,7 @@ public class MqttBrokerService implements ContainerService, IAuthenticator {
protected String host;
protected int port;
protected Server mqttBroker;
+ protected SessionRegistry sessionRegistry;
@Override
public int getPriority() {
@@ -199,36 +201,86 @@ public class MqttBrokerService implements ContainerService, IAuthenticator {
}
}
- public MqttConnection removeConnection(String clientId) {
+ /**
+ * We have this as there's no way to configure expiry time of sessions in Moquette so to make things simple we
+ * clear the session whenever the client disconnects; the client can then re-subscribe as needed
+ */
+ public MqttConnection clearConnectionSession(String clientId) {
+ if (mqttBroker == null) {
+ return null;
+ }
+
synchronized (clientIdConnectionMap) {
MqttConnection connection = clientIdConnectionMap.remove(clientId);
if (connection != null && !connection.isCleanSession()) {
- forceClearSession(clientId);
+ try {
+ SessionRegistry sessionRegistry = getSessionRegistry();
+ Object session = getSession(clientId);
+ if (sessionRegistry == null || session == null) {
+ throw new IllegalStateException("Couldn't get session registry and/or session for client: " + clientId);
+ }
+ Method removeMethod = sessionRegistry.getClass().getDeclaredMethod("remove", session.getClass());
+ removeMethod.setAccessible(true);
+ removeMethod.invoke(sessionRegistry, session);
+ } catch (Exception e) {
+ LOG.log(Level.WARNING, "Failed to remove Moquette session using reflection", e);
+ }
}
return connection;
}
}
- /**
- * We have this as there's no way to configure expiry time of sessions in Moquette so to make things simple we
- * clear the session whenever the client disconnects; the client can then re-subscribe as needed
- */
- public void forceClearSession(String clientId) {
+ protected SessionRegistry getSessionRegistry() {
+ if (mqttBroker == null) {
+ return null;
+ }
+ if (sessionRegistry == null) {
+ try {
+ Field sessionsField = mqttBroker.getClass().getDeclaredField("sessions");
+ sessionsField.setAccessible(true);
+ sessionRegistry = (SessionRegistry) sessionsField.get(mqttBroker);
+ } catch (Exception e) {
+ LOG.log(Level.WARNING, "Failed to get Moquette session registry using reflection", e);
+ }
+ }
+
+ return sessionRegistry;
+ }
+
+ protected Object getSession(String clientId) {
if (mqttBroker == null) {
+ return null;
+ }
+
+ try {
+ SessionRegistry sessionRegistry = getSessionRegistry();
+ Method retrieveSessionMethod = SessionRegistry.class.getDeclaredMethod("retrieve", String.class);
+ retrieveSessionMethod.setAccessible(true);
+ return retrieveSessionMethod.invoke(sessionRegistry, clientId);
+ } catch (Exception e) {
+ LOG.log(Level.WARNING, "Failed to get Moquette session using reflection", e);
+ }
+
+ return null;
+ }
+
+ public void forceDisconnect(String clientId) {
+ MqttConnection connection = getConnection(clientId);
+ Object session = getSession(clientId);
+
+ if (connection == null || session == null) {
return;
}
try {
- Field sessionsField = Server.class.getDeclaredField("sessions");
- Field poolField = SessionRegistry.class.getDeclaredField("pool");
- sessionsField.setAccessible(true);
- poolField.setAccessible(true);
- SessionRegistry sessions = (SessionRegistry) sessionsField.get(mqttBroker);
- ConcurrentMap<?,?> pool = (ConcurrentMap<?, ?>) poolField.get(sessions);
- Object session = pool.get(clientId);
- pool.remove(clientId, session);
+ Method closeMethod = session.getClass().getDeclaredMethod("closeImmediately");
+ closeMethod.setAccessible(true);
+ Method disconnectMethod = session.getClass().getDeclaredMethod("disconnect");
+ disconnectMethod.setAccessible(true);
+ closeMethod.invoke(session);
+ disconnectMethod.invoke(session);
} catch (Exception e) {
- LOG.log(Level.WARNING, "Failed to clear session using reflection", e);
+ LOG.log(Level.WARNING, "Failed to force disconnect Moquette session using reflection", e);
}
}
diff --git a/manager/src/main/java/org/openremote/manager/mqtt/ORInterceptHandler.java b/manager/src/main/java/org/openremote/manager/mqtt/ORInterceptHandler.java
index 3a2dc9ac1..4da32052b 100644
--- a/manager/src/main/java/org/openremote/manager/mqtt/ORInterceptHandler.java
+++ b/manager/src/main/java/org/openremote/manager/mqtt/ORInterceptHandler.java
@@ -84,7 +84,7 @@ public class ORInterceptHandler extends AbstractInterceptHandler {
@Override
public void onDisconnect(InterceptDisconnectMessage msg) {
- MqttConnection connection = brokerService.removeConnection(msg.getClientID());
+ MqttConnection connection = brokerService.clearConnectionSession(msg.getClientID());
if (connection != null) {
// No topic info here so just notify all custom handlers
@@ -94,7 +94,7 @@ public class ORInterceptHandler extends AbstractInterceptHandler {
@Override
public void onConnectionLost(InterceptConnectionLostMessage msg) {
- MqttConnection connection = brokerService.removeConnection(msg.getClientID());
+ MqttConnection connection = brokerService.clearConnectionSession(msg.getClientID());
if (connection != null) {
// No topic info here so just notify all custom handlers
diff --git a/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java b/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java
index 7e43b9237..e3ae54b54 100644
--- a/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java
+++ b/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java
@@ -20,10 +20,14 @@
package org.openremote.manager.provisioning;
import io.moquette.broker.subscriptions.Topic;
+import io.moquette.interception.messages.InterceptConnectionLostMessage;
import io.moquette.interception.messages.InterceptPublishMessage;
import io.moquette.interception.messages.InterceptSubscribeMessage;
import io.moquette.interception.messages.InterceptUnsubscribeMessage;
import io.netty.handler.codec.mqtt.MqttQoS;
+import org.apache.camel.builder.RouteBuilder;
+import org.openremote.container.message.MessageBrokerService;
+import org.openremote.container.persistence.PersistenceEvent;
import org.openremote.container.timer.TimerService;
import org.openremote.container.util.UniqueIdentifierGenerator;
import org.openremote.manager.asset.AssetStorageService;
@@ -47,11 +51,12 @@ import java.security.cert.CertificateException;
import java.security.cert.CertificateExpiredException;
import java.security.cert.CertificateNotYetValidException;
import java.security.cert.X509Certificate;
-import java.util.Arrays;
-import java.util.Date;
+import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
+import static org.openremote.container.persistence.PersistenceEvent.PERSISTENCE_TOPIC;
+import static org.openremote.container.persistence.PersistenceEvent.isPersistenceEventForEntityType;
import static org.openremote.model.Constants.RESTRICTED_USER_REALM_ROLE;
import static org.openremote.model.syslog.SyslogCategory.API;
@@ -61,6 +66,40 @@ import static org.openremote.model.syslog.SyslogCategory.API;
*/
public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
+ protected static class ProvisioningPersistenceRouteBuilder extends RouteBuilder {
+
+ UserAssetProvisioningMQTTHandler mqttHandler;
+
+ public ProvisioningPersistenceRouteBuilder(UserAssetProvisioningMQTTHandler mqttHandler) {
+ this.mqttHandler = mqttHandler;
+ }
+
+ @SuppressWarnings("unchecked")
+ @Override
+ public void configure() throws Exception {
+ from(PERSISTENCE_TOPIC)
+ .routeId("ProvisioningConfigPersistenceChanges")
+ .filter(isPersistenceEventForEntityType(ProvisioningConfig.class))
+ .process(exchange -> {
+ PersistenceEvent<ProvisioningConfig<?,?>> persistenceEvent = (PersistenceEvent<ProvisioningConfig<?,?>>)exchange.getIn().getBody(PersistenceEvent.class);
+
+ boolean forceDisconnect = persistenceEvent.getCause() == PersistenceEvent.Cause.DELETE;
+
+ if (persistenceEvent.getCause() == PersistenceEvent.Cause.UPDATE) {
+ // Force disconnect if the certain properties have changed
+ forceDisconnect = Arrays.stream(persistenceEvent.getPropertyNames()).anyMatch((propertyName) ->
+ propertyName.equals(ProvisioningConfig.DISABLED_PROPERTY_NAME)
+ || propertyName.equals(ProvisioningConfig.DATA_PROPERTY_NAME));
+ }
+
+ if (forceDisconnect) {
+ LOG.info("Provisioning config modified or deleted so forcing connected clients to disconnect: " + persistenceEvent.getEntity());
+ mqttHandler.forceClientDisconnects(persistenceEvent.getEntity().getId());
+ }
+ });
+ }
+ }
+
protected static final Logger LOG = SyslogCategory.getLogger(API, UserAssetProvisioningMQTTHandler.class);
public static final String PROVISIONING_TOKEN = "provisioning";
public static final String REQUEST_TOKEN = "request";
@@ -72,6 +111,7 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
protected AssetStorageService assetStorageService;
protected ManagerKeycloakIdentityProvider identityProvider;
protected boolean isKeycloak;
+ protected final Map<Long, Set<MqttConnection>> provisioningConfigAuthenticatedConnectionMap = new HashMap<>();
@Override
public void start(Container container) throws Exception {
@@ -88,6 +128,7 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
} else {
isKeycloak = true;
identityProvider = (ManagerKeycloakIdentityProvider) identityService.getIdentityProvider();
+ container.getService(MessageBrokerService.class).getContext().addRoutes(new ProvisioningPersistenceRouteBuilder(this));
}
}
@@ -175,6 +216,13 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
}
}
+ @Override
+ public void onConnectionLost(MqttConnection connection, InterceptConnectionLostMessage msg) {
+ synchronized (provisioningConfigAuthenticatedConnectionMap) {
+ provisioningConfigAuthenticatedConnectionMap.values().forEach(connections -> connections.remove(connection));
+ }
+ }
+
protected static boolean isProvisioningTopic(Topic topic) {
return PROVISIONING_TOKEN.equals(topicTokenIndexToString(topic, 0));
}
@@ -291,11 +339,20 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
return;
}
- LOG.fine("Client successfully initialised: topic=" + topic + ", connection=" + connection);
+ LOG.fine("Client successfully initialised: topic=" + topic + ", connection=" + connection + ", config=" + matchingConfig);
- // Update connection with service user credentials
- connection.setCredentials(realm, serviceUser.getUsername(), serviceUser.getSecret());
- brokerService.publishMessage(getResponseTopic(topic), new SuccessResponseMessage(realm, asset), MqttQoS.AT_MOST_ONCE);
+ synchronized (provisioningConfigAuthenticatedConnectionMap) {
+ provisioningConfigAuthenticatedConnectionMap.compute(matchingConfig.getId(), (id, connections) -> {
+ if (connections == null) {
+ connections = new HashSet<>();
+ connections.add(connection);
+ }
+ return connections;
+ });
+ // Update connection with service user credentials
+ connection.setCredentials(realm, serviceUser.getUsername(), serviceUser.getSecret());
+ brokerService.publishMessage(getResponseTopic(topic), new SuccessResponseMessage(realm, asset), MqttQoS.AT_MOST_ONCE);
+ }
}
protected X509ProvisioningConfig getMatchingX509ProvisioningConfig(MqttConnection connection, X509Certificate clientCertificate) {
@@ -399,4 +456,14 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
return asset;
}
+
+ protected void forceClientDisconnects(long provisioningConfigId) {
+ synchronized (provisioningConfigAuthenticatedConnectionMap) {
+ provisioningConfigAuthenticatedConnectionMap.computeIfPresent(provisioningConfigId, (id, connections) -> {
+ // Force disconnect of each connection and the disconnect handler will remove the connection from the map
+ connections.forEach(connection -> brokerService.forceDisconnect(connection.getClientId()));
+ return connections;
+ });
+ }
+ }
}
diff --git a/model/src/main/java/org/openremote/model/provisioning/ProvisioningConfig.java b/model/src/main/java/org/openremote/model/provisioning/ProvisioningConfig.java
index 8718638bb..49fccf906 100644
--- a/model/src/main/java/org/openremote/model/provisioning/ProvisioningConfig.java
+++ b/model/src/main/java/org/openremote/model/provisioning/ProvisioningConfig.java
@@ -45,6 +45,9 @@ import static org.openremote.model.Constants.PERSISTENCE_SEQUENCE_ID_GENERATOR;
)
public abstract class ProvisioningConfig<T, U extends ProvisioningConfig<T, U>> {
+ public static final String DISABLED_PROPERTY_NAME = "disabled";
+ public static final String DATA_PROPERTY_NAME = "data";
+
@Id
@Column(name = "ID")
@Min(1)
@@ -69,7 +72,7 @@ public abstract class ProvisioningConfig<T, U extends ProvisioningConfig<T, U>>
@Size(min = 3, max = 100, message = "{ProvisioningConfig.type.Size}")
protected String type;
- @Column(name = "REALM")
+ @Column(name = "REALM", nullable = false, updatable = false)
protected String realm;
@Column(name = "ASSET_TEMPLATE", columnDefinition = "text")
@@ -83,7 +86,7 @@ public abstract class ProvisioningConfig<T, U extends ProvisioningConfig<T, U>>
@Enumerated(EnumType.STRING)
protected ClientRole[] userRoles;
- @Column(name = "DISABLED", nullable = false)
+ @Column(name = DISABLED_PROPERTY_NAME, nullable = false)
protected boolean disabled = false;
protected ProvisioningConfig() {}
diff --git a/model/src/main/java/org/openremote/model/provisioning/X509ProvisioningConfig.java b/model/src/main/java/org/openremote/model/provisioning/X509ProvisioningConfig.java
index 3068410eb..9cefe2f79 100644
--- a/model/src/main/java/org/openremote/model/provisioning/X509ProvisioningConfig.java
+++ b/model/src/main/java/org/openremote/model/provisioning/X509ProvisioningConfig.java
@@ -39,7 +39,7 @@ public class X509ProvisioningConfig extends ProvisioningConfig<X509ProvisioningD
@Transient boolean valid = true;
- @Column(name = "DATA", columnDefinition = "jsonb")
+ @Column(name = DATA_PROPERTY_NAME, columnDefinition = "jsonb")
@org.hibernate.annotations.Type(type = PERSISTENCE_JSON_VALUE_TYPE)
protected X509ProvisioningData data;
diff --git a/test/src/test/groovy/org/openremote/test/provisioning/UserAndAssetProvisioningTest.groovy b/test/src/test/groovy/org/openremote/test/provisioning/UserAndAssetProvisioningTest.groovy
index 9b7d7365e..3fc9a8add 100644
--- a/test/src/test/groovy/org/openremote/test/provisioning/UserAndAssetProvisioningTest.groovy
+++ b/test/src/test/groovy/org/openremote/test/provisioning/UserAndAssetProvisioningTest.groovy
@@ -61,7 +61,7 @@ import static org.openremote.model.value.ValueType.NUMBER
class UserAndAssetProvisioningTest extends Specification implements ManagerContainerTrait {
@SuppressWarnings("GroovyAccessibility")
- def "Check user and asset provisioning functionality"() {
+ def "Check basic functionality"() {
given: "expected conditions"
def conditions = new PollingConditions(timeout: 10, delay: 0.2)
@@ -236,10 +236,7 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
then: "the internal consumer should have been notified"
conditions.eventually {
- assert internalAttributeEvents.size() == 2
- assert internalAttributeEvents.get(1).assetId == managerTestSetup.apartment2LivingroomId
- assert internalAttributeEvents.get(1).attributeName == "lightSwitch"
- assert internalAttributeEvents.get(1).value.orElse(false)
+ assert internalAttributeEvents.find{it.assetId == managerTestSetup.apartment2LivingroomId && it.attributeName == "lightSwitch" && it.value.orElse(false)} != null
}
and: "the client should not have been notified"
@@ -459,10 +456,19 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
}
when: "the provisioning config is updated to disabled"
+ def existingConnection = mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId)
+ subscribeFailures.clear()
provisioningConfig.setDisabled(true)
provisioningConfig = provisioningService.merge(provisioningConfig)
- and: "a device re-connects"
+ then: "already connected client that was authenticated should be disconnected, then reconnect and should fail to re-subscribe to asset and attribute events"
+ conditions.eventually {
+ assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != null
+ assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != existingConnection
+ assert !clientEventService.eventSubscriptions.sessionSubscriptionIdMap.containsKey(mqttDevice1ClientId)
+ }
+
+ when: "a device re-connects"
deviceNResponses.clear()
deviceNClient.connect()