Query based on Public CM Properties

[cps.git] / cps-service / src / main / java / org / onap / cps / api / CpsAdminService.java

diff --git a/cps-service/src/main/java/org/onap/cps/api/CpsAdminService.java b/cps-service/src/main/java/org/onap/cps/api/CpsAdminService.java
index 1e4c9c7..2106f15 100755 (executable)
--- a/cps-service/src/main/java/org/onap/cps/api/CpsAdminService.java
+++ b/cps-service/src/main/java/org/onap/cps/api/CpsAdminService.java
@@ -1,7 +1,7 @@
 /*
- * ============LICENSE_START=======================================================
- *  Copyright (C) 2020 Nordix Foundation
- *  Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
+ *  ============LICENSE_START=======================================================
+ *  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");
@@ -9,6 +9,7 @@
  *  You may obtain a copy of the License at
  *
  *        http://www.apache.org/licenses/LICENSE-2.0
+ *
  *  Unless required by applicable law or agreed to in writing, software
  *  distributed under the License is distributed on an "AS IS" BASIS,
  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -22,10 +23,11 @@
 package org.onap.cps.api;
 
 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.exceptions.CpsException;
 import org.onap.cps.spi.model.Anchor;
+import org.onap.cps.spi.model.CmHandleQueryParameters;
 
 /**
  * CPS Admin Service.
@@ -38,7 +40,14 @@ public interface CpsAdminService {
      * @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.
@@ -48,7 +57,7 @@ public interface CpsAdminService {
      * @param anchorName    anchor name
      * @throws CpsException if input data is invalid.
      */
-    void createAnchor(@NonNull String dataspaceName, @NonNull String schemaSetName, @NonNull String anchorName);
+    void createAnchor(String dataspaceName, String schemaSetName, String anchorName);
 
     /**
      * Read all anchors in the given dataspace.
@@ -56,8 +65,16 @@ public interface CpsAdminService {
      * @param dataspaceName dataspace name
      * @return a collection of anchors
      */
-    @NonNull
-    Collection<Anchor> getAnchors(@NonNull String dataspaceName);
+    Collection<Anchor> getAnchors(String dataspaceName);
+
+    /**
+     * 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);
 
     /**
      * Get an anchor in the given dataspace using the anchor name.
@@ -66,8 +83,7 @@ public interface CpsAdminService {
      * @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.
@@ -75,5 +91,23 @@ public interface CpsAdminService {
      * @param dataspaceName dataspace name
      * @param anchorName    anchor name
      */
-    void deleteAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
+    void deleteAnchor(String dataspaceName, String anchorName);
+
+    /**
+     * 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 anchor names in the given dataspace. The schema set for each anchor must include all the
+     *         given module names
+     */
+    Collection<String> queryAnchorNames(String dataspaceName, Collection<String> moduleNames);
+
+    /**
+     * 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);
 }