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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020-2022 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 java.util.Set;
  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 import org.onap.cps.spi.model.CmHandleQueryParameters;
  31
  32 /**
  33  * CPS Admin Service.
  34  */
  35 public interface CpsAdminService {
  36
  37     /**
  38      * Create dataspace.
  39      *
  40      * @param dataspaceName dataspace name
  41      * @throws AlreadyDefinedException if dataspace with same name already exists
  42      */
  43     void createDataspace(String dataspaceName);
  44
  45     /**
  46      * Delete dataspace.
  47      *
  48      * @param dataspaceName the name of the dataspace to delete
  49      */
  50     void deleteDataspace(String dataspaceName);
  51
  52     /**
  53      * Create an Anchor.
  54      *
  55      * @param dataspaceName dataspace name
  56      * @param schemaSetName schema set name
  57      * @param anchorName    anchor name
  58      * @throws CpsException if input data is invalid.
  59      */
  60     void createAnchor(String dataspaceName, String schemaSetName, String anchorName);
  61
  62     /**
  63      * Read all anchors in the given dataspace.
  64      *
  65      * @param dataspaceName dataspace name
  66      * @return a collection of anchors
  67      */
  68     Collection<Anchor> getAnchors(String dataspaceName);
  69
  70     /**
  71      * Read all anchors associated the given schema-set in the given dataspace.
  72      *
  73      * @param dataspaceName dataspace name
  74      * @param schemaSetName schema-set name
  75      * @return a collection of anchors
  76      */
  77     Collection<Anchor> getAnchors(String dataspaceName, String schemaSetName);
  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     Anchor getAnchor(String dataspaceName, String anchorName);
  87
  88     /**
  89      * Delete anchor by name in given dataspace.
  90      *
  91      * @param dataspaceName dataspace name
  92      * @param anchorName    anchor name
  93      */
  94     void deleteAnchor(String dataspaceName, String anchorName);
  95
  96     /**
  97      * Query anchor names for the given module names in the provided dataspace.
  98      *
  99      * @param dataspaceName dataspace name
 100      * @param moduleNames   a collection of module names
 101      * @return a collection of anchor names in the given dataspace. The schema set for each anchor must include all the
 102      *         given module names
 103      */
 104     Collection<String> queryAnchorNames(String dataspaceName, Collection<String> moduleNames);
 105
 106     /**
 107      * Query and return cm handles that match the given query parameters.
 108      *
 109      * @param cmHandleQueryParameters the cm handle query parameters
 110      * @return collection of cm handle ids
 111      */
 112     Set<String> queryCmHandles(CmHandleQueryParameters cmHandleQueryParameters);
 113 }