Skip to content

armgit / core

Public Imported from GitHub
0

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

Introduced EventRequestResponseWrapper for client sent SharedEvents expecting a response

Rich Turnerde8680a1741e
diff --git a/manager/src/main/java/org/openremote/manager/asset/AssetStorageService.java b/manager/src/main/java/org/openremote/manager/asset/AssetStorageService.java
index c0a91928c..83dc52d15 100644
--- a/manager/src/main/java/org/openremote/manager/asset/AssetStorageService.java
+++ b/manager/src/main/java/org/openremote/manager/asset/AssetStorageService.java
@@ -45,10 +45,7 @@ import org.openremote.model.attribute.MetaItemDescriptor;
import org.openremote.model.attribute.MetaItemType;
import org.openremote.model.calendar.CalendarEvent;
import org.openremote.model.event.TriggeredEventSubscription;
-import org.openremote.model.event.shared.AssetInfo;
-import org.openremote.model.event.shared.EventSubscription;
-import org.openremote.model.event.shared.SharedEvent;
-import org.openremote.model.event.shared.TenantFilter;
+import org.openremote.model.event.shared.*;
import org.openremote.model.query.AssetQuery;
import org.openremote.model.query.LogicGroup;
import org.openremote.model.query.filter.*;
@@ -80,8 +77,7 @@ import static java.util.stream.Collectors.joining;
import static org.apache.camel.builder.PredicateBuilder.or;
import static org.openremote.container.persistence.PersistenceEvent.PERSISTENCE_TOPIC;
import static org.openremote.container.persistence.PersistenceEvent.isPersistenceEventForEntityType;
-import static org.openremote.manager.event.ClientEventService.CLIENT_EVENT_TOPIC;
-import static org.openremote.manager.event.ClientEventService.getSessionKey;
+import static org.openremote.manager.event.ClientEventService.*;
import static org.openremote.manager.rules.AssetQueryPredicate.asPredicate;
import static org.openremote.model.asset.AssetAttribute.*;
import static org.openremote.model.attribute.MetaItemType.ACCESS_RESTRICTED_READ;
@@ -358,17 +354,28 @@ public class AssetStorageService extends RouteBuilder implements ContainerServic
from(CLIENT_EVENT_TOPIC)
.routeId("FromClientReadRequests")
.filter(
- or(body().isInstanceOf(ReadAssetsEvent.class), body().isInstanceOf(ReadAssetEvent.class)))
+ or(body().isInstanceOf(ReadAssetsEvent.class), body().isInstanceOf(ReadAssetEvent.class), body().isInstanceOf(ReadAssetAttributeEvent.class)))
.choice()
.when(body().isInstanceOf(ReadAssetEvent.class))
.process(exchange -> {
- ReadAssetEvent event = exchange.getIn().getBody(ReadAssetEvent.class);
- LOG.fine("Handling from client: " + event);
- boolean isAttributeRead = event instanceof ReadAssetAttributesEvent;
+ LOG.fine("Handling from client: " + exchange.getIn().getBody());
- if (event.getAssetId() == null || event.getAssetId().isEmpty())
+ String assetId = null;
+ String attribute = null;
+
+ if (exchange.getIn().getBody() instanceof ReadAssetEvent) {
+ assetId = exchange.getIn().getBody(ReadAssetEvent.class).getAssetId();
+ } else {
+ ReadAssetAttributeEvent assetAttributeEvent = exchange.getIn().getBody(ReadAssetAttributeEvent.class);
+ assetId = assetAttributeEvent.getAttributeRef().getEntityId();
+ attribute = assetAttributeEvent.getAttributeRef().getAttributeName();
+ }
+
+ if (TextUtil.isNullOrEmpty(assetId)) {
return;
+ }
+ boolean isAttributeRead = !TextUtil.isNullOrEmpty(attribute);
String sessionKey = getSessionKey(exchange);
AuthContext authContext = exchange.getIn().getHeader(Constants.AUTH_CONTEXT, AuthContext.class);
@@ -381,14 +388,28 @@ public class AssetStorageService extends RouteBuilder implements ContainerServic
Asset asset = find(
new AssetQuery()
- .ids(event.getAssetId())
+ .ids(assetId)
+ .select(new Select().excludePath(true).excludeParentInfo(true))
.access(access));
if (asset != null) {
+ String messageId = exchange.getIn().getHeader(HEADER_REQUEST_RESPONSE_MESSAGE_ID, String.class);
+ Object response = null;
+
if (isAttributeRead) {
- replyWithAttributeEvents(sessionKey, event.getSubscriptionId(), asset, ((ReadAssetAttributesEvent) event).getAttributeNames());
+ AssetAttribute assetAttribute = asset.getAttribute(attribute).orElse(null);
+ if (assetAttribute != null) {
+ response = new AttributeEvent(assetId, attribute, assetAttribute.getValue().orElse(null), assetAttribute.getValueTimestamp().orElse(0L));
+ }
} else {
- replyWithAssetEvent(sessionKey, event.getSubscriptionId(), asset);
+ response = new AssetEvent(AssetEvent.Cause.READ, asset, null);
+ }
+
+ if (response != null) {
+ if (!isNullOrEmpty(messageId)) {
+ response = new EventRequestResponseWrapper<>(messageId, (SharedEvent)response);
+ }
+ clientEventService.sendToSession(sessionKey, response);
}
}
})
@@ -416,8 +437,16 @@ public class AssetStorageService extends RouteBuilder implements ContainerServic
query.access(access);
List<Asset> assets = findAll(query);
- clientEventService.sendToSession(sessionKey, new AssetsEvent(readAssets.getMessageId(), assets));
+
+ String messageId = exchange.getIn().getHeader(HEADER_REQUEST_RESPONSE_MESSAGE_ID, String.class);
+
+ if (isNullOrEmpty(messageId)) {
+ clientEventService.sendToSession(sessionKey, new AssetsEvent(assets));
+ } else {
+ clientEventService.sendToSession(sessionKey, new EventRequestResponseWrapper<>(messageId, new AssetsEvent(assets)));
+ }
})
+ .stop()
.endChoice()
.end();
}
@@ -2106,14 +2135,8 @@ public class AssetStorageService extends RouteBuilder implements ContainerServic
clientEventService.sendToSession(sessionKey, triggeredEventSubscription);
}
- protected void replyWithAssetEvent(String sessionKey, String subscriptionId, Asset asset) {
- AssetEvent event = new AssetEvent(AssetEvent.Cause.READ, asset, null);
- TriggeredEventSubscription<?> triggeredEventSubscription = new TriggeredEventSubscription<>(Collections.singletonList(event), subscriptionId);
- clientEventService.sendToSession(sessionKey, triggeredEventSubscription);
- }
-
public String toString() {
return getClass().getSimpleName() + "{" +
'}';
}
-}
\ No newline at end of file
+}
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 26b53f250..891978621 100644
--- a/manager/src/main/java/org/openremote/manager/event/ClientEventService.java
+++ b/manager/src/main/java/org/openremote/manager/event/ClientEventService.java
@@ -108,6 +108,7 @@ public class ClientEventService implements ContainerService {
public static final String HEADER_CONNECTION_TYPE = ClientEventService.class.getName() + ".HEADER_CONNECTION_TYPE";
public static final String HEADER_CONNECTION_TYPE_WEBSOCKET = ClientEventService.class.getName() + ".HEADER_CONNECTION_TYPE_WEBSOCKET";
public static final String HEADER_CONNECTION_TYPE_MQTT = ClientEventService.class.getName() + ".HEADER_CONNECTION_TYPE_MQTT";
+ public static final String HEADER_REQUEST_RESPONSE_MESSAGE_ID = ClientEventService.class.getName() + ".HEADER_REQUEST_RESPONSE_MESSAGE_ID";
final protected Collection<EventSubscriptionAuthorizer> eventSubscriptionAuthorizers = new CopyOnWriteArraySet<>();
protected Map<String, String> sessionKeyConnectionTypeMap;
@@ -179,11 +180,26 @@ public class ClientEventService implements ContainerService {
.to(GatewayService.GATEWAY_EVENT_TOPIC)
.endChoice()
.stop()
+ .end()
+ .process(exchange -> {
+ EventRequestResponseWrapper<?> requestResponse = null;
+ if (exchange.getIn().getBody() instanceof EventRequestResponseWrapper) {
+ requestResponse = exchange.getIn().getBody(EventRequestResponseWrapper.class);
+ } else if (exchange.getIn().getBody() instanceof String && exchange.getIn().getBody(String.class).startsWith(EventRequestResponseWrapper.MESSAGE_PREFIX)) {
+ requestResponse = exchange.getIn().getBody(EventRequestResponseWrapper.class);
+ }
+ if (requestResponse != null) {
+ SharedEvent event = requestResponse.getEvent();
+ exchange.getIn().setHeader(HEADER_REQUEST_RESPONSE_MESSAGE_ID, requestResponse.getMessageId());
+ exchange.getIn().setBody(event);
+ }
+ })
+ .choice()
.when(bodyAs(String.class).startsWith(EventSubscription.SUBSCRIBE_MESSAGE_PREFIX))
.convertBodyTo(EventSubscription.class)
.process(exchange -> {
String sessionKey = getSessionKey(exchange);
- EventSubscription subscription = exchange.getIn().getBody(EventSubscription.class);
+ EventSubscription<?> subscription = exchange.getIn().getBody(EventSubscription.class);
AuthContext authContext = exchange.getIn().getHeader(Constants.AUTH_CONTEXT, AuthContext.class);
if (authorizeEventSubscription(authContext, subscription)) {
boolean restrictedUser = identityService.getIdentityProvider().isRestrictedUser(authContext.getUserId());
@@ -195,7 +211,7 @@ public class ClientEventService implements ContainerService {
+ authContext.getUsername() + "' in realm '" + authContext.getAuthenticatedRealm()
+ "': " + subscription
);
- sendToSession(sessionKey, new UnauthorizedEventSubscription(subscription));
+ sendToSession(sessionKey, new UnauthorizedEventSubscription<>(subscription));
}
})
.stop()
diff --git a/manager/src/main/java/org/openremote/manager/event/EventTypeConverters.java b/manager/src/main/java/org/openremote/manager/event/EventTypeConverters.java
index ff40aa6ac..a1a49ca01 100644
--- a/manager/src/main/java/org/openremote/manager/event/EventTypeConverters.java
+++ b/manager/src/main/java/org/openremote/manager/event/EventTypeConverters.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2016, OpenRemote Inc.
+ * Copyright 2020, OpenRemote Inc.
*
* See the CONTRIBUTORS.txt file in the distribution for a
* full listing of individual contributors.
@@ -111,4 +111,17 @@ public class EventTypeConverters implements TypeConverters {
string = string.substring(RenewEventSubscriptions.MESSAGE_PREFIX.length());
return Container.JSON.readValue(string, RenewEventSubscriptions.class);
}
-}
\ No newline at end of file
+
+ @Converter
+ public EventRequestResponseWrapper readRequestResponse(String string, Exchange exchange) throws Exception {
+ if (!string.startsWith(EventRequestResponseWrapper.MESSAGE_PREFIX))
+ return null;
+ string = string.substring(EventRequestResponseWrapper.MESSAGE_PREFIX.length());
+ return Container.JSON.readValue(string, EventRequestResponseWrapper.class);
+ }
+
+ @Converter
+ public String writeRequestResponse(EventRequestResponseWrapper requestResponseWrapper, Exchange exchange) throws Exception {
+ return EventRequestResponseWrapper.MESSAGE_PREFIX + Container.JSON.writeValueAsString(requestResponseWrapper);
+ }
+}
diff --git a/manager/src/main/java/org/openremote/manager/gateway/GatewayClientService.java b/manager/src/main/java/org/openremote/manager/gateway/GatewayClientService.java
index c673ec4ec..032ab065e 100644
--- a/manager/src/main/java/org/openremote/manager/gateway/GatewayClientService.java
+++ b/manager/src/main/java/org/openremote/manager/gateway/GatewayClientService.java
@@ -40,11 +40,13 @@ import org.openremote.manager.web.ManagerWebService;
import org.openremote.model.asset.*;
import org.openremote.model.asset.agent.ConnectionStatus;
import org.openremote.model.attribute.AttributeEvent;
+import org.openremote.model.event.shared.EventRequestResponseWrapper;
import org.openremote.model.event.shared.EventSubscription;
import org.openremote.model.event.shared.SharedEvent;
import org.openremote.model.event.shared.TenantFilter;
import org.openremote.model.gateway.GatewayConnection;
import org.openremote.model.gateway.GatewayConnectionStatusEvent;
+import org.openremote.model.gateway.GatewayDisconnectEvent;
import org.openremote.model.query.AssetQuery;
import org.openremote.model.query.filter.TenantPredicate;
import org.openremote.model.syslog.SyslogCategory;
@@ -234,7 +236,7 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
triggeredEventSubscription ->
triggeredEventSubscription.getEvents()
.forEach(event ->
- sendCentralManagerMessage(connection.getLocalRealm(), messageFromSharedEvent(event)))));
+ sendCentralManagerMessage(connection.getLocalRealm(), messageToString(SharedEvent.MESSAGE_PREFIX, event)))));
clientEventService.getEventSubscriptions().createOrUpdate(
getClientSessionKey(connection),
@@ -245,7 +247,7 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
triggeredEventSubscription ->
triggeredEventSubscription.getEvents()
.forEach(event ->
- sendCentralManagerMessage(connection.getLocalRealm(), messageFromSharedEvent(event)))));
+ sendCentralManagerMessage(connection.getLocalRealm(), messageToString(SharedEvent.MESSAGE_PREFIX, event)))));
client.connect();
return client;
@@ -260,6 +262,9 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
}
protected void destroyGatewayClient(GatewayConnection connection, WebsocketIoClient<String> client) {
+ if (client == null) {
+ return;
+ }
LOG.info("Destroying gateway IO client: " + connection);
try {
client.disconnect();
@@ -268,7 +273,10 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
} catch (Exception e) {
LOG.log(Level.WARNING, "An exception occurred whilst trying to disconnect the gateway IO client", e);
}
- clientEventService.getEventSubscriptions().cancelAll(getClientSessionKey(connection));
+
+ if (connection != null) {
+ clientEventService.getEventSubscriptions().cancelAll(getClientSessionKey(connection));
+ }
}
protected void onGatewayClientConnectionStatusChanged(GatewayConnection connection, ConnectionStatus connectionStatus) {
@@ -277,10 +285,30 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
}
protected void onCentralManagerMessage(GatewayConnection connection, String message) {
+ String messageId = null;
+ SharedEvent event = null;
+
+ if (message.startsWith(EventRequestResponseWrapper.MESSAGE_PREFIX)) {
+ EventRequestResponseWrapper<?> wrapper = messageFromString(
+ message,
+ EventRequestResponseWrapper.MESSAGE_PREFIX,
+ EventRequestResponseWrapper.class);
+ messageId = wrapper.getMessageId();
+ event = wrapper.getEvent();
+ }
+
if (message.startsWith(SharedEvent.MESSAGE_PREFIX)) {
- SharedEvent event = messageToSharedEvent(message);
+ event = messageFromString(message, SharedEvent.MESSAGE_PREFIX, SharedEvent.class);
+ }
- if (event instanceof AttributeEvent) {
+ if (event != null) {
+ if (event instanceof GatewayDisconnectEvent) {
+ if (((GatewayDisconnectEvent)event).getReason() == GatewayDisconnectEvent.Reason.PERMANENT_ERROR) {
+ LOG.info("Central manager requested disconnect due to permanent error (likely this version of the edge gateway software is not compatible with that manager version)");
+ destroyGatewayClient(connection, clientRealmMap.get(connection.getLocalRealm()));
+ clientRealmMap.put(connection.getLocalRealm(), null);
+ }
+ } else if (event instanceof AttributeEvent) {
assetProcessingService.sendAttributeEvent((AttributeEvent)event, AttributeEvent.Source.INTERNAL);
} else if (event instanceof AssetEvent) {
AssetEvent assetEvent = (AssetEvent)event;
@@ -303,7 +331,15 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
} catch (Exception e) {
LOG.log(Level.INFO, "Request from central manager to create/update an asset failed: Realm=" + connection.getLocalRealm() + ", Asset IDs=" + Arrays.toString(deleteRequest.getAssetIds().toArray()), e);
} finally {
- sendCentralManagerMessage(connection.getLocalRealm(), messageFromSharedEvent(new DeleteAssetsResponseEvent(deleteRequest.getName(), success)));
+ sendCentralManagerMessage(
+ connection.getLocalRealm(),
+ messageToString(
+ EventRequestResponseWrapper.MESSAGE_PREFIX,
+ new EventRequestResponseWrapper<>(
+ messageId,
+ new DeleteAssetsResponseEvent(success, deleteRequest.getAssetIds())
+ )
+ ));
}
} else if (event instanceof ReadAssetsEvent) {
ReadAssetsEvent readAssets = (ReadAssetsEvent)event;
@@ -311,7 +347,15 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
// Force realm to be the one that this client is associated with
query.tenant(new TenantPredicate(connection.getLocalRealm()));
List<Asset> assets = assetStorageService.findAll(readAssets.getAssetQuery());
- sendCentralManagerMessage(connection.getLocalRealm(), messageFromSharedEvent(new AssetsEvent(readAssets.getMessageId(), assets)));
+
+ sendCentralManagerMessage(
+ connection.getLocalRealm(),
+ messageToString(
+ EventRequestResponseWrapper.MESSAGE_PREFIX,
+ new EventRequestResponseWrapper<>(
+ messageId,
+ new AssetsEvent(assets)
+ )));
}
}
}
@@ -332,21 +376,21 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
return CLIENT_EVENT_SESSION_PREFIX + connection.getLocalRealm();
}
- protected SharedEvent messageToSharedEvent(String message) {
+ protected <T> T messageFromString(String message, String prefix, Class<T> clazz) {
try {
- message = message.substring(SharedEvent.MESSAGE_PREFIX.length());
- return Container.JSON.readValue(message, SharedEvent.class);
+ message = message.substring(prefix.length());
+ return Container.JSON.readValue(message, clazz);
} catch (Exception e) {
- throw new IllegalArgumentException("Unable to parse SharedEvent message");
+ throw new IllegalArgumentException("Unable to parse message");
}
}
- protected String messageFromSharedEvent(SharedEvent event) {
+ protected String messageToString(String prefix, Object message) {
try {
- String message = Container.JSON.writeValueAsString(event);
- return SharedEvent.MESSAGE_PREFIX + message;
+ String str = Container.JSON.writeValueAsString(message);
+ return prefix + str;
} catch (Exception e) {
- throw new IllegalArgumentException("Unable to parse SharedEvent message");
+ throw new IllegalArgumentException("Unable to serialise message");
}
}
diff --git a/manager/src/main/java/org/openremote/manager/gateway/GatewayConnector.java b/manager/src/main/java/org/openremote/manager/gateway/GatewayConnector.java
index 61ab77b8c..d1b8d6fa1 100644
--- a/manager/src/main/java/org/openremote/manager/gateway/GatewayConnector.java
+++ b/manager/src/main/java/org/openremote/manager/gateway/GatewayConnector.java
@@ -26,7 +26,9 @@ import org.openremote.manager.concurrent.ManagerExecutorService;
import org.openremote.model.asset.*;
import org.openremote.model.asset.agent.ConnectionStatus;
import org.openremote.model.attribute.AttributeEvent;
+import org.openremote.model.event.shared.EventRequestResponseWrapper;
import org.openremote.model.event.shared.SharedEvent;
+import org.openremote.model.gateway.GatewayDisconnectEvent;
import org.openremote.model.query.AssetQuery;
import org.openremote.model.syslog.SyslogCategory;
import org.openremote.model.value.Values;
@@ -61,7 +63,7 @@ public class GatewayConnector {
protected final ManagerExecutorService executorService;
protected final AssetProcessingService assetProcessingService;
protected final Map<String, Asset> pendingAssetMerges = new HashMap<>();
- protected final AtomicReference<DeleteAssetsRequestEvent> pendingAssetDelete = new AtomicReference<>();
+ protected final AtomicReference<EventRequestResponseWrapper<DeleteAssetsRequestEvent>> pendingAssetDelete = new AtomicReference<>();
protected List<AssetEvent> cachedAssetEvents;
protected List<AttributeEvent> cachedAttributeEvents;
protected Consumer<Object> gatewayMessageConsumer;
@@ -188,14 +190,14 @@ public class GatewayConnector {
}
}
- synchronized protected void onGatewayEvent(SharedEvent e) {
+ synchronized protected void onGatewayEvent(String messageId, SharedEvent e) {
if (!isConnected()) {
return;
}
if (initialSyncInProgress) {
if (e instanceof AssetsEvent) {
- onSyncAssetsResponse((AssetsEvent) e);
+ onSyncAssetsResponse(messageId, (AssetsEvent) e);
} else if (e instanceof AttributeEvent) {
cachedAttributeEvents.add((AttributeEvent) e);
} else if (e instanceof AssetEvent) {
@@ -207,7 +209,7 @@ public class GatewayConnector {
} else if (e instanceof AttributeEvent) {
onAttributeEvent((AttributeEvent) e);
} else if (e instanceof DeleteAssetsResponseEvent) {
- onAssetDeleteResponseEvent((DeleteAssetsResponseEvent) e);
+ onAssetDeleteResponseEvent(messageId, (DeleteAssetsResponseEvent) e);
}
}
}
@@ -222,9 +224,9 @@ public class GatewayConnector {
}
expectedSyncResponseName = ASSET_READ_EVENT_NAME_INITIAL;
- sendMessageToGateway(new ReadAssetsEvent(
- ASSET_READ_EVENT_NAME_INITIAL, new AssetQuery().select(selectExcludeAll()).recursive(true)
- ));
+ sendMessageToGateway(new EventRequestResponseWrapper<>(
+ ASSET_READ_EVENT_NAME_INITIAL,
+ new ReadAssetsEvent(new AssetQuery().select(selectExcludeAll()).recursive(true))));
syncProcessorFuture = executorService.schedule(this::onSyncAssetsTimeout, SYNC_TIMEOUT_MILLIS);
}
@@ -253,8 +255,9 @@ public class GatewayConnector {
protected boolean syncAborted() {
if (syncErrors == MAX_SYNC_RETRIES) {
- LOG.warning("Gateway sync max retries reached so disabling the gateway: Gateway ID=" + gatewayId);
- setDisabled(true);
+ LOG.warning("Gateway sync max retries reached so disconnecting the gateway: Gateway ID=" + gatewayId);
+ sendMessageToGateway(new GatewayDisconnectEvent(GatewayDisconnectEvent.Reason.PERMANENT_ERROR));
+ disconnect();
return true;
}
@@ -276,29 +279,31 @@ public class GatewayConnector {
LOG.fine("Synchronising gateway assets " + syncIndex+1 + "-" + syncIndex + requestAssetIds.length + " of " + syncAssetIds.size());
sendMessageToGateway(
- new ReadAssetsEvent(
+ new EventRequestResponseWrapper<>(
expectedSyncResponseName,
- new AssetQuery()
- .select(new AssetQuery.Select().excludeParentInfo(true).excludePath(true))
- .ids(requestAssetIds)
+ new ReadAssetsEvent(
+ new AssetQuery()
+ .select(new AssetQuery.Select().excludeParentInfo(true).excludePath(true))
+ .ids(requestAssetIds)
+ )
)
);
syncProcessorFuture = executorService.schedule(this::requestAssets, SYNC_TIMEOUT_MILLIS);
}
- synchronized protected void onSyncAssetsResponse(AssetsEvent e) {
+ synchronized protected void onSyncAssetsResponse(String messageId, AssetsEvent e) {
if (!isConnected()) {
return;
}
- if (!expectedSyncResponseName.equalsIgnoreCase(e.getMessageId())) {
- LOG.info("Unexpected response from gateway so ignoring (expected=" + expectedSyncResponseName + ", actual =" + e.getMessageId() + "): " + e);
+ if (!expectedSyncResponseName.equalsIgnoreCase(messageId)) {
+ LOG.info("Unexpected response from gateway so ignoring (expected=" + expectedSyncResponseName + ", actual =" + messageId + "): " + e);
return;
}
syncProcessorFuture.cancel(true);
syncProcessorFuture = null;
- boolean isInitialResponse = ASSET_READ_EVENT_NAME_INITIAL.equalsIgnoreCase(e.getMessageId());
+ boolean isInitialResponse = ASSET_READ_EVENT_NAME_INITIAL.equalsIgnoreCase(messageId);
if (isInitialResponse) {
@@ -401,12 +406,13 @@ public class GatewayConnector {
onInitialSyncComplete();
// Refresh attributes that have changed
- cachedAttributeEvents.stream().filter(attributeEvent -> syncAssetIds.contains(attributeEvent.getEntityId())).collect(Collectors.groupingBy(AttributeEvent::getEntityId)).forEach(
- (assetId, attributeEvents) -> {
- LOG.info("1 or more gateway asset attribute values have changed so requesting latest values (Gateway ID=" + gatewayId + ", Asset ID=" + assetId);
- sendMessageToGateway(new ReadAssetAttributesEvent(assetId, attributeEvents.stream().map(AttributeEvent::getAttributeName).toArray(String[]::new)));
+ cachedAttributeEvents.forEach(attributeEvent -> {
+ String assetId = attributeEvent.getEntityId();
+ if (!refreshAssets.contains(assetId)) {
+ LOG.info("1 or more gateway asset attribute values have changed so requesting the asset again (Gateway ID=" + gatewayId + ", Asset ID=" + assetId);
+ refreshAssets.add(assetId);
}
- );
+ });
// Refresh assets that have changed
refreshAssets.forEach(id -> sendMessageToGateway(new ReadAssetEvent(id)));
@@ -524,7 +530,10 @@ public class GatewayConnector {
throw new IllegalStateException(msg);
}
- pendingAssetDelete.set(new DeleteAssetsRequestEvent(UniqueIdentifierGenerator.generateId(), new ArrayList<>(assetIds)));
+ pendingAssetDelete.set(new EventRequestResponseWrapper<>(
+ UniqueIdentifierGenerator.generateId(),
+ new DeleteAssetsRequestEvent(new ArrayList<>(assetIds))
+ ));
try {
sendMessageToGateway(pendingAssetDelete.get());
@@ -543,14 +552,14 @@ public class GatewayConnector {
}
}
- protected void onAssetDeleteResponseEvent(DeleteAssetsResponseEvent e) {
+ protected void onAssetDeleteResponseEvent(String messageId, DeleteAssetsResponseEvent e) {
synchronized (pendingAssetDelete) {
if (pendingAssetDelete.get() == null) {
return;
}
- if (!pendingAssetDelete.get().getName().equals(e.getName())) {
+ if (!pendingAssetDelete.get().getMessageId().equals(messageId)) {
LOG.info("Gateway asset delete response name does not match request so ignoring");
return;
}
diff --git a/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java b/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java
index de674683f..a2c97a3d1 100644
--- a/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java
+++ b/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java
@@ -41,6 +41,8 @@ import org.openremote.model.asset.Asset;
import org.openremote.model.asset.AssetAttribute;
import org.openremote.model.asset.AssetType;
import org.openremote.model.attribute.AttributeEvent;
+import org.openremote.model.event.shared.EventRequestResponseWrapper;
+import org.openremote.model.event.shared.RenewEventSubscriptions;
import org.openremote.model.event.shared.SharedEvent;
import org.openremote.model.gateway.GatewayDisconnectEvent;
import org.openremote.model.query.AssetQuery;
@@ -62,8 +64,7 @@ import java.util.stream.Collectors;
import static org.apache.camel.builder.PredicateBuilder.or;
import static org.openremote.container.persistence.PersistenceEvent.PERSISTENCE_TOPIC;
import static org.openremote.container.persistence.PersistenceEvent.isPersistenceEventForEntityType;
-import static org.openremote.manager.event.ClientEventService.getClientId;
-import static org.openremote.manager.event.ClientEventService.getSessionKey;
+import static org.openremote.manager.event.ClientEventService.*;
import static org.openremote.model.syslog.SyslogCategory.GATEWAY;
public class GatewayService extends RouteBuilder implements ContainerService, AssetUpdateProcessor {
@@ -223,9 +224,17 @@ public class GatewayService extends RouteBuilder implements ContainerService, As
.stop()
.when(body().isInstanceOf(SharedEvent.class))
.process(exchange -> {
- String gatewayId = getGatewayIdFromClientId(getClientId(exchange));
- onGatewayEventReceived(gatewayId, exchange.getIn().getBody(SharedEvent.class));
+ String clientId = getClientId(exchange);
+ if (clientId != null) {
+ String gatewayId = getGatewayIdFromClientId(clientId);
+ onGatewayEventReceived(gatewayId, exchange.getIn().getHeader(HEADER_REQUEST_RESPONSE_MESSAGE_ID, String.class), exchange.getIn().getBody(SharedEvent.class));
+ }
})
+ .stop()
+ .otherwise()
+ .process(exchange -> {
+ LOG.warning("UNKOWN EVENT: " + exchange.getIn().getBody());
+ })
.end();
}
}
@@ -562,10 +571,10 @@ public class GatewayService extends RouteBuilder implements ContainerService, As
};
}
- protected void onGatewayEventReceived(String gatewayId, SharedEvent event) {
+ protected void onGatewayEventReceived(String gatewayId, String messageId, SharedEvent event) {
GatewayConnector connector = gatewayConnectorMap.get(gatewayId);
if (connector != null) {
- connector.onGatewayEvent(event);
+ connector.onGatewayEvent(messageId, event);
}
}
}
diff --git a/model/src/main/java/org/openremote/model/asset/AssetsEvent.java b/model/src/main/java/org/openremote/model/asset/AssetsEvent.java
index 9f20d2516..fb2936a83 100644
--- a/model/src/main/java/org/openremote/model/asset/AssetsEvent.java
+++ b/model/src/main/java/org/openremote/model/asset/AssetsEvent.java
@@ -21,7 +21,6 @@ package org.openremote.model.asset;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
-import org.openremote.model.event.shared.EventIdentifier;
import org.openremote.model.event.shared.SharedEvent;
import java.util.List;
@@ -30,21 +29,15 @@ import java.util.stream.Collectors;
/**
* This event is used in response to a {@link ReadAssetsEvent}.
*/
-public class AssetsEvent extends SharedEvent implements EventIdentifier {
+public class AssetsEvent extends SharedEvent {
- protected String messageId;
protected List<Asset> assets;
@JsonCreator
- public AssetsEvent(@JsonProperty("messageId") String messageId, @JsonProperty("assets") List<Asset> assets) {
- this.messageId = messageId;
+ public AssetsEvent(@JsonProperty("assets") List<Asset> assets) {
this.assets = assets;
}
- public String getMessageId() {
- return messageId;
- }
-
public List<Asset> getAssets() {
return assets;
}
@@ -52,7 +45,6 @@ public class AssetsEvent extends SharedEvent implements EventIdentifier {
@Override
public String toString() {
return AssetsEvent.class.getSimpleName() + "{" +
- "messageId='" + messageId + '\'' +
", assets=" + (assets == null ? "null" : assets.stream().map(Asset::getId).collect(Collectors.joining())) +
'}';
}
diff --git a/model/src/main/java/org/openremote/model/asset/DeleteAssetsRequestEvent.java b/model/src/main/java/org/openremote/model/asset/DeleteAssetsRequestEvent.java
index d0c0a5b0a..5d47a68f8 100644
--- a/model/src/main/java/org/openremote/model/asset/DeleteAssetsRequestEvent.java
+++ b/model/src/main/java/org/openremote/model/asset/DeleteAssetsRequestEvent.java
@@ -33,16 +33,10 @@ import java.util.List;
*/
public class DeleteAssetsRequestEvent extends SharedEvent {
- protected String name;
protected List<String> assetIds;
@JsonCreator
- public DeleteAssetsRequestEvent(@JsonProperty("name") String name, @JsonProperty("assetIds") List<String> assetIds) {
- this.name = name;
- this.assetIds = assetIds;
- }
-
- public DeleteAssetsRequestEvent(List<String> assetIds) {
+ public DeleteAssetsRequestEvent(@JsonProperty("assetIds") List<String> assetIds) {
this.assetIds = assetIds;
}
@@ -50,14 +44,9 @@ public class DeleteAssetsRequestEvent extends SharedEvent {
return assetIds;
}
- public String getName() {
- return name;
- }
-
@Override
public String toString() {
return getClass().getSimpleName() + "{" +
- "name='" + name + '\'' +
"ids='" + Arrays.toString(assetIds.toArray()) + '\'' +
'}';
}
diff --git a/model/src/main/java/org/openremote/model/asset/DeleteAssetsResponseEvent.java b/model/src/main/java/org/openremote/model/asset/DeleteAssetsResponseEvent.java
index fe62db890..e8f6f775f 100644
--- a/model/src/main/java/org/openremote/model/asset/DeleteAssetsResponseEvent.java
+++ b/model/src/main/java/org/openremote/model/asset/DeleteAssetsResponseEvent.java
@@ -32,32 +32,28 @@ import java.util.List;
*/
public class DeleteAssetsResponseEvent extends SharedEvent {
- protected String name;
protected boolean deleted;
+ protected List<String> assetIds;
@JsonCreator
- public DeleteAssetsResponseEvent(@JsonProperty("name") String name, @JsonProperty("deleted") boolean deleted) {
- this.name = name;
- this.deleted = deleted;
- }
-
- public DeleteAssetsResponseEvent(boolean deleted) {
+ public DeleteAssetsResponseEvent(@JsonProperty("deleted") boolean deleted, @JsonProperty("assetIds") List<String> assetIds) {
this.deleted = deleted;
+ this.assetIds = assetIds;
}
public boolean isDeleted() {
return deleted;
}
- public String getName() {
- return name;
+ public List<String> getAssetIds() {
+ return assetIds;
}
@Override
public String toString() {
return getClass().getSimpleName() + "{" +
- "name='" + name + '\'' +
"deleted='" + deleted + '\'' +
+ "ids='" + Arrays.toString(assetIds.toArray()) + '\'' +
'}';
}
}
diff --git a/model/src/main/java/org/openremote/model/asset/ReadAssetAttributesEvent.java b/model/src/main/java/org/openremote/model/asset/ReadAssetAttributeEvent.java
similarity index 50%
rename from model/src/main/java/org/openremote/model/asset/ReadAssetAttributesEvent.java
rename to model/src/main/java/org/openremote/model/asset/ReadAssetAttributeEvent.java
index 17afd1c59..87da8a0f5 100644
--- a/model/src/main/java/org/openremote/model/asset/ReadAssetAttributesEvent.java
+++ b/model/src/main/java/org/openremote/model/asset/ReadAssetAttributeEvent.java
@@ -19,47 +19,43 @@
*/
package org.openremote.model.asset;
+import com.fasterxml.jackson.annotation.JsonCreator;
import org.openremote.model.attribute.AttributeEvent;
+import org.openremote.model.attribute.AttributeRef;
import org.openremote.model.event.shared.SharedEvent;
import java.util.Arrays;
/**
- * A client sends this event to the server to refresh its attribute state, expecting
- * the server to answer "soon" with {@link AttributeEvent}s. If the server
- * decides that the client doesn't have the right permissions, or if anything
- * else is not in order (e.g. the asset doesn't exist), the server might not react
- * at all.
- * <p>
- * If no attribute names and only an asset identifier are provided, all attributes
- * of the asset, accessible by the client, will be read/returned.
+ * A client sends this event to the server to refresh the value of the specified attribute, expecting the server to
+ * answer "soon" with an {@link AttributeEvent}. If the server decides that the client doesn't have the right
+ * permissions, or if anything else is not in order (e.g. the asset doesn't exist), the server might not react at all.
*/
-public class ReadAssetAttributesEvent extends ReadAssetEvent {
+public class ReadAssetAttributeEvent extends SharedEvent {
- protected String[] attributeNames;
+ protected AttributeRef attributeRef;
- protected ReadAssetAttributesEvent() {
+ @JsonCreator
+ public ReadAssetAttributeEvent(AttributeRef attributeRef) {
+ this.attributeRef = attributeRef;
}
- public ReadAssetAttributesEvent(String assetId, String... attributeNames) {
- super(assetId);
- this.attributeNames = attributeNames;
+ public ReadAssetAttributeEvent(String assetId, String attributeName) {
+ this.attributeRef = new AttributeRef(assetId, attributeName);
}
- public String[] getAttributeNames() {
- return attributeNames;
+ public AttributeRef getAttributeRef() {
+ return attributeRef;
}
- public void setAttributeNames(String[] attributeNames) {
- this.attributeNames = attributeNames;
+ public void setAttributeRef(AttributeRef attributeRef) {
+ this.attributeRef = attributeRef;
}
@Override
public String toString() {
return getClass().getSimpleName() + "{" +
- "assetId='" + assetId + '\'' +
- ", attributeNames=" + Arrays.toString(attributeNames) +
- ", subscriptionId='" + subscriptionId + '\'' +
+ "attributeRef='" + attributeRef + '\'' +
'}';
}
}
diff --git a/model/src/main/java/org/openremote/model/asset/ReadAssetEvent.java b/model/src/main/java/org/openremote/model/asset/ReadAssetEvent.java
index 15be78137..928b70709 100644
--- a/model/src/main/java/org/openremote/model/asset/ReadAssetEvent.java
+++ b/model/src/main/java/org/openremote/model/asset/ReadAssetEvent.java
@@ -19,27 +19,22 @@
*/
package org.openremote.model.asset;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
import org.openremote.model.event.shared.SharedEvent;
/**
- * A client sends this event to the server to refresh its asset state, expecting
- * the server to answer "soon" with an {@link AssetEvent}, the client must have an
- * {@link org.openremote.model.event.shared.EventSubscription}&lt;{@link AssetEvent}&gt;
- * in place in order to receive the response. If the server
- * decides that the client doesn't have the right permissions, or if anything
- * else is not in order (e.g. the asset doesn't exist), the server might not react
+ * A client sends this event to the server to read the specified asset, optionally restricting which attributes
+ * expecting the server to answer "soon" with an {@link AssetEvent}. If the server decides that the client doesn't have
+ * the right permissions, or if anything else is not in order (e.g. the asset doesn't exist), the server might not react
* at all.
*/
public class ReadAssetEvent extends SharedEvent {
protected String assetId;
- protected String subscriptionId;
-
- protected ReadAssetEvent() {
- }
-
- public ReadAssetEvent(String assetId) {
+ @JsonCreator
+ public ReadAssetEvent(@JsonProperty("assetId") String assetId) {
this.assetId = assetId;
}
@@ -51,19 +46,10 @@ public class ReadAssetEvent extends SharedEvent {
this.assetId = assetId;
}
- public String getSubscriptionId() {
- return subscriptionId;
- }
-
- public void setSubscriptionId(String subscriptionId) {
- this.subscriptionId = subscriptionId;
- }
-
@Override
public String toString() {
return getClass().getSimpleName() + "{" +
"assetId='" + assetId + '\'' +
- ", subscriptionId='" + subscriptionId + '\'' +
'}';
}
}
diff --git a/model/src/main/java/org/openremote/model/asset/ReadAssetsEvent.java b/model/src/main/java/org/openremote/model/asset/ReadAssetsEvent.java
index f5b79b3c7..0ff803496 100644
--- a/model/src/main/java/org/openremote/model/asset/ReadAssetsEvent.java
+++ b/model/src/main/java/org/openremote/model/asset/ReadAssetsEvent.java
@@ -21,7 +21,7 @@ package org.openremote.model.asset;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
-import org.openremote.model.event.shared.EventIdentifier;
+import org.openremote.model.event.shared.EventRequestResponseWrapper;
import org.openremote.model.event.shared.SharedEvent;
import org.openremote.model.query.AssetQuery;
@@ -29,18 +29,12 @@ import org.openremote.model.query.AssetQuery;
* A client sends this event to the server to query assets, expecting
* the server to answer "soon" with an {@link AssetsEvent} with the results.
*/
-public class ReadAssetsEvent extends SharedEvent implements EventIdentifier {
+public class ReadAssetsEvent extends SharedEvent {
- protected String messageId;
protected AssetQuery assetQuery;
@JsonCreator
- public ReadAssetsEvent(@JsonProperty("messageId") String messageId, @JsonProperty("assetQuery") AssetQuery assetQuery) {
- this.messageId = messageId;
- this.assetQuery = assetQuery;
- }
-
- public ReadAssetsEvent(AssetQuery assetQuery) {
+ public ReadAssetsEvent(@JsonProperty("assetQuery") AssetQuery assetQuery) {
this.assetQuery = assetQuery;
}
@@ -48,14 +42,9 @@ public class ReadAssetsEvent extends SharedEvent implements EventIdentifier {
return assetQuery;
}
- public String getMessageId() {
- return messageId;
- }
-
@Override
public String toString() {
return getClass().getSimpleName() + "{" +
- "messageId='" + messageId + '\'' +
"query='" + assetQuery + '\'' +
'}';
}
diff --git a/model/src/main/java/org/openremote/model/event/shared/EventIdentifier.java b/model/src/main/java/org/openremote/model/event/shared/EventIdentifier.java
deleted file mode 100644
index a92766a93..000000000
--- a/model/src/main/java/org/openremote/model/event/shared/EventIdentifier.java
+++ /dev/null
@@ -1,32 +0,0 @@
-/*
- * Copyright 2020, OpenRemote Inc.
- *
- * See the CONTRIBUTORS.txt file in the distribution for a
- * full listing of individual contributors.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-package org.openremote.model.event.shared;
-
-import com.fasterxml.jackson.annotation.JsonProperty;
-
-/**
- * An interface for Events that 'expect' a response; {@link #getMessageId()} should return a unique string that
- * allows the response to be linked to the request. It is up to the backend to then use this message ID on the
- * reply and to also determine what the reply message should be.
- */
-public interface EventIdentifier {
- @JsonProperty
- String getMessageId();
-}
diff --git a/model/src/main/java/org/openremote/model/event/shared/EventRequestResponseWrapper.java b/model/src/main/java/org/openremote/model/event/shared/EventRequestResponseWrapper.java
new file mode 100644
index 000000000..649dac637
--- /dev/null
+++ b/model/src/main/java/org/openremote/model/event/shared/EventRequestResponseWrapper.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2020, OpenRemote Inc.
+ *
+ * See the CONTRIBUTORS.txt file in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.openremote.model.event.shared;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * A wrapper for events that require a response that provides a message ID to allow the request and response to be
+ * re-associated on the client; the message ID can be any string but should be unique enough to prevent collisions with
+ * other pending request-response events from the same client.
+ * <p>
+ * It is up to the backend to then use this message ID on the reply and to also determine what the reply message should be.
+ */
+public class EventRequestResponseWrapper<T extends SharedEvent> {
+
+ public static final String MESSAGE_PREFIX = "REQUESTRESPONSE:";
+
+ protected String messageId;
+ protected T event;
+
+ @JsonCreator
+ public EventRequestResponseWrapper(@JsonProperty("messageId") String messageId, @JsonProperty("event") T event) {
+ this.messageId = messageId;
+ this.event = event;
+ }
+
+ public String getMessageId() {
+ return messageId;
+ }
+
+ public void setMessageId(String messageId) {
+ this.messageId = messageId;
+ }
+
+ public T getEvent() {
+ return event;
+ }
+
+ public void setEvent(T event) {
+ this.event = event;
+ }
+}
diff --git a/model/src/main/java/org/openremote/model/event/shared/SharedEvent.java b/model/src/main/java/org/openremote/model/event/shared/SharedEvent.java
index c3cf891fb..54ced66dd 100644
--- a/model/src/main/java/org/openremote/model/event/shared/SharedEvent.java
+++ b/model/src/main/java/org/openremote/model/event/shared/SharedEvent.java
@@ -42,7 +42,7 @@ import org.openremote.model.syslog.SyslogEvent;
@JsonSubTypes.Type(value = AttributeEvent.class, name = "attribute"),
@JsonSubTypes.Type(value = AssetEvent.class, name = "asset"),
@JsonSubTypes.Type(value = AssetsEvent.class, name = "assets"),
- @JsonSubTypes.Type(value = ReadAssetAttributesEvent.class, name = "read-asset-attributes"),
+ @JsonSubTypes.Type(value = ReadAssetAttributeEvent.class, name = "read-asset-attribute"),
@JsonSubTypes.Type(value = ReadAssetEvent.class, name = "read-asset"),
@JsonSubTypes.Type(value = ReadAssetsEvent.class, name = "read-assets"),
@JsonSubTypes.Type(value = AssetTreeModifiedEvent.class, name = "asset-tree-modified"),
diff --git a/model/src/main/java/org/openremote/model/gateway/GatewayDisconnectEvent.java b/model/src/main/java/org/openremote/model/gateway/GatewayDisconnectEvent.java
index 2bd5161ba..95a1cf44c 100644
--- a/model/src/main/java/org/openremote/model/gateway/GatewayDisconnectEvent.java
+++ b/model/src/main/java/org/openremote/model/gateway/GatewayDisconnectEvent.java
@@ -37,6 +37,7 @@ public class GatewayDisconnectEvent extends SharedEvent {
DISABLED,
ALREADY_CONNECTED,
UNRECOGNISED,
+ PERMANENT_ERROR
}
protected Reason reason;
diff --git a/test/src/test/groovy/org/openremote/test/gateway/GatewayTest.groovy b/test/src/test/groovy/org/openremote/test/gateway/GatewayTest.groovy
index 1ff4ef46c..19cb45076 100644
--- a/test/src/test/groovy/org/openremote/test/gateway/GatewayTest.groovy
+++ b/test/src/test/groovy/org/openremote/test/gateway/GatewayTest.groovy
@@ -23,6 +23,8 @@ import org.openremote.manager.setup.builtin.ManagerDemoSetup
import org.openremote.model.asset.*
import org.openremote.model.asset.agent.ConnectionStatus
import org.openremote.model.attribute.*
+import org.openremote.model.event.Event
+import org.openremote.model.event.shared.EventRequestResponseWrapper
import org.openremote.model.event.shared.SharedEvent
import org.openremote.model.gateway.GatewayClientResource
import org.openremote.model.gateway.GatewayConnection
@@ -130,9 +132,10 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
and: "the server should have sent a CONNECTED message and an asset read request"
conditions.eventually {
assert clientReceivedMessages.size() >= 1
- assert clientReceivedMessages[0].startsWith(SharedEvent.MESSAGE_PREFIX)
- def readAssetsEvent = Container.JSON.readValue(clientReceivedMessages[0].substring(SharedEvent.MESSAGE_PREFIX.length()), ReadAssetsEvent.class)
- assert readAssetsEvent.messageId == GatewayConnector.ASSET_READ_EVENT_NAME_INITIAL
+ assert clientReceivedMessages[0].startsWith(EventRequestResponseWrapper.MESSAGE_PREFIX)
+ def response = Container.JSON.readValue(clientReceivedMessages[0].substring(EventRequestResponseWrapper.MESSAGE_PREFIX.length()), EventRequestResponseWrapper.class)
+ assert response.messageId == GatewayConnector.ASSET_READ_EVENT_NAME_INITIAL
+ def readAssetsEvent = response.event as ReadAssetsEvent
assert readAssetsEvent.assetQuery != null
assert readAssetsEvent.assetQuery.select.excludeAttributes
assert readAssetsEvent.assetQuery.select.excludePath
@@ -240,20 +243,22 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
List<Asset> sendAssets = []
sendAssets.addAll(agentAssets)
sendAssets.addAll(assets)
- def readAssetsReplyEvent = new AssetsEvent(
+ def readAssetsReplyEvent = new EventRequestResponseWrapper(
GatewayConnector.ASSET_READ_EVENT_NAME_INITIAL,
- sendAssets
- )
- gatewayClient.sendMessage(SharedEvent.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
+ new AssetsEvent(sendAssets))
+ gatewayClient.sendMessage(EventRequestResponseWrapper.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
then: "the central manager should have requested the full loading of the first batch of assets"
+ String messageId = null
ReadAssetsEvent readAssetsEvent = null
conditions.eventually {
assert clientReceivedMessages.size() == 1
- assert clientReceivedMessages.get(0).startsWith(SharedEvent.MESSAGE_PREFIX)
+ assert clientReceivedMessages.get(0).startsWith(EventRequestResponseWrapper.MESSAGE_PREFIX)
assert clientReceivedMessages.get(0).contains("read-assets")
- readAssetsEvent = Container.JSON.readValue(clientReceivedMessages[0].substring(SharedEvent.MESSAGE_PREFIX.length()), ReadAssetsEvent.class)
- assert readAssetsEvent.messageId == GatewayConnector.ASSET_READ_EVENT_NAME_BATCH + "0"
+ def response = Container.JSON.readValue(clientReceivedMessages[0].substring(EventRequestResponseWrapper.MESSAGE_PREFIX.length()), EventRequestResponseWrapper.class)
+ messageId = response.messageId
+ readAssetsEvent = response.event as ReadAssetsEvent
+ assert messageId == GatewayConnector.ASSET_READ_EVENT_NAME_BATCH + "0"
assert readAssetsEvent.assetQuery != null
assert readAssetsEvent.assetQuery.select.excludePath
assert readAssetsEvent.assetQuery.select.excludeParentInfo
@@ -267,11 +272,11 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
sendAssets = []
sendAssets.addAll(agentAssets)
sendAssets.addAll(Arrays.stream(readAssetsEvent.assetQuery.ids).filter{!agentAssetIds.contains(it)}.map{id -> assets.stream().filter{asset -> asset.id == id}.findFirst().orElse(null)}.collect(Collectors.toList()))
- readAssetsReplyEvent = new AssetsEvent(
- readAssetsEvent.messageId,
- sendAssets
+ readAssetsReplyEvent = new EventRequestResponseWrapper(
+ messageId,
+ new AssetsEvent(sendAssets)
)
- gatewayClient.sendMessage(SharedEvent.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
+ gatewayClient.sendMessage(EventRequestResponseWrapper.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
then: "the central manager should have added the first batch of assets under the gateway asset"
conditions.eventually {
@@ -319,10 +324,12 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
and: "the central manager should have requested the full loading of the second batch of assets"
conditions.eventually {
assert clientReceivedMessages.size() == 2
- assert clientReceivedMessages.get(1).startsWith(SharedEvent.MESSAGE_PREFIX)
+ assert clientReceivedMessages.get(1).startsWith(EventRequestResponseWrapper.MESSAGE_PREFIX)
assert clientReceivedMessages.get(1).contains("read-assets")
- readAssetsEvent = Container.JSON.readValue(clientReceivedMessages[1].substring(SharedEvent.MESSAGE_PREFIX.length()), ReadAssetsEvent.class)
- assert readAssetsEvent.messageId == GatewayConnector.ASSET_READ_EVENT_NAME_BATCH + GatewayConnector.SYNC_ASSET_BATCH_SIZE
+ def response = Container.JSON.readValue(clientReceivedMessages[1].substring(EventRequestResponseWrapper.MESSAGE_PREFIX.length()), EventRequestResponseWrapper.class)
+ messageId = response.messageId
+ readAssetsEvent = response.event as ReadAssetsEvent
+ assert messageId == GatewayConnector.ASSET_READ_EVENT_NAME_BATCH + GatewayConnector.SYNC_ASSET_BATCH_SIZE
assert readAssetsEvent.assetQuery != null
assert readAssetsEvent.assetQuery.select.excludePath
assert readAssetsEvent.assetQuery.select.excludeParentInfo
@@ -334,11 +341,10 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
when: "the gateway returns the requested assets"
sendAssets = []
sendAssets.addAll(Arrays.stream(readAssetsEvent.assetQuery.ids).map{id -> assets.stream().filter{asset -> asset.id == id}.findFirst().orElse(null)}.collect(Collectors.toList()))
- readAssetsReplyEvent = new AssetsEvent(
- readAssetsEvent.messageId,
- sendAssets
- )
- gatewayClient.sendMessage(SharedEvent.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
+ readAssetsReplyEvent = new EventRequestResponseWrapper(
+ messageId,
+ new AssetsEvent(sendAssets))
+ gatewayClient.sendMessage(EventRequestResponseWrapper.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
then: "the gateway asset status should become connected"
conditions.eventually {
@@ -508,9 +514,10 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
and: "an asset is deleted under the gateway in the local manager and the gateway responds that it successfully deleted the asset"
responseFuture.set(executorService.scheduleAtFixedRate({
if (!clientReceivedMessages.isEmpty()) {
- def deleteRequest = Container.JSON.readValue(clientReceivedMessages[0].substring(SharedEvent.MESSAGE_PREFIX.length()), DeleteAssetsRequestEvent.class)
+ def request = Container.JSON.readValue(clientReceivedMessages[0].substring(EventRequestResponseWrapper.MESSAGE_PREFIX.length()), EventRequestResponseWrapper.class)
+ def deleteRequest = request.event as DeleteAssetsRequestEvent
if (deleteRequest.assetIds.size() == 1 && deleteRequest.assetIds.get(0) == building1Room5AssetId) {
- gatewayClient.sendMessage(SharedEvent.MESSAGE_PREFIX + Container.JSON.writeValueAsString(new DeleteAssetsResponseEvent(deleteRequest.name, true)))
+ gatewayClient.sendMessage(EventRequestResponseWrapper.MESSAGE_PREFIX + Container.JSON.writeValueAsString(new EventRequestResponseWrapper(request.messageId, new DeleteAssetsResponseEvent(true, deleteRequest.assetIds))))
gatewayClient.sendMessage(SharedEvent.MESSAGE_PREFIX + Container.JSON.writeValueAsString(new AssetEvent(AssetEvent.Cause.DELETE, building1Room5Asset, null)))
responseFuture.get().cancel(false)
}
@@ -606,7 +613,7 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
and: "the local manager should have sent an asset read request"
conditions.eventually {
assert clientReceivedMessages.size() >= 1
- assert clientReceivedMessages[0].startsWith(SharedEvent.MESSAGE_PREFIX)
+ assert clientReceivedMessages[0].startsWith(EventRequestResponseWrapper.MESSAGE_PREFIX)
assert clientReceivedMessages[0].contains("read-assets")
}
@@ -617,19 +624,21 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
sendAssets = [building1Room5Asset]
sendAssets.addAll(agentAssets)
sendAssets.addAll(assets)
- readAssetsReplyEvent = new AssetsEvent(
+ readAssetsReplyEvent = new EventRequestResponseWrapper(
GatewayConnector.ASSET_READ_EVENT_NAME_INITIAL,
- sendAssets
+ new AssetsEvent(sendAssets)
)
- gatewayClient.sendMessage(SharedEvent.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
+ gatewayClient.sendMessage(EventRequestResponseWrapper.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
then: "the central manager should have requested the full loading of the first batch of assets"
conditions.eventually {
assert clientReceivedMessages.size() == 1
- assert clientReceivedMessages.get(0).startsWith(SharedEvent.MESSAGE_PREFIX)
+ assert clientReceivedMessages.get(0).startsWith(EventRequestResponseWrapper.MESSAGE_PREFIX)
assert clientReceivedMessages.get(0).contains("read-assets")
- readAssetsEvent = Container.JSON.readValue(clientReceivedMessages[0].substring(SharedEvent.MESSAGE_PREFIX.length()), ReadAssetsEvent.class)
- assert readAssetsEvent.messageId == GatewayConnector.ASSET_READ_EVENT_NAME_BATCH + "0"
+ def request = Container.JSON.readValue(clientReceivedMessages[0].substring(EventRequestResponseWrapper.MESSAGE_PREFIX.length()), EventRequestResponseWrapper.class)
+ messageId = request.messageId
+ readAssetsEvent = request.event as ReadAssetsEvent
+ assert messageId == GatewayConnector.ASSET_READ_EVENT_NAME_BATCH + "0"
assert readAssetsEvent.assetQuery != null
assert readAssetsEvent.assetQuery.select.excludePath
assert readAssetsEvent.assetQuery.select.excludeParentInfo
@@ -678,19 +687,18 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
sendAssets = [building1Room5Asset]
sendAssets.addAll(agentAssets)
sendAssets.addAll(Arrays.stream(readAssetsEvent.assetQuery.ids).filter{!agentAssetIds.contains(it) && it != removedAsset.id && it != building1Room5Asset.id}.map{id -> assets.stream().filter{asset -> asset.id == id}.findFirst().orElse(null)}.collect(Collectors.toList()))
- readAssetsReplyEvent = new AssetsEvent(
- readAssetsEvent.messageId,
- sendAssets
- )
- gatewayClient.sendMessage(SharedEvent.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
+ readAssetsReplyEvent = new EventRequestResponseWrapper(messageId, new AssetsEvent(sendAssets))
+ gatewayClient.sendMessage(EventRequestResponseWrapper.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
then: "the central manager should have requested the full loading of the second batch of assets"
conditions.eventually {
assert clientReceivedMessages.size() == 2
- assert clientReceivedMessages.get(1).startsWith(SharedEvent.MESSAGE_PREFIX)
+ assert clientReceivedMessages.get(1).startsWith(EventRequestResponseWrapper.MESSAGE_PREFIX)
assert clientReceivedMessages.get(1).contains("read-assets")
- readAssetsEvent = Container.JSON.readValue(clientReceivedMessages[1].substring(SharedEvent.MESSAGE_PREFIX.length()), ReadAssetsEvent.class)
- assert readAssetsEvent.messageId == GatewayConnector.ASSET_READ_EVENT_NAME_BATCH + (GatewayConnector.SYNC_ASSET_BATCH_SIZE - 1)
+ def request = Container.JSON.readValue(clientReceivedMessages[1].substring(EventRequestResponseWrapper.MESSAGE_PREFIX.length()), EventRequestResponseWrapper.class)
+ messageId = request.messageId
+ readAssetsEvent = request.event as ReadAssetsEvent
+ assert messageId == GatewayConnector.ASSET_READ_EVENT_NAME_BATCH + (GatewayConnector.SYNC_ASSET_BATCH_SIZE - 1)
assert readAssetsEvent.assetQuery != null
assert readAssetsEvent.assetQuery.select.excludePath
assert readAssetsEvent.assetQuery.select.excludeParentInfo
@@ -702,11 +710,8 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
when: "the gateway returns the requested assets"
sendAssets = []
sendAssets.addAll(Arrays.stream(readAssetsEvent.assetQuery.ids).map{id -> assets.stream().filter{asset -> asset.id == id}.findFirst().orElse(null)}.collect(Collectors.toList()))
- readAssetsReplyEvent = new AssetsEvent(
- readAssetsEvent.messageId,
- sendAssets
- )
- gatewayClient.sendMessage(SharedEvent.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
+ readAssetsReplyEvent = new EventRequestResponseWrapper(messageId, new AssetsEvent(sendAssets))
+ gatewayClient.sendMessage(EventRequestResponseWrapper.MESSAGE_PREFIX + Container.JSON.writeValueAsString(readAssetsReplyEvent))
then: "the gateway asset status should become connected"
conditions.eventually {
@@ -744,10 +749,18 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
Map<String, String> realIdToFakeIdMap = new HashMap<>()
Map<String, String> fakeIdToRealIdMap = new HashMap<>()
GatewayClientService spyGatewayClientService = Spy(GatewayClientService) {
- messageFromSharedEvent(_) >> {
- SharedEvent event ->
+ messageToString(_ as String, _ as Object) >> {
+ String prefix, Object ev ->
+ String messageId
+ Object event = ev
+
+ if (ev instanceof EventRequestResponseWrapper) {
+ messageId = ev.messageId
+ event = ev.event
+ }
+
if (event instanceof AssetsEvent) {
- if (GatewayConnector.ASSET_READ_EVENT_NAME_INITIAL.equals(event.getMessageId())) {
+ if (GatewayConnector.ASSET_READ_EVENT_NAME_INITIAL.equals(messageId)) {
// Store real IDs and map to a fake IDs
event.getAssets().forEach {
String oldId = it.id
@@ -778,12 +791,17 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
event.parentId = event.parentId == null ? null : realIdToFakeIdMap.get(event.parentId)
}
- return callRealMethodWithArgs(event)
+ return callRealMethodWithArgs(prefix, ev)
}
- messageToSharedEvent(_) >> {
- String message ->
- SharedEvent event = callRealMethod()
+ messageFromString(_ as String, _ as String, _ as Class) >> {
+ String message, String prefix, Class clazz ->
+ Object ev = callRealMethod()
+ Object event = ev
+
+ if (event instanceof EventRequestResponseWrapper) {
+ event = event.event
+ }
if (event instanceof ReadAssetsEvent) {
if (event.assetQuery.ids != null && event.assetQuery.ids.length > 0) {
event.assetQuery.ids(Arrays.stream(event.assetQuery.ids).map{fakeIdToRealIdMap.get(it)}.toArray{new String[it]})
@@ -810,7 +828,7 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
} else if (event instanceof DeleteAssetsRequestEvent) {
event.assetIds = event.assetIds.stream().map{fakeIdToRealIdMap.get(it)}.collect(Collectors.toList())
}
- return event
+ return ev
}
}
diff --git a/test/src/test/groovy/org/openremote/test/protocol/websocket/WebsocketClientProtocolTest.groovy b/test/src/test/groovy/org/openremote/test/protocol/websocket/WebsocketClientProtocolTest.groovy
index 1b0e6a57d..f2499575d 100644
--- a/test/src/test/groovy/org/openremote/test/protocol/websocket/WebsocketClientProtocolTest.groovy
+++ b/test/src/test/groovy/org/openremote/test/protocol/websocket/WebsocketClientProtocolTest.groovy
@@ -219,7 +219,7 @@ class WebsocketClientProtocolTest extends Specification implements ManagerContai
Values.convertToValue(
[
new WebsocketSubscription().body(SharedEvent.MESSAGE_PREFIX + Container.JSON.writeValueAsString(
- new ReadAssetAttributesEvent(managerDemoSetup.apartment1LivingroomId, "targetTemperature")
+ new ReadAssetAttributeEvent(managerDemoSetup.apartment1LivingroomId, "targetTemperature")
))
], Container.JSON.writer()).orElse(null))
),
@@ -247,7 +247,7 @@ class WebsocketClientProtocolTest extends Specification implements ManagerContai
Values.convertToValue(
[
new WebsocketSubscription().body(SharedEvent.MESSAGE_PREFIX + Container.JSON.writeValueAsString(
- new ReadAssetAttributesEvent(managerDemoSetup.apartment1LivingroomId, "co2Level")
+ new ReadAssetAttributeEvent(managerDemoSetup.apartment1LivingroomId, "co2Level")
))
]
, Container.JSON.writer()).orElse(null))