Skip to content

armgit / core

Public Imported from GitHub
0

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

GatewayClient updates (added GatewayConnectionStatusEvent)

Rich Turner16ff36f4dd82
diff --git a/manager/src/main/java/org/openremote/manager/event/EventSubscriptions.java b/manager/src/main/java/org/openremote/manager/event/EventSubscriptions.java
index bd73eaeec..4b384f365 100644
--- a/manager/src/main/java/org/openremote/manager/event/EventSubscriptions.java
+++ b/manager/src/main/java/org/openremote/manager/event/EventSubscriptions.java
@@ -200,7 +200,7 @@ public class EventSubscriptions {
|| sessionSubscription.subscription.getFilter().apply(event)) {
LOG.fine("Creating message for subscribed session '" + sessionKey + "': " + event);
List<SharedEvent> events = Collections.singletonList(event);
- TriggeredEventSubscription triggeredEventSubscription = new TriggeredEventSubscription(events, sessionSubscription.subscriptionId);
+ TriggeredEventSubscription<?> triggeredEventSubscription = new TriggeredEventSubscription<>(events, sessionSubscription.subscriptionId);
if (sessionSubscription.subscription.getInternalConsumer() == null) {
Message msg = new DefaultMessage();
diff --git a/manager/src/main/java/org/openremote/manager/gateway/GatewayClientResourceImpl.java b/manager/src/main/java/org/openremote/manager/gateway/GatewayClientResourceImpl.java
index 589f7a07d..056bbd2eb 100644
--- a/manager/src/main/java/org/openremote/manager/gateway/GatewayClientResourceImpl.java
+++ b/manager/src/main/java/org/openremote/manager/gateway/GatewayClientResourceImpl.java
@@ -19,9 +19,11 @@
*/
package org.openremote.manager.gateway;
+import org.openremote.agent.protocol.websocket.WebsocketIoClient;
import org.openremote.container.timer.TimerService;
import org.openremote.manager.security.ManagerIdentityService;
import org.openremote.manager.web.ManagerWebResource;
+import org.openremote.model.asset.agent.ConnectionStatus;
import org.openremote.model.gateway.GatewayConnection;
import org.openremote.model.gateway.GatewayClientResource;
import org.openremote.model.http.RequestParams;
@@ -57,6 +59,15 @@ public class GatewayClientResourceImpl extends ManagerWebResource implements Gat
}
}
+ @Override
+ public ConnectionStatus getConnectionStatus(RequestParams requestParams, String realm) {
+ if (!realm.equals(getAuthenticatedRealm()) && !isSuperUser()) {
+ throw new WebApplicationException(FORBIDDEN);
+ }
+
+ return gatewayClientService.getConnectionStatus(realm);
+ }
+
@Override
public List<GatewayConnection> getConnections(RequestParams requestParams) {
if (!isSuperUser()) {
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 29891319f..83ce646b8 100644
--- a/manager/src/main/java/org/openremote/manager/gateway/GatewayClientService.java
+++ b/manager/src/main/java/org/openremote/manager/gateway/GatewayClientService.java
@@ -42,10 +42,12 @@ import org.openremote.model.asset.agent.ConnectionStatus;
import org.openremote.model.attribute.AttributeEvent;
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.GatewayDisconnectEvent;
+import org.openremote.model.gateway.GatewayConnectionStatusEvent;
import org.openremote.model.query.AssetQuery;
import org.openremote.model.query.filter.TenantPredicate;
+import org.openremote.model.syslog.SyslogEvent;
import java.util.*;
import java.util.logging.Level;
@@ -92,6 +94,21 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
);
container.getService(MessageBrokerService.class).getContext().addRoutes(this);
+
+ clientEventService.addSubscriptionAuthorizer((authContext, eventSubscription) -> {
+ if (!eventSubscription.isEventType(GatewayConnectionStatusEvent.class)) {
+ return false;
+ }
+
+ // If not a super user force a filter for the users realm
+ if (!authContext.isSuperUser()) {
+ @SuppressWarnings("unchecked")
+ EventSubscription<GatewayConnectionStatusEvent> subscription = (EventSubscription<GatewayConnectionStatusEvent>) eventSubscription;
+ subscription.setFilter(new TenantFilter<>(authContext.getAuthenticatedRealm()));
+ }
+
+ return true;
+ });
}
@Override
@@ -150,7 +167,9 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
}
case CREATE:
connectionRealmMap.put(connection.getLocalRealm(), connection);
- clientRealmMap.put(connection.getLocalRealm(), createGatewayClient(connection));
+ if (!connection.isDisabled()) {
+ clientRealmMap.put(connection.getLocalRealm(), createGatewayClient(connection));
+ }
break;
case DELETE:
connectionRealmMap.remove(connection.getLocalRealm());
@@ -242,6 +261,8 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
LOG.info("Destroying gateway IO client: " + connection);
try {
client.disconnect();
+ client.removeAllConnectionStatusConsumers();
+ client.removeAllMessageConsumers();
} catch (Exception e) {
LOG.log(Level.WARNING, "An exception occurred whilst trying to disconnect the gateway IO client", e);
}
@@ -250,6 +271,7 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
protected void onGatewayClientConnectionStatusChanged(GatewayConnection connection, ConnectionStatus connectionStatus) {
LOG.info("Connection status change for gateway IO client '" + connectionStatus + "': " + connection);
+ clientEventService.publishEvent(new GatewayConnectionStatusEvent(timerService.getCurrentTimeMillis(), connection.getLocalRealm(), connectionStatus));
}
protected void onCentralManagerMessage(GatewayConnection connection, String message) {
@@ -359,4 +381,19 @@ public class GatewayClientService extends RouteBuilder implements ContainerServi
return true;
}
+
+ protected ConnectionStatus getConnectionStatus(String realm) {
+ GatewayConnection connection = connectionRealmMap.get(realm);
+
+ if (connection == null) {
+ return null;
+ }
+
+ if (connection.isDisabled()) {
+ return ConnectionStatus.DISABLED;
+ }
+
+ WebsocketIoClient<String> client = clientRealmMap.get(realm);
+ return client != null ? client.getConnectionStatus() : null;
+ }
}
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 f72acae76..c3cf891fb 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
@@ -25,6 +25,7 @@ import org.openremote.model.asset.*;
import org.openremote.model.asset.agent.AgentStatusEvent;
import org.openremote.model.attribute.AttributeEvent;
import org.openremote.model.event.Event;
+import org.openremote.model.gateway.GatewayConnectionStatusEvent;
import org.openremote.model.gateway.GatewayDisconnectEvent;
import org.openremote.model.rules.RulesEngineStatusEvent;
import org.openremote.model.rules.RulesetChangedEvent;
@@ -51,6 +52,7 @@ import org.openremote.model.syslog.SyslogEvent;
@JsonSubTypes.Type(value = RulesEngineStatusEvent.class, name = "rules-engine-status"),
@JsonSubTypes.Type(value = RulesetChangedEvent.class, name = "ruleset-changed"),
@JsonSubTypes.Type(value = GatewayDisconnectEvent.class, name = "gateway-disconnect"),
+ @JsonSubTypes.Type(value = GatewayConnectionStatusEvent.class, name = "gateway-connection-status"),
@JsonSubTypes.Type(value = DeleteAssetsRequestEvent.class, name = "delete-assets-request"),
@JsonSubTypes.Type(value = DeleteAssetsResponseEvent.class, name = "delete-assets-response")
})
diff --git a/model/src/main/java/org/openremote/model/gateway/GatewayClientResource.java b/model/src/main/java/org/openremote/model/gateway/GatewayClientResource.java
index cbca4dc3a..b272bbd87 100644
--- a/model/src/main/java/org/openremote/model/gateway/GatewayClientResource.java
+++ b/model/src/main/java/org/openremote/model/gateway/GatewayClientResource.java
@@ -21,6 +21,7 @@ package org.openremote.model.gateway;
import jsinterop.annotations.JsType;
import org.openremote.model.Constants;
+import org.openremote.model.asset.agent.ConnectionStatus;
import org.openremote.model.http.RequestParams;
import org.openremote.model.http.SuccessStatusCode;
@@ -46,9 +47,16 @@ public interface GatewayClientResource {
@Path("connection/{realm}")
@Produces(APPLICATION_JSON)
@SuccessStatusCode(200)
- @RolesAllowed({Constants.WRITE_ADMIN_ROLE})
+ @RolesAllowed({Constants.READ_ADMIN_ROLE})
GatewayConnection getConnection(@BeanParam RequestParams requestParams, @PathParam("realm") String realm);
+ @GET
+ @Path("status/{realm}")
+ @Produces(APPLICATION_JSON)
+ @SuccessStatusCode(200)
+ @RolesAllowed({Constants.READ_ADMIN_ROLE})
+ ConnectionStatus getConnectionStatus(@BeanParam RequestParams requestParams, @PathParam("realm") String realm);
+
/**
* Get the {@link GatewayConnection}s for all realms, user must be a super user
*/
@@ -56,7 +64,7 @@ public interface GatewayClientResource {
@Path("connection")
@Produces(APPLICATION_JSON)
@SuccessStatusCode(200)
- @RolesAllowed({Constants.WRITE_ADMIN_ROLE})
+ @RolesAllowed({Constants.READ_ADMIN_ROLE})
List<GatewayConnection> getConnections(@BeanParam RequestParams requestParams);
/**
diff --git a/model/src/main/java/org/openremote/model/gateway/GatewayConnectionStatusEvent.java b/model/src/main/java/org/openremote/model/gateway/GatewayConnectionStatusEvent.java
new file mode 100644
index 000000000..95b7b168a
--- /dev/null
+++ b/model/src/main/java/org/openremote/model/gateway/GatewayConnectionStatusEvent.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright 2017, 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.gateway;
+
+import org.openremote.model.asset.agent.ConnectionStatus;
+import org.openremote.model.attribute.AttributeRef;
+import org.openremote.model.event.shared.TenantScopedEvent;
+
+/**
+ * Published by the server when a {@link GatewayConnection} status changes.
+ */
+public class GatewayConnectionStatusEvent extends TenantScopedEvent {
+
+ protected ConnectionStatus connectionStatus;
+
+ protected GatewayConnectionStatusEvent() {
+ }
+
+ public GatewayConnectionStatusEvent(long timestamp, String realm, ConnectionStatus connectionStatus) {
+ super(timestamp, realm);
+ this.connectionStatus = connectionStatus;
+ }
+
+ public ConnectionStatus getConnectionStatus() {
+ return connectionStatus;
+ }
+
+ @Override
+ public String toString() {
+ return getClass().getSimpleName() + "{" +
+ "realm=" + realm +
+ ", connectionStatus=" + connectionStatus +
+ '}';
+ }
+}