Merge pull request #523 from gathanase/snapshot

Snapshot

distribution/features/northbound-rest-feature/pom.xml

@@ -26,6 +26,16 @@
       <artifactId>filters.core</artifactId>
       <version>${rest.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.eclipse.sensinact.gateway.filters</groupId>
+      <artifactId>resource.selector</artifactId>
+      <version>${rest.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.eclipse.sensinact.gateway.filters</groupId>
+      <artifactId>resource.selector.impl</artifactId>
+      <version>${rest.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.antlr</groupId>
       <artifactId>antlr4-runtime</artifactId>

distribution/features/northbound-rest-feature/src/main/resources/northbound-rest-feature.json

@@ -3,6 +3,8 @@
   "bundles":[
     { "id": "org.eclipse.sensinact.gateway.northbound:rest:${gateway.version}" },
     { "id": "org.eclipse.sensinact.gateway.filters:filters.core:${gateway.version}" },
+    { "id": "org.eclipse.sensinact.gateway.filters:resource.selector:${gateway.version}" },
+    { "id": "org.eclipse.sensinact.gateway.filters:resource.selector.impl:${gateway.version}" },
     { "id": "org.antlr:antlr4-runtime:4.12.0" },
     { "id": "org.eclipse.sensinact.gateway.filters:ldap:${gateway.version}" },
     { "id": "org.eclipse.sensinact.gateway.northbound:query-handler:${gateway.version}" },

northbound/query-handler/integration-test.bndrun

@@ -42,6 +42,8 @@
 	org.eclipse.sensinact.gateway.core.models.metadata;version='[0.0.2,0.0.3)',\
 	org.eclipse.sensinact.gateway.core.models.provider;version='[0.0.2,0.0.3)',\
 	org.eclipse.sensinact.gateway.filters.filters.core;version='[0.0.2,0.0.3)',\
+	org.eclipse.sensinact.gateway.filters.resource.selector;version='[0.0.2,0.0.3)',\
+	org.eclipse.sensinact.gateway.filters.resource.selector.impl;version='[0.0.2,0.0.3)',\
 	org.eclipse.sensinact.gateway.northbound.query-handler;version='[0.0.2,0.0.3)',\
 	org.eclipse.sensinact.gateway.northbound.query-handler-tests;version='[0.0.2,0.0.3)',\
 	org.eclipse.sensinact.gateway.northbound.security.security-api;version='[0.0.2,0.0.3)',\

northbound/query-handler/pom.xml

@@ -42,6 +42,11 @@
       <artifactId>filters.core</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.eclipse.sensinact.gateway.filters</groupId>
+      <artifactId>resource.selector</artifactId>
+      <version>${project.version}</version>
+    </dependency>
 
     <!-- SL4J -->
     <dependency>
@@ -81,6 +86,12 @@
       <version>${project.version}</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.eclipse.sensinact.gateway.filters</groupId>
+      <artifactId>resource.selector.impl</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
 
     <!-- OSGi -->
     <dependency>

northbound/query-handler/src/main/java/org/eclipse/sensinact/northbound/query/api/AbstractResultDTO.java

@@ -14,6 +14,7 @@
 
 import org.eclipse.sensinact.northbound.query.dto.notification.ResultResourceNotificationDTO;
 import org.eclipse.sensinact.northbound.query.dto.result.ErrorResultDTO;
+import org.eclipse.sensinact.northbound.query.dto.result.ResponseSnapshotDTO;
 import org.eclipse.sensinact.northbound.query.dto.result.ResultActDTO;
 import org.eclipse.sensinact.northbound.query.dto.result.ResultDescribeProvidersDTO;
 import org.eclipse.sensinact.northbound.query.dto.result.ResultListProvidersDTO;
@@ -40,6 +41,7 @@
         @Type(value = ResultListProvidersDTO.class, name = "PROVIDERS_LIST"),
         @Type(value = ResultListServicesDTO.class, name = "SERVICES_LIST"),
         @Type(value = ResultListResourcesDTO.class, name = "RESOURCES_LIST"),
+        @Type(value = ResponseSnapshotDTO.class, name = "SNAPSHOT_RESPONSE"),
         @Type(value = TypedResponse.class, names = { "DESCRIBE_PROVIDER", "DESCRIBE_SERVICE", "DESCRIBE_RESOURCE",
                 "GET_RESPONSE", "SET_RESPONSE" }),
         @Type(value = ResultActDTO.class, name = "ACT_RESPONSE"),

northbound/query-handler/src/main/java/org/eclipse/sensinact/northbound/query/api/EQueryType.java

@@ -38,6 +38,11 @@ public enum EQueryType {
      */
     SET,
 
+    /**
+     * Get a snapshot
+     */
+    GET_SNAPSHOT,
+
     /**
      * Acts on a resource (path must describe a unique resource)
      */

northbound/query-handler/src/main/java/org/eclipse/sensinact/northbound/query/api/EResultType.java

@@ -22,6 +22,7 @@ public enum EResultType {
     PROVIDERS_LIST,
     SERVICES_LIST,
     RESOURCES_LIST,
+    SNAPSHOT_RESPONSE,
     DESCRIBE_PROVIDER,
     DESCRIBE_SERVICE,
     DESCRIBE_RESOURCE,

northbound/query-handler/src/main/java/org/eclipse/sensinact/northbound/query/dto/query/QuerySnapshotDTO.java

@@ -0,0 +1,36 @@
+/*********************************************************************
+* Copyright (c) 2023 Contributors to the Eclipse Foundation.
+*
+* This program and the accompanying materials are made
+* available under the terms of the Eclipse Public License 2.0
+* which is available at https://www.eclipse.org/legal/epl-2.0/
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Contributors:
+*   Kentyou - initial implementation
+**********************************************************************/
+package org.eclipse.sensinact.northbound.query.dto.query;
+
+import java.util.List;
+
+import org.eclipse.sensinact.filters.resource.selector.api.ResourceSelector;
+import org.eclipse.sensinact.northbound.query.api.AbstractQueryDTO;
+import org.eclipse.sensinact.northbound.query.api.EQueryType;
+
+/**
+ *
+ */
+public class QuerySnapshotDTO extends AbstractQueryDTO {
+
+    /**
+     * If set, include metadata in the result
+     */
+    public boolean includeMetadata = false;
+
+    public List<ResourceSelector> filter;
+
+    public QuerySnapshotDTO() {
+        super(EQueryType.GET_SNAPSHOT);
+    }
+}

northbound/query-handler/src/main/java/org/eclipse/sensinact/northbound/query/dto/result/ResponseSnapshotDTO.java

@@ -0,0 +1,28 @@
+/*********************************************************************
+* Copyright (c) 2023 Contributors to the Eclipse Foundation.
+*
+* This program and the accompanying materials are made
+* available under the terms of the Eclipse Public License 2.0
+* which is available at https://www.eclipse.org/legal/epl-2.0/
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Contributors:
+*   Kentyou - initial implementation
+**********************************************************************/
+package org.eclipse.sensinact.northbound.query.dto.result;
+
+import java.util.Map;
+
+import org.eclipse.sensinact.northbound.query.api.AbstractResultDTO;
+import org.eclipse.sensinact.northbound.query.api.EResultType;
+
+
+public class ResponseSnapshotDTO extends AbstractResultDTO {
+
+    public Map<String, SnapshotProviderDTO> providers;
+
+    public ResponseSnapshotDTO() {
+        super(EResultType.SNAPSHOT_RESPONSE);
+    }
+}

northbound/query-handler/src/main/java/org/eclipse/sensinact/northbound/query/dto/result/SnapshotProviderDTO.java

@@ -0,0 +1,33 @@
+/*********************************************************************
+* Copyright (c) 2022 Contributors to the Eclipse Foundation.
+*
+* This program and the accompanying materials are made
+* available under the terms of the Eclipse Public License 2.0
+* which is available at https://www.eclipse.org/legal/epl-2.0/
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Contributors:
+*   Kentyou - initial implementation
+**********************************************************************/
+package org.eclipse.sensinact.northbound.query.dto.result;
+
+import java.util.Map;
+
+public class SnapshotProviderDTO {
+
+    /**
+     * Provider ID
+     */
+    public String name;
+
+    /**
+     * Model Name
+     */
+    public String modelName;
+
+    /**
+     * List of services
+     */
+    public Map<String, SnapshotServiceDTO> services;
+}

northbound/query-handler/src/main/java/org/eclipse/sensinact/northbound/query/dto/result/SnapshotResourceDTO.java

@@ -0,0 +1,47 @@
+/*********************************************************************
+* Copyright (c) 2023 Contributors to the Eclipse Foundation.
+*
+* This program and the accompanying materials are made
+* available under the terms of the Eclipse Public License 2.0
+* which is available at https://www.eclipse.org/legal/epl-2.0/
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Contributors:
+*   Kentyou - initial implementation
+**********************************************************************/
+package org.eclipse.sensinact.northbound.query.dto.result;
+
+import java.util.List;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+
+public class SnapshotResourceDTO {
+
+    /**
+     * Resource ID
+     */
+    public String name;
+
+    /**
+     * Value milliseconds timestamp
+     */
+    public long timestamp;
+
+    /**
+     * Value type
+     */
+    public String type;
+
+    /**
+     * Value value
+     */
+    public Object value;
+
+    /**
+     * Metadata, if requested
+     */
+    @JsonInclude(Include.NON_NULL)
+    public List<MetadataDTO> attributes;
+}

northbound/query-handler/src/main/java/org/eclipse/sensinact/northbound/query/dto/result/SnapshotServiceDTO.java

@@ -0,0 +1,28 @@
+/*********************************************************************
+* Copyright (c) 2022 Contributors to the Eclipse Foundation.
+*
+* This program and the accompanying materials are made
+* available under the terms of the Eclipse Public License 2.0
+* which is available at https://www.eclipse.org/legal/epl-2.0/
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Contributors:
+*   Kentyou - initial implementation
+**********************************************************************/
+package org.eclipse.sensinact.northbound.query.dto.result;
+
+import java.util.Map;
+
+public class SnapshotServiceDTO {
+
+    /**
+     * Provider ID
+     */
+    public String name;
+
+    /**
+     * List of resources
+     */
+    public Map<String, SnapshotResourceDTO> resources;
+}