Skip to content

armgit / core

Public Imported from GitHub
0

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

Minor protocol update

Rich Turner341318f837e5
diff --git a/agent/src/main/java/org/openremote/agent/protocol/AbstractProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/AbstractProtocol.java
index fd7fa1b18..63bc6d018 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/AbstractProtocol.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/AbstractProtocol.java
@@ -112,19 +112,12 @@ public abstract class AbstractProtocol implements Protocol {
protected final Map<AttributeRef, AssetAttribute> linkedAttributes = new HashMap<>();
protected final Map<AttributeRef, LinkedProtocolInfo> linkedProtocolConfigurations = new HashMap<>();
protected final Map<AttributeRef, ValueFilter[]> linkedAttributeFilters = new HashMap<>();
- protected static final List<MetaItemDescriptor> attributeMetaItemDescriptors;
protected MessageBrokerContext messageBrokerContext;
protected ProducerTemplate producerTemplate;
protected TimerService timerService;
protected ProtocolExecutorService executorService;
protected ProtocolAssetService assetService;
- static {
- attributeMetaItemDescriptors = Arrays.asList(
- MetaItemType.VALUE_FILTERS
- );
- }
-
@Override
public int getPriority() {
return PRIORITY;
@@ -420,7 +413,7 @@ public abstract class AbstractProtocol implements Protocol {
@Override
public AssetAttribute getProtocolConfigurationTemplate() {
- return ProtocolConfiguration.initProtocolConfiguration(new AssetAttribute(), getProtocolName());
+ return ProtocolConfiguration.initProtocolConfiguration(new AssetAttribute("protocolConfig"), getProtocolName());
}
@Override
@@ -466,9 +459,7 @@ public abstract class AbstractProtocol implements Protocol {
* Get list of {@link MetaItemDescriptor}s that describe the {@link MetaItem}s an {@link Attribute} linked to this
* protocol supports
*/
- protected List<MetaItemDescriptor> getLinkedAttributeMetaItemDescriptors() {
- return attributeMetaItemDescriptors;
- }
+ abstract protected List<MetaItemDescriptor> getLinkedAttributeMetaItemDescriptors();
/**
* Link the protocol configuration.
diff --git a/agent/src/main/java/org/openremote/agent/protocol/Protocol.java b/agent/src/main/java/org/openremote/agent/protocol/Protocol.java
index 62038c201..c85020629 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/Protocol.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/Protocol.java
@@ -22,6 +22,7 @@ package org.openremote.agent.protocol;
import org.apache.commons.codec.binary.BinaryCodec;
import org.apache.commons.codec.binary.Hex;
import org.openremote.agent.protocol.http.OAuthGrant;
+import org.openremote.agent.protocol.websocket.WebsocketClientProtocol;
import org.openremote.model.value.*;
import org.openremote.container.Container;
import org.openremote.container.ContainerService;
@@ -43,9 +44,12 @@ import java.util.function.Consumer;
import java.util.logging.Level;
import java.util.logging.Logger;
+import static org.openremote.agent.protocol.http.HttpClientProtocol.PROTOCOL_NAME;
import static org.openremote.model.Constants.PROTOCOL_NAMESPACE;
import static org.openremote.model.attribute.MetaItemDescriptor.Access.ACCESS_PRIVATE;
import static org.openremote.model.attribute.MetaItemDescriptorImpl.*;
+import static org.openremote.model.attribute.MetaItemDescriptorImpl.metaItemString;
+import static org.openremote.model.util.TextUtil.REGEXP_PATTERN_STRING_NON_EMPTY;
/**
* A protocol is a thread-safe singleton {@link ContainerService} that connects devices and
@@ -180,6 +184,27 @@ public interface Protocol extends ContainerService {
false,
null);
+
+ /**
+ * Basic authentication username (string)
+ */
+ MetaItemDescriptor META_PROTOCOL_USERNAME = metaItemString(
+ PROTOCOL_NAMESPACE + ":username",
+ ACCESS_PRIVATE,
+ false,
+ REGEXP_PATTERN_STRING_NON_EMPTY,
+ PatternFailure.STRING_EMPTY);
+
+ /**
+ * Basic authentication password (string)
+ */
+ MetaItemDescriptor META_PROTOCOL_PASSWORD = metaItemString(
+ PROTOCOL_NAMESPACE + ":password",
+ ACCESS_PRIVATE,
+ false,
+ REGEXP_PATTERN_STRING_NON_EMPTY,
+ PatternFailure.STRING_EMPTY);
+
/**
* Value to be used for attribute writes, protocols that support this should also support dynamic value insertion,
* see interface javadoc for more details; use the {@link #createDynamicAttributeWriteConsumer} helper method where
diff --git a/agent/src/main/java/org/openremote/agent/protocol/controller/ControllerProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/controller/ControllerProtocol.java
index 90298b4a0..fa36cc829 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/controller/ControllerProtocol.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/controller/ControllerProtocol.java
@@ -197,9 +197,7 @@ public class ControllerProtocol extends AbstractProtocol {
@Override
protected List<MetaItemDescriptor> getLinkedAttributeMetaItemDescriptors() {
- List<MetaItemDescriptor> descriptors = new ArrayList<>(super.getLinkedAttributeMetaItemDescriptors());
- descriptors.addAll(ATTRIBUTE_META_ITEM_DESCRIPTORS);
- return descriptors;
+ return new ArrayList<>(ATTRIBUTE_META_ITEM_DESCRIPTORS);
}
@Override
diff --git a/agent/src/main/java/org/openremote/agent/protocol/http/HttpClientProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/http/HttpClientProtocol.java
index 708ebaba0..ad5d1a6cf 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/http/HttpClientProtocol.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/http/HttpClientProtocol.java
@@ -90,13 +90,13 @@ import static org.openremote.model.util.TextUtil.REGEXP_PATTERN_STRING_NON_EMPTY
* the response received from this endpoint</b>)</li> <li>{@link #META_QUERY_PARAMETERS}</li>
* <li>{@link #META_FAILURE_CODES}</li>
* <li>{@link #META_HEADERS}</li>
- * <li>{@link MetaItemType#META_VALUE_FILTERS}</li>
+ * <li>{@link MetaItemType#VALUE_FILTERS}</li>
* </ul>
* <p>
* <h1>Response filtering</h1>
* <p>
* Any {@link Attribute} whose value is to be set by the HTTP server response (i.e. it has an {@link
- * #META_POLLING_MILLIS} {@link MetaItem}) can use the standard {@link MetaItemType#META_VALUE_FILTERS} in
+ * #META_POLLING_MILLIS} {@link MetaItem}) can use the standard {@link MetaItemType#VALUE_FILTERS} in
* order to filter the received HTTP response.
* <p>
* <h1>Connection Status</h1>
@@ -355,24 +355,6 @@ public class HttpClientProtocol extends AbstractProtocol {
REGEXP_PATTERN_STRING_NON_EMPTY,
MetaItemDescriptor.PatternFailure.STRING_EMPTY);
- /**
- * Basic authentication username (string)
- */
- public static final MetaItemDescriptor META_PROTOCOL_USERNAME = metaItemString(
- PROTOCOL_NAME + ":username",
- ACCESS_PRIVATE,
- false,
- REGEXP_PATTERN_STRING_NON_EMPTY);
- /**
- * Basic authentication password (string)
- */
- public static final MetaItemDescriptor META_PROTOCOL_PASSWORD = metaItemString(
- PROTOCOL_NAME + ":password",
- ACCESS_PRIVATE,
- false,
- REGEXP_PATTERN_STRING_NON_EMPTY,
- MetaItemDescriptor.PatternFailure.STRING_EMPTY);
-
/**
* Relative path to endpoint that should be used for connection status ping (string)
*/
@@ -1032,9 +1014,7 @@ public class HttpClientProtocol extends AbstractProtocol {
@Override
protected List<MetaItemDescriptor> getLinkedAttributeMetaItemDescriptors() {
- List<MetaItemDescriptor> descriptors = new ArrayList<>(super.getLinkedAttributeMetaItemDescriptors());
- descriptors.addAll(ATTRIBUTE_META_ITEM_DESCRIPTORS);
- return descriptors;
+ return new ArrayList<>(ATTRIBUTE_META_ITEM_DESCRIPTORS);
}
@Override
diff --git a/agent/src/main/java/org/openremote/agent/protocol/knx/KNXProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/knx/KNXProtocol.java
index 04d2e1a00..75f521f3f 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/knx/KNXProtocol.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/knx/KNXProtocol.java
@@ -199,9 +199,7 @@ public class KNXProtocol extends AbstractProtocol implements ProtocolLinkedAttri
@Override
protected List<MetaItemDescriptor> getLinkedAttributeMetaItemDescriptors() {
- List<MetaItemDescriptor> descriptors = new ArrayList<>(super.getLinkedAttributeMetaItemDescriptors());
- descriptors.addAll(ATTRIBUTE_META_ITEM_DESCRIPTORS);
- return descriptors;
+ return new ArrayList<>(ATTRIBUTE_META_ITEM_DESCRIPTORS);
}
@Override
diff --git a/agent/src/main/java/org/openremote/agent/protocol/macro/MacroProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/macro/MacroProtocol.java
index 3cff9b6f7..5d58acd85 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/macro/MacroProtocol.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/macro/MacroProtocol.java
@@ -173,9 +173,7 @@ public class MacroProtocol extends AbstractProtocol {
@Override
protected List<MetaItemDescriptor> getLinkedAttributeMetaItemDescriptors() {
- List<MetaItemDescriptor> descriptors = new ArrayList<>(super.getLinkedAttributeMetaItemDescriptors());
- descriptors.addAll(ATTRIBUTE_META_ITEM_DESCRIPTORS);
- return descriptors;
+ return new ArrayList<>(ATTRIBUTE_META_ITEM_DESCRIPTORS);
}
@Override
diff --git a/agent/src/main/java/org/openremote/agent/protocol/simulator/SimulatorProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/simulator/SimulatorProtocol.java
index d9a53c9c4..ebfc5d35c 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/simulator/SimulatorProtocol.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/simulator/SimulatorProtocol.java
@@ -190,9 +190,7 @@ public class SimulatorProtocol extends AbstractProtocol {
@Override
protected List<MetaItemDescriptor> getLinkedAttributeMetaItemDescriptors() {
- List<MetaItemDescriptor> descriptors = new ArrayList<>(super.getLinkedAttributeMetaItemDescriptors());
- descriptors.addAll(ATTRIBUTE_META_ITEM_DESCRIPTORS);
- return descriptors;
+ return new ArrayList<>(ATTRIBUTE_META_ITEM_DESCRIPTORS);
}
@Override
diff --git a/agent/src/main/java/org/openremote/agent/protocol/timer/TimerProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/timer/TimerProtocol.java
index d3f496539..024e52cdc 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/timer/TimerProtocol.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/timer/TimerProtocol.java
@@ -141,9 +141,7 @@ public class TimerProtocol extends AbstractProtocol {
@Override
protected List<MetaItemDescriptor> getLinkedAttributeMetaItemDescriptors() {
- List<MetaItemDescriptor> descriptors = new ArrayList<>(super.getLinkedAttributeMetaItemDescriptors());
- descriptors.addAll(ATTRIBUTE_META_ITEM_DESCRIPTORS);
- return descriptors;
+ return new ArrayList<>(ATTRIBUTE_META_ITEM_DESCRIPTORS);
}
@Override
diff --git a/agent/src/main/java/org/openremote/agent/protocol/udp/UdpClientProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/udp/UdpClientProtocol.java
index 0641e54ba..edc7c6d34 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/udp/UdpClientProtocol.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/udp/UdpClientProtocol.java
@@ -271,7 +271,6 @@ public class UdpClientProtocol extends AbstractProtocol {
public static final List<MetaItemDescriptor> ATTRIBUTE_META_ITEM_DESCRIPTORS = Arrays.asList(
META_ATTRIBUTE_WRITE_VALUE,
- MetaItemType.VALUE_FILTERS,
META_POLLING_MILLIS,
META_RESPONSE_TIMEOUT_MILLIS,
META_SEND_RETRIES,
diff --git a/agent/src/main/java/org/openremote/agent/protocol/velbus/AbstractVelbusProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/velbus/AbstractVelbusProtocol.java
index cc3542ced..ed84ac0ae 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/velbus/AbstractVelbusProtocol.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/velbus/AbstractVelbusProtocol.java
@@ -118,9 +118,7 @@ public abstract class AbstractVelbusProtocol extends AbstractProtocol implements
@Override
protected List<MetaItemDescriptor> getLinkedAttributeMetaItemDescriptors() {
- List<MetaItemDescriptor> descriptors = new ArrayList<>(super.getLinkedAttributeMetaItemDescriptors());
- descriptors.addAll(ATTRIBUTE_META_ITEM_DESCRIPTORS);
- return descriptors;
+ return new ArrayList<>(ATTRIBUTE_META_ITEM_DESCRIPTORS);
}
@Override
diff --git a/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketClientProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketClientProtocol.java
index fcb7b4f4a..62528b37e 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketClientProtocol.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketClientProtocol.java
@@ -124,26 +124,6 @@ public class WebsocketClientProtocol extends AbstractProtocol {
PatternFailure.STRING_EMPTY
);
- /**
- * Basic authentication username (string)
- */
- public static final MetaItemDescriptor META_PROTOCOL_USERNAME = metaItemString(
- PROTOCOL_NAME + ":username",
- ACCESS_PRIVATE,
- false,
- REGEXP_PATTERN_STRING_NON_EMPTY,
- PatternFailure.STRING_EMPTY);
-
- /**
- * Basic authentication password (string)
- */
- public static final MetaItemDescriptor META_PROTOCOL_PASSWORD = metaItemString(
- PROTOCOL_NAME + ":password",
- ACCESS_PRIVATE,
- false,
- REGEXP_PATTERN_STRING_NON_EMPTY,
- PatternFailure.STRING_EMPTY);
-
/**
* Headers for websocket connect call (see {@link HttpClientProtocol#META_HEADERS} for details)
*/
@@ -193,7 +173,8 @@ public class WebsocketClientProtocol extends AbstractProtocol {
public static final List<MetaItemDescriptor> ATTRIBUTE_META_ITEM_DESCRIPTORS = Arrays.asList(
META_ATTRIBUTE_MESSAGE_MATCH_FILTERS,
META_ATTRIBUTE_MESSAGE_MATCH_PREDICATE,
- META_ATTRIBUTE_WRITE_VALUE);
+ META_ATTRIBUTE_WRITE_VALUE,
+ META_SUBSCRIPTIONS);
public static final List<MetaItemDescriptor> PROTOCOL_META_ITEM_DESCRIPTORS = Arrays.asList(
META_PROTOCOL_CONNECT_URI,
@@ -203,6 +184,7 @@ public class WebsocketClientProtocol extends AbstractProtocol {
META_PROTOCOL_OAUTH_GRANT,
META_SUBSCRIPTIONS);
+ public static final int CONNECTED_SEND_DELAY_MILLIS = 2000;
protected ResteasyClient client;
protected Map<AttributeRef, WebsocketClient> websocketClients = new HashMap<>();
protected Map<AttributeRef, List<Pair<AttributeRef, Consumer<String>>>> protocolMessageConsumers = new HashMap<>();
@@ -490,9 +472,7 @@ public class WebsocketClientProtocol extends AbstractProtocol {
@Override
protected List<MetaItemDescriptor> getLinkedAttributeMetaItemDescriptors() {
- List<MetaItemDescriptor> descriptors = new ArrayList<>(super.getLinkedAttributeMetaItemDescriptors());
- descriptors.addAll(ATTRIBUTE_META_ITEM_DESCRIPTORS);
- return descriptors;
+ return new ArrayList<>(ATTRIBUTE_META_ITEM_DESCRIPTORS);
}
@Override
@@ -542,7 +522,7 @@ public class WebsocketClientProtocol extends AbstractProtocol {
}
if (connectedTasks != null) {
// Execute after a delay to ensure connection is properly initialised
- executorService.schedule(() -> connectedTasks.forEach(Runnable::run), 500);
+ executorService.schedule(() -> connectedTasks.forEach(Runnable::run), CONNECTED_SEND_DELAY_MILLIS);
}
}
}
diff --git a/manager/src/main/java/org/openremote/manager/setup/builtin/ManagerDemoSetup.java b/manager/src/main/java/org/openremote/manager/setup/builtin/ManagerDemoSetup.java
index 02433542d..3c354495c 100644
--- a/manager/src/main/java/org/openremote/manager/setup/builtin/ManagerDemoSetup.java
+++ b/manager/src/main/java/org/openremote/manager/setup/builtin/ManagerDemoSetup.java
@@ -22,6 +22,7 @@ package org.openremote.manager.setup.builtin;
import org.apache.commons.io.IOUtils;
import org.openremote.agent.protocol.simulator.SimulatorProtocol;
import org.openremote.container.Container;
+import org.openremote.container.util.UniqueIdentifierGenerator;
import org.openremote.manager.security.UserConfiguration;
import org.openremote.manager.setup.AbstractManagerSetup;
import org.openremote.model.asset.Asset;
@@ -78,7 +79,7 @@ public class ManagerDemoSetup extends AbstractManagerSetup {
public String smartBuildingId;
public String apartment1Id;
public String apartment1ServiceAgentId;
- public String apartment1LivingroomId;
+ public String apartment1LivingroomId = UniqueIdentifierGenerator.generateId("apartment1LivingroomId");
public String apartment1KitchenId;
public String apartment1HallwayId;
public String apartment1Bedroom1Id;
@@ -469,6 +470,7 @@ public class ManagerDemoSetup extends AbstractManagerSetup {
new MetaItem(SimulatorProtocol.SIMULATOR_ELEMENT, Values.create(NumberSimulatorElement.ELEMENT_NAME))
});
+ apartment1Livingroom.setId(apartment1LivingroomId);
apartment1Livingroom = assetStorageService.merge(apartment1Livingroom);
apartment1LivingroomId = apartment1Livingroom.getId();
diff --git a/test/src/main/groovy/org/openremote/test/protocol/http/TestHttpServerProtocol.java b/test/src/main/groovy/org/openremote/test/protocol/http/TestHttpServerProtocol.java
index 49171c7f5..63bbacee1 100644
--- a/test/src/main/groovy/org/openremote/test/protocol/http/TestHttpServerProtocol.java
+++ b/test/src/main/groovy/org/openremote/test/protocol/http/TestHttpServerProtocol.java
@@ -46,7 +46,7 @@ public class TestHttpServerProtocol extends AbstractHttpServerProtocol {
@Override
protected List<MetaItemDescriptor> getLinkedAttributeMetaItemDescriptors() {
- return super.getLinkedAttributeMetaItemDescriptors();
+ return Collections.emptyList();
}
@Override