100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
Cleanup of IO protocol code
Rich Turner65a469045019
diff --git a/agent/src/main/java/org/openremote/agent/protocol/artnet/ArtnetProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/artnet/ArtnetProtocol.javaindex ed6307dd6..3de490643 100644--- a/agent/src/main/java/org/openremote/agent/protocol/artnet/ArtnetProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/artnet/ArtnetProtocol.java@@ -51,7 +51,7 @@ public class ArtnetProtocol extends AbstractNettyIOClientProtocol<ArtnetProtocolprotected Supplier<ChannelHandler[]> getEncoderDecoderProvider() {return () ->new ChannelHandler[] {- new AbstractNettyIOClient.MessageToByteEncoder<>(ArtnetPacket.class, client.ioClient, ArtnetPacket::toByteBuf)+ new AbstractNettyIOClient.MessageToByteEncoder<>(ArtnetPacket.class, client, ArtnetPacket::toByteBuf)};}diff --git a/agent/src/main/java/org/openremote/agent/protocol/io/AbstractIOClientProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/io/AbstractIOClientProtocol.javaindex 0fa10a6d8..a95a0106b 100644--- a/agent/src/main/java/org/openremote/agent/protocol/io/AbstractIOClientProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/io/AbstractIOClientProtocol.java@@ -125,7 +125,7 @@ public abstract class AbstractIOClientProtocol<T extends AbstractIOClientProtoco}public static final Logger LOG = SyslogCategory.getLogger(PROTOCOL, AbstractIOClientProtocol.class);- protected ProtocolIOClient<V, W> client;+ protected W client;protected AbstractIOClientProtocol(U agent) {super(agent);@@ -133,13 +133,16 @@ public abstract class AbstractIOClientProtocol<T extends AbstractIOClientProtoco@Overridepublic String getProtocolInstanceUri() {- return client != null ? client.ioClient.getClientUri() : "";+ return client != null ? client.getClientUri() : "";}@Overrideprotected void doStop(Container container) throws Exception {if (client != null) {LOG.fine("Stopping IO client for protocol: " + this);+ client.removeAllMessageConsumers();+ client.removeAllConnectionStatusConsumers();+ AbstractIOClientProtocol.LOG.info("Disconnecting IO client");client.disconnect();}client = null;@@ -149,7 +152,7 @@ public abstract class AbstractIOClientProtocol<T extends AbstractIOClientProtocoprotected void doStart(Container container) throws Exception {try {client = createIoClient();- LOG.fine("Created IO client '" + client.ioClient.getClientUri() + "' for protocol: " + this);+ LOG.fine("Created IO client '" + client.getClientUri() + "' for protocol: " + this);client.connect();} catch (Exception e) {LOG.log(Level.WARNING, "Failed to create IO client for protocol: " + this, e);@@ -167,18 +170,25 @@ public abstract class AbstractIOClientProtocol<T extends AbstractIOClientProtocoV message = createWriteMessage(attribute, agent.getAgentLink(attribute), event, processedValue);if (message == null) {- LOG.fine("No message produced for attribute event so not sending to IO client '" + client.ioClient.getClientUri() + "': " + event);+ LOG.fine("No message produced for attribute event so not sending to IO client '" + client.getClientUri() + "': " + event);return;}- client.send(message);+ AbstractIOClientProtocol.LOG.finer("Sending message to IO client: " + client.getClientUri());+ client.sendMessage(message);}- protected ProtocolIOClient<V, W> createIoClient() throws Exception {+ protected W createIoClient() throws Exception {W client = doCreateIoClient();- ProtocolIOClient<V, W> protocolIoClient = new ProtocolIOClient<>(client, this::onConnectionStatusChanged, this::onMessageReceived);- this.client = protocolIoClient;- return protocolIoClient;++ if (client == null) {+ throw new IllegalStateException("IO client for protocol should not be null");+ }++ client.addConnectionStatusConsumer(this::onConnectionStatusChanged);+ client.addMessageConsumer(this::onMessageReceived);+ this.client = client;+ return client;}/**diff --git a/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClientProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClientProtocol.javaindex 911969138..4bfe1aa87 100644--- a/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClientProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClientProtocol.java@@ -34,10 +34,10 @@ public abstract class AbstractNettyIOClientProtocol<T extends AbstractIOClientPr}@Override- protected ProtocolIOClient<V, W> createIoClient() throws Exception {- ProtocolIOClient<V, W> protocolIOClient = super.createIoClient();+ protected W createIoClient() throws Exception {+ W client = super.createIoClient();Supplier<ChannelHandler[]> encoderDecoderProvider = getEncoderDecoderProvider();- protocolIOClient.ioClient.setEncoderDecoderProvider(encoderDecoderProvider);+ client.setEncoderDecoderProvider(encoderDecoderProvider);return client;}diff --git a/agent/src/main/java/org/openremote/agent/protocol/io/ProtocolIOClient.java b/agent/src/main/java/org/openremote/agent/protocol/io/ProtocolIOClient.javadeleted file mode 100644index eeeb705e8..000000000--- a/agent/src/main/java/org/openremote/agent/protocol/io/ProtocolIOClient.java+++ /dev/null@@ -1,61 +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.agent.protocol.io;--import org.openremote.model.asset.agent.ConnectionStatus;--import java.util.function.Consumer;--public class ProtocolIOClient<W, X extends IOClient<W>> {- public X ioClient;- public Consumer<ConnectionStatus> connectionStatusConsumer;- public Consumer<W> messageConsumer;-- public ProtocolIOClient(X ioClient, Consumer<ConnectionStatus> connectionStatusConsumer, Consumer<W> messageConsumer) {- this.ioClient = ioClient;- this.connectionStatusConsumer = connectionStatusConsumer;- this.messageConsumer = messageConsumer;- }-- public void connect() {- if (connectionStatusConsumer != null) {- ioClient.addConnectionStatusConsumer(status -> connectionStatusConsumer.accept(status));- }-- if (messageConsumer != null) {- ioClient.addMessageConsumer(msg -> messageConsumer.accept(msg));- }-- AbstractIOClientProtocol.LOG.info("Connecting IO client");- ioClient.connect();- }-- public void disconnect() {- ioClient.removeAllMessageConsumers();- ioClient.removeAllConnectionStatusConsumers();- AbstractIOClientProtocol.LOG.info("Disconnecting IO client");- ioClient.disconnect();- }-- public synchronized void send(W message) {- AbstractIOClientProtocol.LOG.fine("Sending message to IO client: " + ioClient.getClientUri());- ioClient.sendMessage(message);- }-}diff --git a/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java b/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.javaindex 64d4e522a..9d02ff236 100644--- a/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java+++ b/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java@@ -231,6 +231,11 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<S}};+ if (this.connectionStatus != ConnectionStatus.CONNECTED) {+ // Just return true and let connection logic sort out actual subscription+ return true;+ }+try {Mqtt3SubAck subAck = client.subscribeWith().topicFilter(topic)diff --git a/agent/src/main/java/org/openremote/agent/protocol/mqtt/MQTTProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/mqtt/MQTTProtocol.javaindex 5f3ba81c9..34cd47582 100644--- a/agent/src/main/java/org/openremote/agent/protocol/mqtt/MQTTProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/mqtt/MQTTProtocol.java@@ -20,7 +20,6 @@package org.openremote.agent.protocol.mqtt;import org.apache.http.client.utils.URIBuilder;-import org.openremote.agent.protocol.io.ProtocolIOClient;import org.openremote.container.util.UniqueIdentifierGenerator;import org.openremote.model.attribute.Attribute;import org.openremote.model.attribute.AttributeEvent;@@ -54,7 +53,7 @@ public class MQTTProtocol extends AbstractMQTTClientProtocol<MQTTProtocol, MQTTAConsumer<MQTTMessage<String>> messageConsumer = msg -> updateLinkedAttribute(new AttributeState(assetId, attribute.getName(), msg.payload));- client.ioClient.addMessageConsumer(topic, messageConsumer);+ client.addMessageConsumer(topic, messageConsumer);protocolMessageConsumers.put(new AttributeRef(assetId, attribute.getName()), messageConsumer);});}@@ -65,20 +64,19 @@ public class MQTTProtocol extends AbstractMQTTClientProtocol<MQTTProtocol, MQTTAAttributeRef attributeRef = new AttributeRef(assetId, attribute.getName());Consumer<MQTTMessage<String>> messageConsumer = protocolMessageConsumers.remove(attributeRef);if (messageConsumer != null) {- client.ioClient.removeMessageConsumer(topic, messageConsumer);+ client.removeMessageConsumer(topic, messageConsumer);}});}@Override- protected ProtocolIOClient<MQTTMessage<String>, MQTT_IOClient> createIoClient() throws Exception {- MQTT_IOClient client = doCreateIoClient();- ProtocolIOClient<MQTTMessage<String>, MQTT_IOClient> protocolIoClient = new ProtocolIOClient<>(client, this::onConnectionStatusChanged, null);- this.client = protocolIoClient;- return protocolIoClient;+ protected MQTT_IOClient createIoClient() throws Exception {+ MQTT_IOClient client = super.createIoClient();+ // Don't want the default message consumer, topic specific consumers will do the message routing for us+ client.removeAllMessageConsumers();+ return client;}-@Overrideprotected MQTT_IOClient doCreateIoClient() throws Exception {String host = agent.getHost().orElse(null);diff --git a/agent/src/main/java/org/openremote/agent/protocol/serial/SerialProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/serial/SerialProtocol.javaindex 952b90d56..708083cba 100644--- a/agent/src/main/java/org/openremote/agent/protocol/serial/SerialProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/serial/SerialProtocol.java@@ -81,7 +81,7 @@ public class SerialProtocol extends AbstractSerialProtocol<SerialProtocol, Seria@Overrideprotected Supplier<ChannelHandler[]> getEncoderDecoderProvider() {- return getGenericStringEncodersAndDecoders(client.ioClient, agent);+ return getGenericStringEncodersAndDecoders(client, agent);}@Overridediff --git a/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPProtocol.javaindex b194ca15f..077fa19e0 100644--- a/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPProtocol.java@@ -81,7 +81,7 @@ public class TCPProtocol extends AbstractTCPClientProtocol<TCPProtocol, TCPAgent@Overrideprotected Supplier<ChannelHandler[]> getEncoderDecoderProvider() {- return getGenericStringEncodersAndDecoders(client.ioClient, agent);+ return getGenericStringEncodersAndDecoders(client, agent);}@Overridediff --git a/agent/src/main/java/org/openremote/agent/protocol/udp/UDPProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/udp/UDPProtocol.javaindex a70a698f5..537b4b19e 100644--- a/agent/src/main/java/org/openremote/agent/protocol/udp/UDPProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/udp/UDPProtocol.java@@ -81,7 +81,7 @@ public class UDPProtocol extends AbstractUDPProtocol<UDPProtocol, UDPAgent, Defa@Overrideprotected Supplier<ChannelHandler[]> getEncoderDecoderProvider() {- return getGenericStringEncodersAndDecoders(client.ioClient, agent);+ return getGenericStringEncodersAndDecoders(client, agent);}@Overridediff --git a/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.javaindex 679263129..c44e412b6 100644--- a/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.java@@ -104,7 +104,7 @@ public class WebsocketAgentProtocol extends AbstractNettyIOClientProtocol<Websoc@Overrideprotected Supplier<ChannelHandler[]> getEncoderDecoderProvider() {- return getGenericStringEncodersAndDecoders(client.ioClient, agent);+ return getGenericStringEncodersAndDecoders(client, agent);}@Override@@ -188,7 +188,7 @@ public class WebsocketAgentProtocol extends AbstractNettyIOClientProtocol<Websocsubscriptions.ifPresent(websocketSubscriptions -> {Runnable task = () -> doSubscriptions(clientHeaders, websocketSubscriptions);addAttributeConnectedTask(attributeRef, task);- if (client.ioClient.getConnectionStatus() == ConnectionStatus.CONNECTED) {+ if (client.getConnectionStatus() == ConnectionStatus.CONNECTED) {executorService.schedule(task, 1000, TimeUnit.MILLISECONDS);}});@@ -236,15 +236,15 @@ public class WebsocketAgentProtocol extends AbstractNettyIOClientProtocol<Websoc}protected void doSubscriptions(Map<String, List<String>> headers, WebsocketSubscription[] subscriptions) {- LOG.info("Executing subscriptions for websocket: " + client.ioClient.getClientUri());+ LOG.info("Executing subscriptions for websocket: " + client.getClientUri());// Inject OAuth header- if (!TextUtil.isNullOrEmpty(client.ioClient.authHeaderValue)) {+ if (!TextUtil.isNullOrEmpty(client.authHeaderValue)) {if (headers == null) {headers = new MultivaluedHashMap<>();}headers.remove(HttpHeaders.AUTHORIZATION);- headers.put(HttpHeaders.AUTHORIZATION, Collections.singletonList(client.ioClient.authHeaderValue));+ headers.put(HttpHeaders.AUTHORIZATION, Collections.singletonList(client.authHeaderValue));}Map<String, List<String>> finalHeaders = headers;@@ -315,7 +315,7 @@ public class WebsocketAgentProtocol extends AbstractNettyIOClientProtocol<WebsocLOG.warning("WebsocketHttpSubscription returned an un-successful response code: " + response.getStatus());}} else {- client.ioClient.sendMessage(ValueUtil.convert(subscription.body, String.class));+ client.sendMessage(ValueUtil.convert(subscription.body, String.class));}}}