cps-service/src/main/java/org/onap/cps/api/CpsAdminService.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020-2021 Nordix Foundation
   4  *  Modifications Copyright (C) 2020-2022 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.onap.cps.spi.exceptions.AlreadyDefinedException;
  27 import org.onap.cps.spi.exceptions.CpsException;
  28 import org.onap.cps.spi.model.Anchor;
  29
  30 /**
  31  * CPS Admin Service.
  32  */
  33 public interface CpsAdminService {
  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(String dataspaceName);
  42
  43     /**
  44      * Delete dataspace.
  45      *
  46      * @param dataspaceName the name of the dataspace to delete
  47      */
  48     void deleteDataspace(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      * @throws CpsException if input data is invalid.
  57      */
  58     void createAnchor(String dataspaceName, String schemaSetName, String anchorName);
  59
  60     /**
  61      * Read all anchors in the given dataspace.
  62      *
  63      * @param dataspaceName dataspace name
  64      * @return a collection of anchors
  65      */
  66     Collection<Anchor> getAnchors(String dataspaceName);
  67
  68     /**
  69      * Read all anchors associated the given schema-set in the given dataspace.
  70      *
  71      * @param dataspaceName dataspace name
  72      * @param schemaSetName schema-set name
  73      * @return a collection of anchors
  74      */
  75     Collection<Anchor> getAnchors(String dataspaceName, String schemaSetName);
  76
  77     /**
  78      * Get an anchor in the given dataspace using the anchor name.
  79      *
  80      * @param dataspaceName dataspace name
  81      * @param anchorName    anchor name
  82      * @return an anchor
  83      */
  84     Anchor getAnchor(String dataspaceName, String anchorName);
  85
  86     /**
  87      * Delete anchor by name in given dataspace.
  88      *
  89      * @param dataspaceName dataspace name
  90      * @param anchorName    anchor name
  91      */
  92     void deleteAnchor(String dataspaceName, String anchorName);
  93
  94     /**
  95      * Query anchor names for the given module names in the provided dataspace.
  96      *
  97      * @param dataspaceName dataspace name
  98      * @param moduleNames   a collection of module names
  99      * @return a collection of anchor names in the given dataspace. The schema set for each anchor must include all the
 100      *         given module names
 101      */
 102     Collection<String> queryAnchorNames(String dataspaceName, Collection<String> moduleNames);
 103 }