/*
- * ============LICENSE_START=======================================================
+ * ============LICENSE_START=======================================================
* Copyright (C) 2020 Nordix Foundation
- * Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
+ * Modifications Copyright (C) 2020-2022 Bell Canada.
+ * Modifications Copyright (C) 2021 Pantheon.tech
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
package org.onap.cps.api;
import java.util.Collection;
+import org.onap.cps.spi.exceptions.AlreadyDefinedException;
import org.onap.cps.spi.exceptions.CpsException;
import org.onap.cps.spi.model.Anchor;
public interface CpsAdminService {
/**
- * Create an anchor using provided anchorDetails object.
+ * Create dataspace.
+ *
+ * @param dataspaceName dataspace name
+ * @throws AlreadyDefinedException if dataspace with same name already exists
+ */
+ void createDataspace(String dataspaceName);
+
+ /**
+ * Delete dataspace.
+ *
+ * @param dataspaceName the name of the dataspace to delete
+ */
+ void deleteDataspace(String dataspaceName);
+
+ /**
+ * Create an Anchor.
*
- * @param anchor the anchor details object.
- * @return the anchor name.
+ * @param dataspaceName dataspace name
+ * @param schemaSetName schema set name
+ * @param anchorName anchor name
* @throws CpsException if input data is invalid.
*/
- String createAnchor(Anchor anchor);
+ void createAnchor(String dataspaceName, String schemaSetName, String anchorName);
/**
- * Read all anchors in the given a dataspace.
+ * Read all anchors in the given dataspace.
*
* @param dataspaceName dataspace name
* @return a collection of anchors
*/
Collection<Anchor> getAnchors(String dataspaceName);
+
+ /**
+ * Read all anchors associated the given schema-set in the given dataspace.
+ *
+ * @param dataspaceName dataspace name
+ * @param schemaSetName schema-set name
+ * @return a collection of anchors
+ */
+ Collection<Anchor> getAnchors(String dataspaceName, String schemaSetName);
+
+ /**
+ * Get an anchor in the given dataspace using the anchor name.
+ *
+ * @param dataspaceName dataspace name
+ * @param anchorName anchor name
+ * @return an anchor
+ */
+ Anchor getAnchor(String dataspaceName, String anchorName);
+
+ /**
+ * Delete anchor by name in given dataspace.
+ *
+ * @param dataspaceName dataspace name
+ * @param anchorName anchor name
+ */
+ void deleteAnchor(String dataspaceName, String anchorName);
+
+ /**
+ * Query anchor names for the given module names in the provided dataspace.
+ *
+ * @param dataspaceName dataspace name
+ * @param moduleNames a collection of module names
+ * @return a collection of anchor names in the given dataspace. The schema set for each anchor must include all the
+ * given module names
+ */
+ Collection<String> queryAnchorNames(String dataspaceName, Collection<String> moduleNames);
}