Merge "Implement BluePrintCatalogService"

1 files changed, 30 insertions, 11 deletions

diff --git a/components/core/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/core/interfaces/BluePrintCatalogService.kt b/components/core/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/core/interfaces/BluePrintCatalogService.kt
index 9186635e..c99cdf74 100755
--- a/components/core/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/core/interfaces/BluePrintCatalogService.kt
+++ b/components/core/src/main/kotlin/org/onap/ccsdk/apps/controllerblueprints/core/interfaces/BluePrintCatalogService.kt
@@ -16,25 +16,44 @@
 
 package org.onap.ccsdk.apps.controllerblueprints.core.interfaces
 
-interface BluePrintCatalogService {
+import org.jetbrains.annotations.NotNull
+import org.jetbrains.annotations.Nullable
+import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintException
+import java.io.File
+import java.nio.file.Path
 
-    /**
-     * Upload the CBA Zip fle to data base and return the Database identifier
-     */
-    fun uploadToDataBase(file: String, validate : Boolean): String
+interface BluePrintCatalogService {
 
     /**
-     * Download the CBA zip file from the data base and place it in a path and return the CBA zip absolute path
+     * Save the CBA to database.
+     * @param blueprintFile Either a directory, or an archive
+     * @param validate whether to validate blueprint content. Default true.
+     * @return The unique blueprint identifier
+     * @throws BluePrintException if process failed
      */
-    fun downloadFromDataBase(name: String, version: String, path: String): String
+    @NotNull
+    @Throws(BluePrintException::class)
+    fun saveToDatabase(@NotNull blueprintFile: File, @Nullable validate: Boolean = true): String
 
     /**
-     * Get the Blueprint from Data Base and Download it under working directory and return the path path
+     * Retrieve the CBA from database either archived or extracted.
+     * @param name Name of the blueprint
+     * @param version Version of the blueprint
+     * @param extract true to extract the content, false for archived content. Default to true
+     * @return Path where CBA is located
+     * @throws BluePrintException if process failed
      */
-    fun prepareBluePrint(name: String, version: String): String
+    @NotNull
+    @Throws(BluePrintException::class)
+    fun getFromDatabase(@NotNull name: String, @NotNull version: String, @Nullable extract: Boolean = true): Path
 
     /**
-     * Get blueprint archive with zip file from Data Base
+     * Delete the CBA from database.
+     * @param name Name of the blueprint
+     * @param version Version of the blueprint
+     * @throws BluePrintException if process failed
      */
-    fun downloadFromDataBase(uuid: String, path: String): String
+    @NotNull
+    @Throws(BluePrintException::class)
+    fun deleteFromDatabase(@NotNull name: String, @NotNull version: String)
 }
\ No newline at end of file