2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020 Nordix Foundation
4 * Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
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
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.api;
24 import java.util.Collection;
25 import org.checkerframework.checker.nullness.qual.NonNull;
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(@NonNull String dataspaceName);
46 * @param dataspaceName dataspace name
47 * @param schemaSetName schema set name
48 * @param anchorName anchor name
49 * @throws CpsException if input data is invalid.
51 void createAnchor(@NonNull String dataspaceName, @NonNull String schemaSetName, @NonNull String anchorName);
54 * Read all anchors in the given dataspace.
56 * @param dataspaceName dataspace name
57 * @return a collection of anchors
60 Collection<Anchor> getAnchors(@NonNull String dataspaceName);
63 * Get an anchor in the given dataspace using the anchor name.
65 * @param dataspaceName dataspace name
66 * @param anchorName anchor name
70 Anchor getAnchor(@NonNull String dataspaceName, @NonNull String anchorName);
73 * Delete anchor by name in given dataspace.
75 * @param dataspaceName dataspace name
76 * @param anchorName anchor name
78 void deleteAnchor(@NonNull String dataspaceName, @NonNull String anchorName);