CPS-265 - updating cps path to support include-descendants option.

[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
old mode 100644 (file)
new mode 100755 (executable)
index 406655e..ed89c43
--- a/cps-service/src/main/java/org/onap/cps/api/CpsAdminService.java
+++ b/cps-service/src/main/java/org/onap/cps/api/CpsAdminService.java
@@ -20,7 +20,10 @@
 
 package org.onap.cps.api;
 
-import org.onap.cps.exceptions.CpsValidationException;
+import java.util.Collection;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.onap.cps.spi.exceptions.CpsException;
+import org.onap.cps.spi.exceptions.DataspaceAlreadyDefinedException;
 import org.onap.cps.spi.model.Anchor;
 
 /**
@@ -29,11 +32,39 @@ import org.onap.cps.spi.model.Anchor;
 public interface CpsAdminService {
 
     /**
-     * Create an anchor using provided anchorDetails object.
+     * Create dataspace.
      *
-     * @param anchor the anchor details object.
-     * @return the anchor name.
-     * @throws CpsValidationException if input data is invalid.
+     * @param dataspaceName dataspace name
+     * @throws DataspaceAlreadyDefinedException if dataspace with same name already exists
      */
-    String createAnchor(Anchor anchor);
+    void createDataspace(@NonNull String dataspaceName);
+
+    /**
+     * Create an Anchor.
+     *
+     * @param dataspaceName dataspace name
+     * @param schemaSetName schema set name
+     * @param anchorName    anchor name
+     * @throws CpsException if input data is invalid.
+     */
+    void createAnchor(@NonNull String dataspaceName, @NonNull String schemaSetName, @NonNull String anchorName);
+
+    /**
+     * Read all anchors in the given dataspace.
+     *
+     * @param dataspaceName dataspace name
+     * @return a collection of anchors
+     */
+    @NonNull
+    Collection<Anchor> getAnchors(@NonNull String dataspaceName);
+
+    /**
+     * Get an anchor in the given dataspace using the anchor name.
+     *
+     * @param dataspaceName dataspace name
+     * @param anchorName anchor name
+     * @return an anchor
+     */
+    @NonNull
+    Anchor getAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
 }