cps-service/src/main/java/org/onap/cps/spi/CpsAdminPersistenceService.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.spi;
  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.model.Anchor;
  29 import org.onap.cps.spi.model.CmHandleQueryParameters;
  30
  31 /*
  32     Service for handling CPS admin data.
  33  */
  34 public interface CpsAdminPersistenceService {
  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(String dataspaceName);
  43
  44     /**
  45      * Delete dataspace.
  46      *
  47      * @param dataspaceName the name of the dataspace to delete
  48      */
  49     void deleteDataspace(String dataspaceName);
  50
  51     /**
  52      * Create an Anchor.
  53      *
  54      * @param dataspaceName dataspace name
  55      * @param schemaSetName schema set name
  56      * @param anchorName    anchor name
  57      */
  58     void createAnchor(String dataspaceName, String schemaSetName, String anchorName);
  59
  60     /**
  61      * Read all anchors associated the given schema-set in the given dataspace.
  62      *
  63      * @param dataspaceName dataspace name
  64      * @param schemaSetName schema-set name
  65      * @return a collection of anchors
  66      */
  67     Collection<Anchor> getAnchors(String dataspaceName, String schemaSetName);
  68
  69     /**
  70      * Read all anchors in the given a dataspace.
  71      *
  72      * @param dataspaceName dataspace name
  73      * @return a collection of anchors
  74      */
  75     Collection<Anchor> getAnchors(String dataspaceName);
  76
  77     /**
  78      * Query anchor names for the given module names in the provided dataspace.
  79      *
  80      *
  81      * @param dataspaceName dataspace name
  82      * @param moduleNames a collection of module names
  83      * @return a collection of anchor names in the given dataspace. The schema set for each anchor must include all the
  84      *         given module names
  85      */
  86     Collection<Anchor> queryAnchors(String dataspaceName, Collection<String> moduleNames);
  87
  88     /**
  89      * Get an anchor in the given dataspace using the anchor name.
  90      *
  91      * @param dataspaceName dataspace name
  92      * @param anchorName anchor name
  93      * @return an anchor
  94      */
  95     Anchor getAnchor(String dataspaceName, String anchorName);
  96
  97     /**
  98      * Delete anchor by name in given dataspace.
  99      *
 100      * @param dataspaceName dataspace name
 101      * @param anchorName anchor name
 102      */
 103     void deleteAnchor(String dataspaceName, String anchorName);
 104
 105     /**
 106      * Query and return cm handles that match the given query parameters.
 107      *
 108      * @param cmHandleQueryParameters the cm handle query parameters
 109      * @return collection of cm handle ids
 110      */
 111     Set<String> queryCmHandles(CmHandleQueryParameters cmHandleQueryParameters);
 112 }