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

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation.
   4  *  Modifications Copyright (C) 2020 Bell Canada.
   5  *  Modifications Copyright (C) 2021 Pantheon.tech
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.cps.spi;
  24
  25 import java.util.Collection;
  26 import org.checkerframework.checker.nullness.qual.NonNull;
  27 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
  28 import org.onap.cps.spi.model.Anchor;
  29
  30 /*
  31     Service for handling CPS admin data.
  32  */
  33 public interface CpsAdminPersistenceService {
  34
  35     /**
  36      * Create dataspace.
  37      *
  38      * @param dataspaceName dataspace name
  39      * @throws AlreadyDefinedException if dataspace with same name already exists
  40      */
  41     void createDataspace(@NonNull String dataspaceName);
  42
  43     /**
  44      * Delete dataspace.
  45      *
  46      * @param dataspaceName the name of the dataspace to delete
  47      */
  48     void deleteDataspace(@NonNull String dataspaceName);
  49
  50     /**
  51      * Create an Anchor.
  52      *
  53      * @param dataspaceName dataspace name
  54      * @param schemaSetName schema set name
  55      * @param anchorName    anchor name
  56      */
  57     void createAnchor(@NonNull String dataspaceName, @NonNull String schemaSetName, @NonNull String anchorName);
  58
  59     /**
  60      * Read all anchors in the given a dataspace.
  61      *
  62      * @param dataspaceName dataspace name
  63      * @return a collection of anchors
  64      */
  65     @NonNull
  66     Collection<Anchor> getAnchors(@NonNull String dataspaceName);
  67
  68     /**
  69      * Query anchor names for the given module names in the provided dataspace.
  70      *
  71      *
  72      * @param dataspaceName dataspace name
  73      * @param moduleNames a collection of module names
  74      * @return a collection of anchor names in the given dataspace. The schema set for each anchor must include all the
  75      *         given module names
  76      */
  77     Collection<Anchor> queryAnchors(String dataspaceName, Collection<String> moduleNames);
  78
  79     /**
  80      * Get an anchor in the given dataspace using the anchor name.
  81      *
  82      * @param dataspaceName dataspace name
  83      * @param anchorName anchor name
  84      * @return an anchor
  85      */
  86     @NonNull
  87     Anchor getAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
  88
  89     /**
  90      * Delete anchor by name in given dataspace.
  91      *
  92      * @param dataspaceName dataspace name
  93      * @param anchorName anchor name
  94      */
  95     void deleteAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
  96 }