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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020-2023 Nordix Foundation
   4  *  Modifications Copyright (C) 2020-2022 Bell Canada.
   5  *  Modifications Copyright (C) 2021 Pantheon.tech
   6  *  Modifications Copyright (C) 2022 TechMahindra Ltd.
   7  *  ================================================================================
   8  *  Licensed under the Apache License, Version 2.0 (the "License");
   9  *  you may not use this file except in compliance with the License.
  10  *  You may obtain a copy of the License at
  11  *
  12  *        http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *  Unless required by applicable law or agreed to in writing, software
  15  *  distributed under the License is distributed on an "AS IS" BASIS,
  16  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  *  See the License for the specific language governing permissions and
  18  *  limitations under the License.
  19  *
  20  *  SPDX-License-Identifier: Apache-2.0
  21  *  ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.cps.api;
  25
  26 import java.util.Collection;
  27 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
  28 import org.onap.cps.spi.model.Dataspace;
  29
  30 /**
  31  * CPS Admin Service.
  32  */
  33 public interface CpsDataspaceService {
  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      * Get dataspace by given dataspace name.
  52      *
  53      * @param dataspaceName dataspace name
  54      * @return a dataspace
  55      */
  56     Dataspace getDataspace(String dataspaceName);
  57
  58     /**
  59      * Get All Dataspaces.
  60      *
  61      *
  62      * @return a collection of dataspaces
  63      */
  64     Collection<Dataspace> getAllDataspaces();
  65
  66 }