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
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.api;
23 import java.util.Collection;
24 import org.checkerframework.checker.nullness.qual.NonNull;
25 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
26 import org.onap.cps.spi.exceptions.CpsException;
27 import org.onap.cps.spi.model.Anchor;
32 public interface CpsAdminService {
37 * @param dataspaceName dataspace name
38 * @throws AlreadyDefinedException if dataspace with same name already exists
40 void createDataspace(@NonNull String dataspaceName);
45 * @param dataspaceName dataspace name
46 * @param schemaSetName schema set name
47 * @param anchorName anchor name
48 * @throws CpsException if input data is invalid.
50 void createAnchor(@NonNull String dataspaceName, @NonNull String schemaSetName, @NonNull String anchorName);
53 * Read all anchors in the given dataspace.
55 * @param dataspaceName dataspace name
56 * @return a collection of anchors
59 Collection<Anchor> getAnchors(@NonNull String dataspaceName);
62 * Get an anchor in the given dataspace using the anchor name.
64 * @param dataspaceName dataspace name
65 * @param anchorName anchor name
69 Anchor getAnchor(@NonNull String dataspaceName, @NonNull String anchorName);