2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020 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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.cps.api;
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;
33 public interface CpsAdminService {
38 * @param dataspaceName dataspace name
39 * @throws AlreadyDefinedException if dataspace with same name already exists
41 void createDataspace(String dataspaceName);
46 * @param dataspaceName the name of the dataspace to delete
48 void deleteDataspace(String dataspaceName);
53 * @param dataspaceName dataspace name
54 * @param schemaSetName schema set name
55 * @param anchorName anchor name
56 * @throws CpsException if input data is invalid.
58 void createAnchor(String dataspaceName, String schemaSetName, String anchorName);
61 * Read all anchors in the given dataspace.
63 * @param dataspaceName dataspace name
64 * @return a collection of anchors
66 Collection<Anchor> getAnchors(String dataspaceName);
69 * Read all anchors associated the given schema-set in the given dataspace.
71 * @param dataspaceName dataspace name
72 * @param schemaSetName schema-set name
73 * @return a collection of anchors
75 Collection<Anchor> getAnchors(String dataspaceName, String schemaSetName);
78 * Get an anchor in the given dataspace using the anchor name.
80 * @param dataspaceName dataspace name
81 * @param anchorName anchor name
84 Anchor getAnchor(String dataspaceName, String anchorName);
87 * Delete anchor by name in given dataspace.
89 * @param dataspaceName dataspace name
90 * @param anchorName anchor name
92 void deleteAnchor(String dataspaceName, String anchorName);
95 * Query anchor names for the given module names in the provided dataspace.
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
102 Collection<String> queryAnchorNames(String dataspaceName, Collection<String> moduleNames);