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
old mode 100644 (file)
new mode 100755 (executable)
index 6709c1f..25167e8
--- 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,6 +1,8 @@
-/*-
+/*
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2020 Nordix Foundation. All rights reserved.
+ *  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");
  * you may not use this file except in compliance with the License.
@@ -20,18 +22,91 @@
 
 package org.onap.cps.spi;
 
+import java.util.Collection;
+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.
  */
 public interface CpsAdminPersistenceService {
 
+    /**
+     * Create dataspace.
+     *
+     * @param dataspaceName dataspace name
+     * @throws AlreadyDefinedException if dataspace with same name already exists
+     */
+    void createDataspace(String dataspaceName);
+
+    /**
+     * Delete dataspace.
+     *
+     * @param dataspaceName the name of the dataspace to delete
+     */
+    void deleteDataspace(String dataspaceName);
+
     /**
      * Create an Anchor.
      *
-     * @param anchor the anchorDetails object.
-     * @return the anchor name.
+     * @param dataspaceName dataspace name
+     * @param schemaSetName schema set name
+     * @param anchorName    anchor name
+     */
+    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.
+     *
+     * @param dataspaceName dataspace name
+     * @return a collection of anchors
+     */
+    Collection<Anchor> getAnchors(String dataspaceName);
+
+    /**
+     * 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<Anchor> queryAnchors(String dataspaceName, Collection<String> moduleNames);
+
+    /**
+     * Get an anchor in the given dataspace using the anchor name.
+     *
+     * @param dataspaceName dataspace name
+     * @param anchorName anchor name
+     * @return an anchor
+     */
+    Anchor getAnchor(String dataspaceName, String anchorName);
+
+    /**
+     * Delete anchor by name in given dataspace.
+     *
+     * @param dataspaceName dataspace name
+     * @param anchorName anchor name
+     */
+    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
      */
-    String createAnchor(Anchor anchor);
+    Set<String> queryCmHandles(CmHandleQueryParameters cmHandleQueryParameters);
 }