Skip to content

armgit / core

Public Imported from GitHub
0

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

Added persistence event support for users and MqttBrokerService now auto disconnects users when they are disabled

Rich Turner8ca1e7527acc
diff --git a/container/src/main/java/org/openremote/container/persistence/PersistenceService.java b/container/src/main/java/org/openremote/container/persistence/PersistenceService.java
index 0cfc89da5..b3c2a29c9 100644
--- a/container/src/main/java/org/openremote/container/persistence/PersistenceService.java
+++ b/container/src/main/java/org/openremote/container/persistence/PersistenceService.java
@@ -19,6 +19,7 @@
*/
package org.openremote.container.persistence;
+import org.apache.camel.ExchangePattern;
import org.flywaydb.core.Flyway;
import org.flywaydb.core.api.MigrationInfo;
import org.hibernate.Session;
@@ -53,12 +54,14 @@ import javax.persistence.spi.ClassTransformer;
import javax.persistence.spi.PersistenceUnitTransactionType;
import javax.sql.DataSource;
import javax.ws.rs.core.UriBuilder;
+import java.lang.reflect.Field;
import java.net.URL;
import java.util.*;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.logging.Level;
import java.util.logging.Logger;
+import java.util.stream.IntStream;
import static org.openremote.container.util.MapAccess.*;
@@ -393,6 +396,53 @@ public class PersistenceService implements ContainerService {
return schemas;
}
+ /**
+ * Generate {@link PersistenceEvent}s for entities not managed by JPA (i.e. Keycloak entities)
+ */
+ public void publishPersistenceEvent(PersistenceEvent.Cause cause, Object currentEntity, Object previousEntity, Field[] propertyFields) {
+ switch (cause) {
+ case CREATE:
+ publishPersistenceEvent(cause, currentEntity, null, null, null);
+ break;
+ case DELETE:
+ publishPersistenceEvent(cause, previousEntity, null, null, null);
+ break;
+ case UPDATE:
+ List<String> propertyNames = new ArrayList<>(propertyFields.length);
+ List<Object> currentState = new ArrayList<>(propertyFields.length);
+ List<Object> previousState = new ArrayList<>(propertyFields.length);
+ IntStream.range(0, propertyFields.length).forEach(i -> {
+ Object currentValue = ValueUtil.getObjectFieldValue(currentEntity, propertyFields[i]);
+ Object previousValue = ValueUtil.getObjectFieldValue(previousEntity, propertyFields[i]);
+ if (!ValueUtil.objectsEquals(currentValue, previousValue)) {
+ propertyNames.add(propertyFields[i].getName());
+ currentState.add(currentValue);
+ previousState.add(previousValue);
+ }
+ });
+ publishPersistenceEvent(cause, currentEntity, propertyNames.toArray(new String[0]), currentState.toArray(), previousState.toArray());
+ break;
+ }
+ }
+
+ /**
+ * Generate {@link PersistenceEvent}s for entities not managed by JPA (i.e. Keycloak entities)
+ */
+ public void publishPersistenceEvent(PersistenceEvent.Cause cause, Object entity, String[] propertyNames, Object[] currentState, Object[] previousState) {
+ // Fire persistence event although we don't use database for Tenant CUD but call Keycloak API
+ PersistenceEvent<?> persistenceEvent = new PersistenceEvent<>(cause, entity, propertyNames, currentState, previousState);
+
+ if (messageBrokerService.getProducerTemplate() != null) {
+ messageBrokerService.getProducerTemplate().sendBodyAndHeader(
+ PersistenceEvent.PERSISTENCE_TOPIC,
+ ExchangePattern.InOnly,
+ persistenceEvent,
+ PersistenceEvent.HEADER_ENTITY_TYPE,
+ persistenceEvent.getEntity().getClass()
+ );
+ }
+ }
+
protected void openDatabase(Container container, Database database, String username, String password, String connectionUrl) {
int databaseMinPoolSize = getInteger(container.getConfig(), DB_MIN_POOL_SIZE, DB_MIN_POOL_SIZE_DEFAULT);
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 b904e102a..0bc4ec405 100644
--- a/manager/src/main/java/org/openremote/manager/mqtt/MqttBrokerService.java
+++ b/manager/src/main/java/org/openremote/manager/mqtt/MqttBrokerService.java
@@ -30,9 +30,12 @@ import io.netty.buffer.Unpooled;
import io.netty.handler.codec.mqtt.MqttMessageBuilders;
import io.netty.handler.codec.mqtt.MqttPublishMessage;
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.manager.asset.AssetStorageService;
import org.openremote.manager.event.ClientEventService;
+import org.openremote.manager.provisioning.UserAssetProvisioningMQTTHandler;
import org.openremote.manager.security.ManagerIdentityService;
import org.openremote.manager.security.ManagerKeycloakIdentityProvider;
import org.openremote.model.Container;
@@ -48,18 +51,19 @@ import java.lang.reflect.Method;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.*;
-import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.ScheduledExecutorService;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import static java.util.stream.StreamSupport.stream;
+import static org.openremote.container.persistence.PersistenceEvent.PERSISTENCE_TOPIC;
+import static org.openremote.container.persistence.PersistenceEvent.isPersistenceEventForEntityType;
import static org.openremote.container.util.MapAccess.getInteger;
import static org.openremote.container.util.MapAccess.getString;
import static org.openremote.model.syslog.SyslogCategory.API;
-public class MqttBrokerService implements ContainerService, IAuthenticator {
+public class MqttBrokerService extends RouteBuilder implements ContainerService, IAuthenticator {
public static final int PRIORITY = MED_PRIORITY;
public static final String INTERNAL_CLIENT_ID = "ManagerInternal";
@@ -103,6 +107,7 @@ public class MqttBrokerService implements ContainerService, IAuthenticator {
} else {
active = true;
identityProvider = (ManagerKeycloakIdentityProvider) identityService.getIdentityProvider();
+ container.getService(MessageBrokerService.class).getContext().addRoutes(this);
}
}
@@ -135,6 +140,43 @@ public class MqttBrokerService implements ContainerService, IAuthenticator {
LOG.fine("Started MQTT broker");
}
+
+ @SuppressWarnings("unchecked")
+ @Override
+ public void configure() throws Exception {
+ from(PERSISTENCE_TOPIC)
+ .routeId("UserPersistenceChanges")
+ .filter(isPersistenceEventForEntityType(User.class))
+ .process(exchange -> {
+ PersistenceEvent<User> persistenceEvent = (PersistenceEvent<User>)exchange.getIn().getBody(PersistenceEvent.class);
+ User user = persistenceEvent.getEntity();
+
+ if (!user.isServiceAccount()) {
+ return;
+ }
+
+ boolean forceDisconnect = persistenceEvent.getCause() == PersistenceEvent.Cause.DELETE;
+
+ if (persistenceEvent.getCause() == PersistenceEvent.Cause.UPDATE) {
+ // Force disconnect if certain properties have changed
+ forceDisconnect = Arrays.stream(persistenceEvent.getPropertyNames()).anyMatch((propertyName) ->
+ (propertyName.equals("enabled") && !user.getEnabled())
+ || propertyName.equals("username"));
+ }
+
+ if (forceDisconnect) {
+ // Find existing connection for this user
+ Arrays.stream(getConnections())
+ .filter(connection -> user.getUsername().equals(connection.getUsername()))
+ .findFirst()
+ .ifPresent(connection -> {
+ LOG.info("User modified or deleted so forcing connected client to disconnect: connection=" + connection);
+ forceDisconnect(connection.getClientId());
+ });
+ }
+ });
+ }
+
@Override
public void stop(Container container) throws Exception {
mqttBroker.stopServer();
@@ -201,6 +243,12 @@ public class MqttBrokerService implements ContainerService, IAuthenticator {
}
}
+ public MqttConnection[] getConnections() {
+ synchronized (clientIdConnectionMap) {
+ return clientIdConnectionMap.values().toArray(new MqttConnection[0]);
+ }
+ }
+
/**
* 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
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 e3ae54b54..51f87f511 100644
--- a/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java
+++ b/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java
@@ -77,6 +77,7 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
@SuppressWarnings("unchecked")
@Override
public void configure() throws Exception {
+
from(PERSISTENCE_TOPIC)
.routeId("ProvisioningConfigPersistenceChanges")
.filter(isPersistenceEventForEntityType(ProvisioningConfig.class))
@@ -105,6 +106,7 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
public static final String REQUEST_TOKEN = "request";
public static final String RESPONSE_TOKEN = "response";
public static final String UNIQUE_ID_PLACEHOLDER = "%UNIQUE_ID%";
+ public static final String PROVISIONING_USER_PREFIX = "ps-";
protected ProvisioningService provisioningService;
protected TimerService timerService;
protected MqttBrokerService brokerService;
@@ -291,7 +293,7 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
String realm = matchingConfig.getRealm();
// Get/create service user
- String serviceUsername = ("ps-" + uniqueId).toLowerCase(); // Keycloak clients are case sensitive but pretends not to be so always force lowercase
+ String serviceUsername = (PROVISIONING_USER_PREFIX + uniqueId).toLowerCase(); // Keycloak clients are case sensitive but pretends not to be so always force lowercase
User serviceUser;
try {
diff --git a/manager/src/main/java/org/openremote/manager/rules/RulesService.java b/manager/src/main/java/org/openremote/manager/rules/RulesService.java
index cc2f70efb..cddc6a683 100644
--- a/manager/src/main/java/org/openremote/manager/rules/RulesService.java
+++ b/manager/src/main/java/org/openremote/manager/rules/RulesService.java
@@ -19,7 +19,6 @@
*/
package org.openremote.manager.rules;
-import org.apache.camel.Predicate;
import org.apache.camel.builder.RouteBuilder;
import org.openremote.container.message.MessageBrokerService;
import org.openremote.container.persistence.PersistenceEvent;
@@ -30,10 +29,10 @@ import org.openremote.manager.asset.AssetProcessingService;
import org.openremote.manager.asset.AssetStorageService;
import org.openremote.manager.asset.AssetUpdateProcessor;
import org.openremote.manager.datapoint.AssetDatapointService;
+import org.openremote.manager.datapoint.AssetPredictedDatapointService;
import org.openremote.manager.event.ClientEventService;
import org.openremote.manager.gateway.GatewayService;
import org.openremote.manager.notification.NotificationService;
-import org.openremote.manager.datapoint.AssetPredictedDatapointService;
import org.openremote.manager.rules.flow.FlowResourceImpl;
import org.openremote.manager.rules.geofence.GeofenceAssetAdapter;
import org.openremote.manager.security.ManagerIdentityService;
@@ -196,10 +195,6 @@ public class RulesService extends RouteBuilder implements ContainerService, Asse
initDone = true;
}
- protected Predicate isNotForGW() {
- return exchange -> isNotForGateway(gatewayService).matches(exchange);
- }
-
@SuppressWarnings("unchecked")
@Override
public void configure() throws Exception {
@@ -207,7 +202,7 @@ public class RulesService extends RouteBuilder implements ContainerService, Asse
from(PERSISTENCE_TOPIC)
.routeId("RulesetPersistenceChanges")
.filter(isPersistenceEventForEntityType(Ruleset.class))
- .filter(this.isNotForGW())
+ .filter(isNotForGateway(gatewayService))
.process(exchange -> {
PersistenceEvent<?> persistenceEvent = exchange.getIn().getBody(PersistenceEvent.class);
processRulesetChange((Ruleset) persistenceEvent.getEntity(), persistenceEvent.getCause());
diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java
index bf6dbfd63..9d5da9644 100644
--- a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java
+++ b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java
@@ -176,7 +176,12 @@ public class ManagerBasicIdentityProvider extends BasicIdentityProvider implemen
.toArray(Role[]::new);
}
public void updateUserAttributes(String realm, String userId, Map<String, List<String>> attributes) {
- throw new UnsupportedOperationException("This provider does not support updating attributes");
+ throw new UnsupportedOperationException("This provider does not support attributes");
+ }
+
+ @Override
+ public Map<String, List<String>> getUserAttributes(String realm, String userId) {
+ throw new UnsupportedOperationException("This provider does not support attributes");
}
@Override
diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java
index 58d799a9a..afc0cd583 100644
--- a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java
+++ b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java
@@ -67,6 +67,8 @@ public interface ManagerIdentityProvider extends IdentityProvider {
void updateUserAttributes(String realm, String userId, Map<String, List<String>> attributes);
+ Map<String, List<String>> getUserAttributes(String realm, String userId);
+
Role[] getRoles(String realm, String client);
void updateClientRoles(String realm, String client, Role[] roles);
diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java
index 1d7175e88..d2dd67994 100644
--- a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java
+++ b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java
@@ -20,7 +20,6 @@
package org.openremote.manager.security;
import io.undertow.util.Headers;
-import org.apache.camel.ExchangePattern;
import org.apache.commons.io.IOUtils;
import org.keycloak.admin.client.resource.UserResource;
import org.keycloak.admin.client.resource.*;
@@ -361,6 +360,10 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
}
if (user.getAttributes() != null) {
+ if (existingUser != null) {
+ // Populate attributes for persistence event
+ existingUser.setAttributes(getUserAttributes(realm, existingUser.getId()));
+ }
updateUserAttributes(realm, userRepresentation.getId(), user.getAttributes());
}
@@ -370,7 +373,18 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
if (updatedUser.isServiceAccount()) {
updatedUser.setSecret(passwordSecret);
}
+
+ if (existingUser != null) {
+ // Push realm ID into updated user
+ updatedUser.setRealmId(existingUser.getRealmId());
+ }
}
+
+ persistenceService.publishPersistenceEvent(
+ (isUpdate ? PersistenceEvent.Cause.UPDATE : PersistenceEvent.Cause.CREATE),
+ updatedUser,
+ existingUser,
+ User.getPropertyFields());
return updatedUser;
});
}
@@ -398,6 +412,8 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
}
return null;
});
+
+ persistenceService.publishPersistenceEvent(PersistenceEvent.Cause.DELETE, null, user, User.getPropertyFields());
}
@Override
@@ -452,6 +468,14 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
});
}
+ @Override
+ public Map<String, List<String>> getUserAttributes(String realm, String userId) {
+ return getRealms(realmsResource -> {
+ UserRepresentation userRepresentation = realmsResource.realm(realm).users().get(userId).toRepresentation();
+ return userRepresentation.getAttributes();
+ });
+ }
+
@Override
public Role[] getRoles(String realm, String client) {
return getRealms(realmsResource -> {
@@ -810,6 +834,7 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
}
String realm = existing.getRealm();
+ Tenant existingTenant = convert(existing, Tenant.class);
// Tenant only has a subset of realm representation so overlay on actual realm representation
existing.setRealm(tenant.getRealm());
@@ -828,7 +853,7 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
configureRealm(existing);
realmsResource.realm(realm).update(existing);
- publishModification(PersistenceEvent.Cause.UPDATE, tenant);
+ persistenceService.publishPersistenceEvent(PersistenceEvent.Cause.UPDATE, convert(existing, Tenant.class), existingTenant, Tenant.getPropertyFields());
return null;
});
}
@@ -856,7 +881,7 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
realmResource.roles().create(new RoleRepresentation(RESTRICTED_USER_REALM_ROLE, "Restricted access to assets", false));
Tenant createdTenant = convert(realmRepresentation, Tenant.class);
- publishModification(PersistenceEvent.Cause.CREATE, createdTenant);
+ persistenceService.publishPersistenceEvent(PersistenceEvent.Cause.CREATE, tenant, null, Tenant.getPropertyFields());
return createdTenant;
} catch (Exception e) {
LOG.log(Level.INFO, "Failed to create tenant: " + tenant, e);
@@ -875,7 +900,7 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
realmsResource.realm(realm).remove();
return null;
});
- publishModification(PersistenceEvent.Cause.DELETE, tenant);
+ persistenceService.publishPersistenceEvent(PersistenceEvent.Cause.DELETE, null, tenant, Tenant.getPropertyFields());
}
}
@@ -1170,21 +1195,6 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
}
}
- protected void publishModification(PersistenceEvent.Cause cause, Tenant tenant) {
- // Fire persistence event although we don't use database for Tenant CUD but call Keycloak API
- PersistenceEvent<?> persistenceEvent = new PersistenceEvent<>(cause, tenant, new String[0], null);
-
- if (messageBrokerService.getProducerTemplate() != null) {
- messageBrokerService.getProducerTemplate().sendBodyAndHeader(
- PersistenceEvent.PERSISTENCE_TOPIC,
- ExchangePattern.InOnly,
- persistenceEvent,
- PersistenceEvent.HEADER_ENTITY_TYPE,
- persistenceEvent.getEntity().getClass()
- );
- }
- }
-
public String addLDAPConfiguration(String realm, ComponentRepresentation componentRepresentation) {
return getRealms(realmsResource -> {
diff --git a/model/src/main/java/org/openremote/model/security/Tenant.java b/model/src/main/java/org/openremote/model/security/Tenant.java
index 5c1c036ec..490bbf8cc 100644
--- a/model/src/main/java/org/openremote/model/security/Tenant.java
+++ b/model/src/main/java/org/openremote/model/security/Tenant.java
@@ -29,7 +29,8 @@ import javax.persistence.Transient;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
-import java.util.List;
+import java.lang.reflect.Field;
+import java.util.Arrays;
/**
* This can be used (among other things) to query the REALM table in JPA queries.
@@ -38,6 +39,8 @@ import java.util.List;
@Subselect("select * from PUBLIC.REALM") // Map this immutable to an SQL view, don't use/create table
public class Tenant {
+ protected static Field[] propertyFields;
+
@Id
protected String id;
@@ -230,6 +233,15 @@ public class Tenant {
return this;
}
+ public static Field[] getPropertyFields() {
+ if (propertyFields == null) {
+ propertyFields = Arrays.stream(Tenant.class.getDeclaredFields())
+ .filter(field -> field.isAnnotationPresent(Column.class))
+ .toArray(Field[]::new);
+ }
+ return propertyFields;
+ }
+
@Override
public String toString() {
return getClass().getSimpleName() + "{" +
diff --git a/model/src/main/java/org/openremote/model/security/User.java b/model/src/main/java/org/openremote/model/security/User.java
index 0ddd92dcd..396ffc078 100644
--- a/model/src/main/java/org/openremote/model/security/User.java
+++ b/model/src/main/java/org/openremote/model/security/User.java
@@ -33,21 +33,19 @@ import javax.validation.constraints.Email;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import static org.openremote.model.Constants.MASTER_REALM;
+import java.lang.reflect.Field;
+import java.util.*;
/**
* This can be used (among other things) to query the USER_ENTITY table in JPA queries.
*/
+// TODO: Add user roles as a transient property
@Entity
@Subselect("select * from PUBLIC.USER_ENTITY") // Map this immutable to an SQL view, don't use/create table
public class User {
public static final String SERVICE_ACCOUNT_PREFIX = "service-account-";
public static final String SYSTEM_ACCOUNT_ATTRIBUTE = "systemAccount";
+ protected static Field[] propertyFields;
@Formula("(select r.NAME from PUBLIC.REALM r where r.ID = REALM_ID)")
protected String realm;
@@ -139,6 +137,11 @@ public class User {
return username != null && username.startsWith(SERVICE_ACCOUNT_PREFIX);
}
+ public User setAttributes(Map<String, List<String>> attributes) {
+ this.attributes = attributes;
+ return this;
+ }
+
public Map<String, List<String>> getAttributes() {
return attributes;
}
@@ -224,6 +227,16 @@ public class User {
return secret;
}
+ public static Field[] getPropertyFields() {
+ if (propertyFields == null) {
+ propertyFields = Arrays.stream(User.class.getDeclaredFields())
+ .filter(field -> field.isAnnotationPresent(Column.class)
+ || field.getName().equals("attributes"))
+ .toArray(Field[]::new);
+ }
+ return propertyFields;
+ }
+
@Override
public String toString() {
return getClass().getName() + "{" +
diff --git a/model/src/main/java/org/openremote/model/util/ValueUtil.java b/model/src/main/java/org/openremote/model/util/ValueUtil.java
index 3d3d6f81a..2c360a5b1 100644
--- a/model/src/main/java/org/openremote/model/util/ValueUtil.java
+++ b/model/src/main/java/org/openremote/model/util/ValueUtil.java
@@ -29,11 +29,7 @@ import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;
import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
-import com.kjetland.jackson.jsonSchema.JsonSchemaConfig;
-import com.kjetland.jackson.jsonSchema.JsonSchemaDraft;
import com.kjetland.jackson.jsonSchema.JsonSchemaGenerator;
-import com.kjetland.jackson.jsonSchema.annotations.JsonSchemaInject;
-import com.kjetland.jackson.jsonSchema.annotations.JsonSchemaString;
import org.hibernate.internal.util.SerializationHelper;
import org.openremote.model.AssetModelProvider;
import org.openremote.model.ModelDescriptor;
@@ -59,10 +55,7 @@ import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.constraints.NotNull;
import java.io.Serializable;
-import java.lang.reflect.Array;
-import java.lang.reflect.Method;
-import java.lang.reflect.Modifier;
-import java.lang.reflect.Type;
+import java.lang.reflect.*;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.*;
@@ -888,6 +881,71 @@ public class ValueUtil {
);
}
+ public static Object[] getObjectFieldValues(Object object, String[] fieldNames) {
+ return Arrays.stream(fieldNames).map(fieldName -> getObjectFieldValue(object, fieldName)).toArray();
+ }
+
+ public static Object[] getObjectFieldValues(Object object, Field[] fields) {
+ return Arrays.stream(fields).map(field -> getObjectFieldValue(object, field)).toArray();
+ }
+
+ public static Object getObjectFieldValue(Object object, String fieldName) {
+ try {
+ Field field = object.getClass().getDeclaredField(fieldName);
+ return getObjectFieldValue(object, field);
+ } catch (NoSuchFieldException e) {
+ throw new IllegalStateException("Specified field could not be found: class=" + object.getClass().getSimpleName() + ", field=" + fieldName);
+ }
+ }
+ public static Object getObjectFieldValue(Object object, Field field) {
+ field.setAccessible(true);
+ try {
+ return field.get(object);
+ } catch (IllegalAccessException e) {
+ throw new IllegalStateException("Failed to get field value: class=" + object.getClass().getSimpleName() + ", field=" + field.getName());
+ }
+ }
+
+ public static boolean objectsEquals(Object a, Object b) {
+ if (!Objects.equals(a, b)) {
+ Object subject = a != null ? a : b;
+ Object subordinate = a != null ? b : a;
+ if (subject.getClass().isArray()) {
+ Class<?> arrayType = subject.getClass().getComponentType();
+ if (arrayType.isPrimitive()) {
+ if (arrayType == boolean.class) {
+ return Arrays.equals((boolean[]) subject, (boolean[]) subordinate);
+ }
+ if (arrayType == int.class) {
+ return Arrays.equals((int[]) subject, (int[]) subordinate);
+ }
+ if (arrayType == double.class) {
+ return Arrays.equals((double[]) subject, (double[]) subordinate);
+ }
+ if (arrayType == float.class) {
+ return Arrays.equals((float[]) subject, (float[]) subordinate);
+ }
+ if (arrayType == long.class) {
+ return Arrays.equals((long[]) subject, (long[]) subordinate);
+ }
+ if (arrayType == short.class) {
+ return Arrays.equals((short[]) subject, (short[]) subordinate);
+ }
+ if (arrayType == byte.class) {
+ return Arrays.equals((byte[]) subject, (byte[]) subordinate);
+ }
+ if (arrayType == char.class) {
+ return Arrays.equals((char[]) subject, (char[]) subordinate);
+ }
+ return false;
+ }
+ return Arrays.deepEquals((Object[])subject,(Object[])subordinate);
+ }
+ return false;
+ }
+ return true;
+ }
+
protected static boolean isGetter(Method method) {
if (Modifier.isPublic(method.getModifiers()) &&
method.getParameterTypes().length == 0) {
diff --git a/test/src/test/groovy/org/openremote/test/energy/EnergyOptimisationAssetTest.groovy b/test/src/test/groovy/org/openremote/test/energy/EnergyOptimisationAssetTest.groovy
index 7eb0d4643..a39ad492b 100644
--- a/test/src/test/groovy/org/openremote/test/energy/EnergyOptimisationAssetTest.groovy
+++ b/test/src/test/groovy/org/openremote/test/energy/EnergyOptimisationAssetTest.groovy
@@ -283,7 +283,7 @@ class EnergyOptimisationAssetTest extends Specification implements ManagerContai
optimisationAsset.setOptimisationDisabled(false)
optimisationAsset = assetStorageService.merge(optimisationAsset)
- then: "the battery setpoint should be set to max (7kW) to store produced energy for future deficit"
+ then: "the battery setpoint should be set to max to store produced energy for future deficit"
conditions.eventually {
assert ((ElectricityStorageAsset)assetStorageService.find(managerTestSetup.electricityBatteryAssetId)).getPowerSetpoint().orElse(0d) == 10d
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 3fc9a8add..a260b6230 100644
--- a/test/src/test/groovy/org/openremote/test/provisioning/UserAndAssetProvisioningTest.groovy
+++ b/test/src/test/groovy/org/openremote/test/provisioning/UserAndAssetProvisioningTest.groovy
@@ -29,6 +29,7 @@ import org.openremote.manager.event.ClientEventService
import org.openremote.manager.mqtt.DefaultMQTTHandler
import org.openremote.manager.mqtt.MqttBrokerService
import org.openremote.manager.provisioning.ProvisioningService
+import org.openremote.manager.provisioning.UserAssetProvisioningMQTTHandler
import org.openremote.manager.security.ManagerIdentityService
import org.openremote.manager.setup.SetupService
import org.openremote.model.asset.AssetEvent
@@ -121,7 +122,7 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
when: "a mqtt client connects"
def device1UniqueId = "device1"
- def mqttDevice1ClientId = UniqueIdentifierGenerator.generateId()
+ def mqttDevice1ClientId = UniqueIdentifierGenerator.generateId("device1")
List<String> subscribeFailures = []
Consumer<String> subscribeFailureCallback = {String topic -> subscribeFailures.add(topic)}
MQTT_IOClient device1Client = new MQTT_IOClient(mqttDevice1ClientId, mqttHost, mqttPort, false, false, null, null)
@@ -311,7 +312,7 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
def deviceNUniqueId = "device2"
def deviceNRequestTopic = "$PROVISIONING_TOKEN/$deviceNUniqueId/$REQUEST_TOKEN".toString()
def deviceNResponseTopic = "$PROVISIONING_TOKEN/$deviceNUniqueId/$RESPONSE_TOKEN".toString()
- def mqttDeviceNClientId = UniqueIdentifierGenerator.generateId()
+ def mqttDeviceNClientId = UniqueIdentifierGenerator.generateId("deviceN")
MQTT_IOClient deviceNClient = new MQTT_IOClient(mqttDeviceNClientId, mqttHost, mqttPort, false, false, null, null)
deviceNClient.setTopicSubscribeFailureConsumer(subscribeFailureCallback)
deviceNClient.connect()
@@ -457,7 +458,7 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
when: "the provisioning config is updated to disabled"
def existingConnection = mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId)
- subscribeFailures.clear()
+ device1Responses.clear()
provisioningConfig.setDisabled(true)
provisioningConfig = provisioningService.merge(provisioningConfig)
@@ -468,7 +469,22 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
assert !clientEventService.eventSubscriptions.sessionSubscriptionIdMap.containsKey(mqttDevice1ClientId)
}
- when: "a device re-connects"
+ when: "the re-connected client re-authenticates"
+ device1Responses.clear()
+ device1Client.sendMessage(
+ new MQTTMessage<String>(device1RequestTopic, ValueUtil.asJSON(
+ new X509ProvisioningMessage(getClass().getResource("/org/openremote/test/provisioning/device1.pem").text)
+ ).orElse(null))
+ )
+
+ then: "the broker should have published to the response topic an error message"
+ conditions.eventually {
+ assert device1Responses.size() == 1
+ assert device1Responses.get(0) instanceof ErrorResponseMessage
+ assert ((ErrorResponseMessage)device1Responses.get(0)).error == ErrorResponseMessage.Error.CONFIG_DISABLED
+ }
+
+ when: "another device re-connects"
deviceNResponses.clear()
deviceNClient.connect()
@@ -512,15 +528,68 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
}
when: "the provisioning config is updated to enabled"
+ existingConnection = mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId)
provisioningConfig.setDisabled(false)
provisioningConfig = provisioningService.merge(provisioningConfig)
- and: "a device user is disabled"
- def user = identityService.getIdentityProvider().getUserByUsername(managerTestSetup.realmBuildingTenant, User.SERVICE_ACCOUNT_PREFIX + "ps-" + deviceNUniqueId)
- user.setEnabled(false)
- user = identityService.getIdentityProvider().createUpdateUser(managerTestSetup.realmBuildingTenant, user, null)
+ then: "already connected client that was authenticated should be disconnected, then reconnect"
+ conditions.eventually {
+ assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != null
+ assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != existingConnection
+ assert !clientEventService.eventSubscriptions.sessionSubscriptionIdMap.containsKey(mqttDevice1ClientId)
+ }
- and: "a device with disabled user account re-connects"
+ when: "the re-connected device publishes its' valid client certificate"
+ device1Responses.clear()
+ device1Client.sendMessage(
+ new MQTTMessage<String>(device1RequestTopic, ValueUtil.asJSON(
+ new X509ProvisioningMessage(getClass().getResource("/org/openremote/test/provisioning/device1.pem").text)
+ ).orElse(null))
+ )
+
+ then: "the broker should have published to the response topic a success message containing the provisioned asset"
+ conditions.eventually {
+ assert device1Responses.size() == 1
+ assert device1Responses.get(0) instanceof SuccessResponseMessage
+ assert ((SuccessResponseMessage)device1Responses.get(0)).realm == managerTestSetup.realmBuildingTenant
+ asset = ((SuccessResponseMessage)device1Responses.get(0)).asset
+ assert asset != null
+ assert asset instanceof WeatherAsset
+ assert asset.getAttribute("serialNumber").flatMap{it.getValue()}.orElse(null) == device1UniqueId
+ }
+
+ when: "a connected device user is disabled and an un-connected device user is disabled"
+ existingConnection = mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId)
+ def device1User = identityService.getIdentityProvider().getUserByUsername(managerTestSetup.realmBuildingTenant, User.SERVICE_ACCOUNT_PREFIX + PROVISIONING_USER_PREFIX + device1UniqueId)
+ def deviceNUser = identityService.getIdentityProvider().getUserByUsername(managerTestSetup.realmBuildingTenant, User.SERVICE_ACCOUNT_PREFIX + PROVISIONING_USER_PREFIX + deviceNUniqueId)
+ device1User.setEnabled(false)
+ deviceNUser.setEnabled(false)
+ device1User = identityService.getIdentityProvider().createUpdateUser(managerTestSetup.realmBuildingTenant, device1User, null)
+ deviceNUser = identityService.getIdentityProvider().createUpdateUser(managerTestSetup.realmBuildingTenant, deviceNUser, null)
+
+ then: "already connected client that was authenticated should be disconnected, then reconnect"
+ conditions.eventually {
+ assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != null
+ assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != existingConnection
+ assert !clientEventService.eventSubscriptions.sessionSubscriptionIdMap.containsKey(mqttDevice1ClientId)
+ }
+
+ when: "the re-connected client re-authenticates"
+ device1Responses.clear()
+ device1Client.sendMessage(
+ new MQTTMessage<String>(device1RequestTopic, ValueUtil.asJSON(
+ new X509ProvisioningMessage(getClass().getResource("/org/openremote/test/provisioning/device1.pem").text)
+ ).orElse(null))
+ )
+
+ then: "the broker should have published to the response topic an error message"
+ conditions.eventually {
+ assert device1Responses.size() == 1
+ assert device1Responses.get(0) instanceof ErrorResponseMessage
+ assert ((ErrorResponseMessage)device1Responses.get(0)).error == ErrorResponseMessage.Error.USER_DISABLED
+ }
+
+ when: "a device with disabled user account connects"
deviceNResponses.clear()
deviceNClient.connect()
@@ -554,6 +623,31 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
assert ((ErrorResponseMessage)deviceNResponses.get(0)).error == ErrorResponseMessage.Error.USER_DISABLED
}
+ when: "a client user is re-enabled"
+ existingConnection = mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId)
+ def existingNConnection = mqttBrokerService.clientIdConnectionMap.get(mqttDeviceNClientId)
+ device1User.setEnabled(true)
+ device1User = identityService.getIdentityProvider().createUpdateUser(managerTestSetup.realmBuildingTenant, device1User, null)
+
+ and: "the re-enabled client device publishes its' valid client certificate"
+ device1Responses.clear()
+ device1Client.sendMessage(
+ new MQTTMessage<String>(device1RequestTopic, ValueUtil.asJSON(
+ new X509ProvisioningMessage(getClass().getResource("/org/openremote/test/provisioning/device1.pem").text)
+ ).orElse(null))
+ )
+
+ then: "the broker should have published to the response topic a success message containing the provisioned asset"
+ conditions.eventually {
+ assert device1Responses.size() == 1
+ assert device1Responses.get(0) instanceof SuccessResponseMessage
+ assert ((SuccessResponseMessage)device1Responses.get(0)).realm == managerTestSetup.realmBuildingTenant
+ asset = ((SuccessResponseMessage)device1Responses.get(0)).asset
+ assert asset != null
+ assert asset instanceof WeatherAsset
+ assert asset.getAttribute("serialNumber").flatMap{it.getValue()}.orElse(null) == device1UniqueId
+ }
+
cleanup: "disconnect the clients"
if (device1Client != null) {
device1Client.disconnect()