cps-service/src/main/java/org/onap/cps/api/CpsAdminService.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.api;
  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.exceptions.CpsException;
  29 import org.onap.cps.spi.model.Anchor;
  30
  31 /**
  32  * CPS Admin Service.
  33  */
  34 public interface CpsAdminService {
  35
  36     /**
  37      * Create dataspace.
  38      *
  39      * @param dataspaceName dataspace name
  40      * @throws AlreadyDefinedException if dataspace with same name already exists
  41      */
  42     void createDataspace(@NonNull String dataspaceName);
  43
  44     /**
  45      * Create an Anchor.
  46      *
  47      * @param dataspaceName dataspace name
  48      * @param schemaSetName schema set name
  49      * @param anchorName    anchor name
  50      * @throws CpsException if input data is invalid.
  51      */
  52     void createAnchor(@NonNull String dataspaceName, @NonNull String schemaSetName, @NonNull String anchorName);
  53
  54     /**
  55      * Read all anchors in the given dataspace.
  56      *
  57      * @param dataspaceName dataspace name
  58      * @return a collection of anchors
  59      */
  60     @NonNull
  61     Collection<Anchor> getAnchors(@NonNull String dataspaceName);
  62
  63     /**
  64      * Get an anchor in the given dataspace using the anchor name.
  65      *
  66      * @param dataspaceName dataspace name
  67      * @param anchorName    anchor name
  68      * @return an anchor
  69      */
  70     @NonNull
  71     Anchor getAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
  72
  73     /**
  74      * Delete anchor by name in given dataspace.
  75      *
  76      * @param dataspaceName dataspace name
  77      * @param anchorName    anchor name
  78      */
  79     void deleteAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
  80
  81     /**
  82      * Query anchor names for the given module names in the provided dataspace.
  83      *
  84      *
  85      * @param dataspaceName dataspace name
  86      * @param moduleNames a collection of module names
  87      * @return a collection of anchor names in the given dataspace. The schema set for each anchor must include all the
  88      *         given module names
  89      */
  90     Collection<String> queryAnchorNames(String dataspaceName, Collection<String> moduleNames);
  91 }