Merge "Allow separate registration of DMIDataPlugin and DmiModelPugin"
[cps.git] / cps-service / src / main / java / org / onap / cps / spi / CpsAdminPersistenceService.java
old mode 100644 (file)
new mode 100755 (executable)
index 1b7ddb7..9553700
@@ -1,7 +1,8 @@
-/*-
+/*
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2020 Nordix Foundation. All rights reserved.
- *  Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
+ *  Copyright (C) 2020 Nordix Foundation.
+ *  Modifications Copyright (C) 2020 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.
@@ -23,6 +24,7 @@ package org.onap.cps.spi;
 
 import java.util.Collection;
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.onap.cps.spi.exceptions.AlreadyDefinedException;
 import org.onap.cps.spi.model.Anchor;
 
 /*
@@ -30,6 +32,21 @@ import org.onap.cps.spi.model.Anchor;
  */
 public interface CpsAdminPersistenceService {
 
+    /**
+     * Create dataspace.
+     *
+     * @param dataspaceName dataspace name
+     * @throws AlreadyDefinedException if dataspace with same name already exists
+     */
+    void createDataspace(@NonNull String dataspaceName);
+
+    /**
+     * Delete dataspace.
+     *
+     * @param dataspaceName the name of the dataspace to delete
+     */
+    void deleteDataspace(@NonNull String dataspaceName);
+
     /**
      * Create an Anchor.
      *
@@ -39,7 +56,6 @@ public interface CpsAdminPersistenceService {
      */
     void createAnchor(@NonNull String dataspaceName, @NonNull String schemaSetName, @NonNull String anchorName);
 
-
     /**
      * Read all anchors in the given a dataspace.
      *
@@ -49,4 +65,32 @@ public interface CpsAdminPersistenceService {
     @NonNull
     Collection<Anchor> getAnchors(@NonNull 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
+     */
+    @NonNull
+    Anchor getAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
+
+    /**
+     * Delete anchor by name in given dataspace.
+     *
+     * @param dataspaceName dataspace name
+     * @param anchorName anchor name
+     */
+    void deleteAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
 }