Query based on Public CM Properties

[cps.git] / cps-service / src / main / java / org / onap / cps / spi / CpsAdminPersistenceService.java

diff --git a/cps-service/src/main/java/org/onap/cps/spi/CpsAdminPersistenceService.java b/cps-service/src/main/java/org/onap/cps/spi/CpsAdminPersistenceService.java
index f29735f..25167e8 100755 (executable)
--- a/cps-service/src/main/java/org/onap/cps/spi/CpsAdminPersistenceService.java
+++ b/cps-service/src/main/java/org/onap/cps/spi/CpsAdminPersistenceService.java
@@ -1,7 +1,7 @@
 /*
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2020 Nordix Foundation.
- *  Modifications Copyright (C) 2020 Bell Canada.
+ *  Copyright (C) 2020-2022 Nordix Foundation.
+ *  Modifications Copyright (C) 2020-2022 Bell Canada.
  *  Modifications Copyright (C) 2021 Pantheon.tech
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,9 +23,10 @@
 package org.onap.cps.spi;
 
 import java.util.Collection;
-import org.checkerframework.checker.nullness.qual.NonNull;
+import java.util.Set;
 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
 import org.onap.cps.spi.model.Anchor;
+import org.onap.cps.spi.model.CmHandleQueryParameters;
 
 /*
     Service for handling CPS admin data.
@@ -38,7 +39,14 @@ public interface CpsAdminPersistenceService {
      * @param dataspaceName dataspace name
      * @throws AlreadyDefinedException if dataspace with same name already exists
      */
-    void createDataspace(@NonNull String dataspaceName);
+    void createDataspace(String dataspaceName);
+
+    /**
+     * Delete dataspace.
+     *
+     * @param dataspaceName the name of the dataspace to delete
+     */
+    void deleteDataspace(String dataspaceName);
 
     /**
      * Create an Anchor.
@@ -47,7 +55,16 @@ public interface CpsAdminPersistenceService {
      * @param schemaSetName schema set name
      * @param anchorName    anchor name
      */
-    void createAnchor(@NonNull String dataspaceName, @NonNull String schemaSetName, @NonNull String anchorName);
+    void createAnchor(String dataspaceName, String schemaSetName, String anchorName);
+
+    /**
+     * Read all anchors associated the given schema-set in the given dataspace.
+     *
+     * @param dataspaceName dataspace name
+     * @param schemaSetName schema-set name
+     * @return a collection of anchors
+     */
+    Collection<Anchor> getAnchors(String dataspaceName, String schemaSetName);
 
     /**
      * Read all anchors in the given a dataspace.
@@ -55,17 +72,18 @@ public interface CpsAdminPersistenceService {
      * @param dataspaceName dataspace name
      * @return a collection of anchors
      */
-    @NonNull
-    Collection<Anchor> getAnchors(@NonNull String dataspaceName);
+    Collection<Anchor> getAnchors(String dataspaceName);
 
     /**
-     * Get anchors for the given dataspace name and collection of module names.
+     * Query anchor names for the given module names in the provided dataspace.
+     *
      *
      * @param dataspaceName dataspace name
      * @param moduleNames a collection of module names
-     * @return a collection of anchors
+     * @return a collection of anchor names in the given dataspace. The schema set for each anchor must include all the
+     *         given module names
      */
-    Collection<Anchor> getAnchors(String dataspaceName, Collection<String> moduleNames);
+    Collection<Anchor> queryAnchors(String dataspaceName, Collection<String> moduleNames);
 
     /**
      * Get an anchor in the given dataspace using the anchor name.
@@ -74,8 +92,7 @@ public interface CpsAdminPersistenceService {
      * @param anchorName anchor name
      * @return an anchor
      */
-    @NonNull
-    Anchor getAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
+    Anchor getAnchor(String dataspaceName, String anchorName);
 
     /**
      * Delete anchor by name in given dataspace.
@@ -83,5 +100,13 @@ public interface CpsAdminPersistenceService {
      * @param dataspaceName dataspace name
      * @param anchorName anchor name
      */
-    void deleteAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
+    void deleteAnchor(String dataspaceName, String anchorName);
+
+    /**
+     * Query and return cm handles that match the given query parameters.
+     *
+     * @param cmHandleQueryParameters the cm handle query parameters
+     * @return collection of cm handle ids
+     */
+    Set<String> queryCmHandles(CmHandleQueryParameters cmHandleQueryParameters);
 }