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. All rights reserved.
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.api;
  22
  23 import java.util.Collection;
  24 import org.checkerframework.checker.nullness.qual.NonNull;
  25 import org.onap.cps.spi.exceptions.CpsException;
  26 import org.onap.cps.spi.exceptions.DataspaceAlreadyDefinedException;
  27 import org.onap.cps.spi.model.Anchor;
  28
  29 /**
  30  * CPS Admin Service.
  31  */
  32 public interface CpsAdminService {
  33
  34     /**
  35      * Create dataspace.
  36      *
  37      * @param dataspaceName dataspace name
  38      * @throws DataspaceAlreadyDefinedException if dataspace with same name already exists
  39      */
  40     void createDataspace(@NonNull String dataspaceName);
  41
  42     /**
  43      * Create an Anchor.
  44      *
  45      * @param dataspaceName dataspace name
  46      * @param schemaSetName schema set name
  47      * @param anchorName    anchor name
  48      * @throws CpsException if input data is invalid.
  49      */
  50     void createAnchor(@NonNull String dataspaceName, @NonNull String schemaSetName, @NonNull String anchorName);
  51
  52     /**
  53      * Read all anchors in the given a dataspace.
  54      *
  55      * @param dataspaceName dataspace name
  56      * @return a collection of anchors
  57      */
  58     @NonNull
  59     Collection<Anchor> getAnchors(@NonNull String dataspaceName);
  60 }