2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020 Nordix Foundation
4 * Modifications Copyright (C) 2020 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.checkerframework.checker.nullness.qual.NonNull;
27 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
28 import org.onap.cps.spi.exceptions.CpsException;
29 import org.onap.cps.spi.model.Anchor;
34 public interface CpsAdminService {
39 * @param dataspaceName dataspace name
40 * @throws AlreadyDefinedException if dataspace with same name already exists
42 void createDataspace(@NonNull String dataspaceName);
47 * @param dataspaceName the name of the dataspace to delete
49 void deleteDataspace(@NonNull String dataspaceName);
54 * @param dataspaceName dataspace name
55 * @param schemaSetName schema set name
56 * @param anchorName anchor name
57 * @throws CpsException if input data is invalid.
59 void createAnchor(@NonNull String dataspaceName, @NonNull String schemaSetName, @NonNull String anchorName);
62 * Read all anchors in the given dataspace.
64 * @param dataspaceName dataspace name
65 * @return a collection of anchors
68 Collection<Anchor> getAnchors(@NonNull String dataspaceName);
71 * Get an anchor in the given dataspace using the anchor name.
73 * @param dataspaceName dataspace name
74 * @param anchorName anchor name
78 Anchor getAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
81 * Delete anchor by name in given dataspace.
83 * @param dataspaceName dataspace name
84 * @param anchorName anchor name
86 void deleteAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
89 * Query anchor names for the given module names in the provided dataspace.
92 * @param dataspaceName dataspace name
93 * @param moduleNames a collection of module names
94 * @return a collection of anchor names in the given dataspace. The schema set for each anchor must include all the
97 Collection<String> queryAnchorNames(String dataspaceName, Collection<String> moduleNames);