Merge "Add memory usage to integration tests [UPDATED]"
[cps.git] / cps-service / src / main / java / org / onap / cps / api / CpsModuleService.java
index 5c40331..e8c3e77 100644 (file)
@@ -1,7 +1,8 @@
 /*
  *  ============LICENSE_START=======================================================
- *  Copyright (C) 2020 Nordix Foundation
+ *  Copyright (C) 2020-2023 Nordix Foundation
  *  Modifications Copyright (C) 2020-2021 Pantheon.tech
+ *  Modifications Copyright (C) 2022 TechMahindra Ltd.
  *  ================================================================================
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
 
 package org.onap.cps.api;
 
-import java.util.List;
+import java.util.Collection;
 import java.util.Map;
-import org.checkerframework.checker.nullness.qual.NonNull;
 import org.onap.cps.spi.CascadeDeleteAllowed;
 import org.onap.cps.spi.exceptions.DataInUseException;
+import org.onap.cps.spi.model.ModuleDefinition;
 import org.onap.cps.spi.model.ModuleReference;
 import org.onap.cps.spi.model.SchemaSet;
 
@@ -42,21 +43,19 @@ public interface CpsModuleService {
      * @param yangResourcesNameToContentMap yang resources (files) as a mep where key is resource name
      *                                      and value is content
      */
-    void createSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
-                         @NonNull Map<String, String> yangResourcesNameToContentMap);
+    void createSchemaSet(String dataspaceName, String schemaSetName,
+                         Map<String, String> yangResourcesNameToContentMap);
 
     /**
-     * Create a schema set from new modules and existing modules.
-     *
-     * @param dataspaceName                          Dataspace name
-     * @param schemaSetName                          schema set name
-     * @param newYangResourcesModuleNameToContentMap YANG resources map where key is a module name and value is content
-     * @param existingModuleReferences               List of YANG resources module references of the modules
-     *                                               needed for this handle that are already in CPS
+     * Create or upgrade a schema set from new modules and existing modules or only existing modules.
+     * @param dataspaceName             Dataspace name
+     * @param schemaSetName             schema set name
+     * @param newModuleNameToContentMap YANG resources map where key is a module name and value is content
+     * @param allModuleReferences       All YANG resource module references
      */
-    void createSchemaSetFromModules(@NonNull String dataspaceName, @NonNull String schemaSetName,
-                                    @NonNull Map<String, String> newYangResourcesModuleNameToContentMap,
-                                    @NonNull List<ModuleReference> existingModuleReferences);
+    void createOrUpgradeSchemaSetFromModules(String dataspaceName, String schemaSetName,
+                                    Map<String, String> newModuleNameToContentMap,
+                                    Collection<ModuleReference> allModuleReferences);
 
     /**
      * Read schema set in the given dataspace.
@@ -65,7 +64,15 @@ public interface CpsModuleService {
      * @param schemaSetName schema set name
      * @return a SchemaSet
      */
-    SchemaSet getSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName);
+    SchemaSet getSchemaSet(String dataspaceName, String schemaSetName);
+
+    /**
+     * Retrieve all schema sets in the given dataspace.
+     *
+     * @param dataspaceName dataspace name
+     * @return all SchemaSets
+     */
+    Collection<SchemaSet> getSchemaSets(String dataspaceName);
 
     /**
      * Deletes Schema Set.
@@ -73,16 +80,54 @@ public interface CpsModuleService {
      * @param dataspaceName        dataspace name
      * @param schemaSetName        schema set name
      * @param cascadeDeleteAllowed indicates the allowance to remove associated anchors and data if exist
-     * @throws DataInUseException if cascadeDeleteAllowed is set to CASCADE_DELETE_PROHIBITED and there
-     *                           is associated anchor record exists in database
+     * @throws DataInUseException  if cascadeDeleteAllowed is set to CASCADE_DELETE_PROHIBITED and there
+     *                             is associated anchor record exists in database
+     */
+    void deleteSchemaSet(String dataspaceName, String schemaSetName,
+                         CascadeDeleteAllowed cascadeDeleteAllowed);
+
+    /**
+     * Deletes Schema Sets with cascade.
+     *
+     * @param dataspaceName        dataspace name
+     * @param schemaSetNames       schema set names
+     */
+    void deleteSchemaSetsWithCascade(String dataspaceName, Collection<String> schemaSetNames);
+
+    /**
+     * Retrieve module references for the given dataspace name.
+     *
+     * @param dataspaceName        dataspace name
+     * @return a list of ModuleReference objects
      */
-    void deleteSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
-        @NonNull CascadeDeleteAllowed cascadeDeleteAllowed);
+    Collection<ModuleReference> getYangResourceModuleReferences(String dataspaceName);
 
     /**
-     * Retrieve all modules and revisions known by CPS for all Yang Resources.
+     * Retrieve module references for the given dataspace name and anchor name.
      *
+     * @param dataspaceName dataspace name
+     * @param anchorName    anchor name
      * @return a list of ModuleReference objects
      */
-    List<ModuleReference> getAllYangResourcesModuleReferences();
+    Collection<ModuleReference> getYangResourcesModuleReferences(String dataspaceName, String anchorName);
+
+    /**
+     * Retrieve module definitions for the given dataspace name and anchor name.
+     *
+     * @param dataspaceName dataspace name
+     * @param anchorName    anchor name
+     * @return a collection of module definitions (moduleName, revision, yang resource content)
+     */
+    Collection<ModuleDefinition> getModuleDefinitionsByAnchorName(String dataspaceName, String anchorName);
+
+    /**
+     * Identify previously unknown Yang Resource module references.
+     * The system will ignore the namespace of all module references.
+     *
+     * @param moduleReferencesToCheck the moduleReferencesToCheck
+     * @returns collection of module references (namespace will be always blank)
+     */
+    Collection<ModuleReference> identifyNewModuleReferences(
+        Collection<ModuleReference> moduleReferencesToCheck);
+
 }