s3 based case store

pom.xml

@@ -164,6 +164,11 @@
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-stream-binder-rabbit</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.awspring.cloud</groupId>
+            <artifactId>spring-cloud-aws-starter-s3</artifactId>
+            <version>3.0.1</version>
+        </dependency>
         <dependency>
             <groupId>org.springframework.data</groupId>
             <artifactId>spring-data-elasticsearch</artifactId>

src/main/java/com/powsybl/caseserver/CaseController.java

@@ -12,7 +12,6 @@
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.UncheckedIOException;
-import java.nio.file.Path;
 import java.util.List;
 import java.util.UUID;
 
@@ -23,7 +22,9 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.PropertySource;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
@@ -35,6 +36,7 @@
  * @author Abdelsalem Hedhili <abdelsalem.hedhili at rte-france.com>
  * @author Franck Lecuyer <franck.lecuyer at rte-france.com>
  */
+@PropertySource(value = "classpath:config/application.yaml")
 @RestController
 @RequestMapping(value = "/" + CaseConstants.API_VERSION)
 @Tag(name = "Case server")
@@ -44,14 +46,15 @@ public class CaseController {
     private static final Logger LOGGER = LoggerFactory.getLogger(CaseController.class);
 
     @Autowired
+    @Qualifier("storageService")
     private CaseService caseService;
 
     @GetMapping(value = "/cases")
     @Operation(summary = "Get all cases")
     //For maintenance purpose
     public ResponseEntity<List<CaseInfos>> getCases() {
         LOGGER.debug("getCases request received");
-        List<CaseInfos> cases = caseService.getCases(caseService.getStorageRootDir());
+        List<CaseInfos> cases = caseService.getCases();
         if (cases == null) {
             return ResponseEntity.noContent().build();
         }
@@ -62,30 +65,31 @@ public ResponseEntity<List<CaseInfos>> getCases() {
     @Operation(summary = "Get a case infos")
     public ResponseEntity<CaseInfos> getCaseInfos(@PathVariable("caseUuid") UUID caseUuid) {
         LOGGER.debug("getCaseInfos request received");
-        Path file = caseService.getCaseFile(caseUuid);
-        if (file == null) {
+        if (!caseService.caseExists(caseUuid)) {
             return ResponseEntity.noContent().build();
         }
-        CaseInfos caseInfos = caseService.getCase(file);
+        CaseInfos caseInfos = caseService.getCase(caseUuid);
         return ResponseEntity.ok().body(caseInfos);
     }
 
     @GetMapping(value = "/cases/{caseUuid}/format")
     @Operation(summary = "Get case Format")
     public ResponseEntity<String> getCaseFormat(@PathVariable("caseUuid") UUID caseUuid) {
         LOGGER.debug("getCaseFormat request received");
-        Path file = caseService.getCaseFile(caseUuid);
-        if (file == null) {
+        if (!caseService.caseExists(caseUuid)) {
             throw createDirectoryNotFound(caseUuid);
         }
-        String caseFormat = caseService.getFormat(file);
+        String caseFormat = caseService.getFormat(caseUuid);
         return ResponseEntity.ok().body(caseFormat);
     }
 
     @GetMapping(value = "/cases/{caseUuid}/name")
     @Operation(summary = "Get case name")
     public ResponseEntity<String> getCaseName(@PathVariable("caseUuid") UUID caseUuid) {
         LOGGER.debug("getCaseName request received");
+        if (!caseService.caseExists(caseUuid)) {
+            throw createDirectoryNotFound(caseUuid);
+        }
         String caseName = caseService.getCaseName(caseUuid);
         return ResponseEntity.ok().body(caseName);
     }
@@ -128,6 +132,21 @@ public ResponseEntity<Boolean> exists(@PathVariable("caseUuid") UUID caseUuid) {
 
     }
 
+    @GetMapping(value = "/cases/metadata")
+    @Operation(summary = "Get cases Metadata")
+    public ResponseEntity<List<CaseInfos>> getMetadata(@RequestParam("ids") List<UUID> ids) {
+        LOGGER.debug("get Cases metadata");
+        return ResponseEntity.ok().body(caseService.getMetadata(ids));
+    }
+
+    @GetMapping(value = "/cases/search")
+    @Operation(summary = "Search cases by metadata")
+    public ResponseEntity<List<CaseInfos>> searchCases(@RequestParam(value = "q") String query) {
+        LOGGER.debug("search cases request received");
+        List<CaseInfos> cases = caseService.searchCases(query);
+        return ResponseEntity.ok().body(cases);
+    }
+
     @PostMapping(value = "/cases", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
     @Operation(summary = "import a case")
     @SuppressWarnings("javasecurity:S5145")
@@ -151,6 +170,14 @@ public ResponseEntity<UUID> duplicateCase(
         return ResponseEntity.ok().body(newCaseUuid);
     }
 
+    @PostMapping(value = "/cases/reindex-all")
+    @Operation(summary = "reindex all cases")
+    public ResponseEntity<Void> reindexAllCases() {
+        LOGGER.debug("reindex all cases request received");
+        caseService.reindexAllCases();
+        return ResponseEntity.ok().build();
+    }
+
     @PutMapping(value = "/cases/{caseUuid}/disableExpiration")
     @Operation(summary = "disable the case expiration")
     @ApiResponses(value = {
@@ -166,6 +193,9 @@ public ResponseEntity<Void> disableCaseExpiration(@PathVariable("caseUuid") UUID
     @Operation(summary = "delete a case")
     public ResponseEntity<Void> deleteCase(@PathVariable("caseUuid") UUID caseUuid) {
         LOGGER.debug("deleteCase request received with parameter caseUuid = {}", caseUuid);
+        if (!caseService.caseExists(caseUuid)) {
+            throw createDirectoryNotFound(caseUuid);
+        }
         caseService.deleteCase(caseUuid);
         return ResponseEntity.ok().build();
     }
@@ -178,26 +208,4 @@ public ResponseEntity<Void> deleteCases() {
         return ResponseEntity.ok().build();
     }
 
-    @GetMapping(value = "/cases/search")
-    @Operation(summary = "Search cases by metadata")
-    public ResponseEntity<List<CaseInfos>> searchCases(@RequestParam(value = "q") String query) {
-        LOGGER.debug("search cases request received");
-        List<CaseInfos> cases = caseService.searchCases(query);
-        return ResponseEntity.ok().body(cases);
-    }
-
-    @PostMapping(value = "/cases/reindex-all")
-    @Operation(summary = "reindex all cases")
-    public ResponseEntity<Void> reindexAllCases() {
-        LOGGER.debug("reindex all cases request received");
-        caseService.reindexAllCases();
-        return ResponseEntity.ok().build();
-    }
-
-    @GetMapping(value = "/cases/metadata")
-    @Operation(summary = "Get cases Metadata")
-    public ResponseEntity<List<CaseInfos>> getMetadata(@RequestParam("ids") List<UUID> ids) {
-        LOGGER.debug("get Case metadata");
-        return ResponseEntity.ok().body(caseService.getMetadata(ids));
-    }
 }

src/main/java/com/powsybl/caseserver/CaseException.java

@@ -21,7 +21,9 @@ public enum Type {
         ILLEGAL_FILE_NAME,
         DIRECTORY_ALREADY_EXISTS,
         DIRECTORY_EMPTY,
-        DIRECTORY_NOT_FOUND
+        DIRECTORY_NOT_FOUND,
+        TEMP_FILE_INIT,
+        TEMP_FILE_PROCESS, TEMP_DIRECTORY_CREATION
     }
 
     private final Type type;
@@ -31,11 +33,16 @@ private CaseException(Type type, String msg) {
         this.type = Objects.requireNonNull(type);
     }
 
+    public CaseException(Type type, String message, Exception e) {
+        super(message, e);
+        this.type = type;
+    }
+
     public Type getType() {
         return type;
     }
 
-    public static CaseException createDirectoryAreadyExists(Path directory) {
+    public static CaseException createDirectoryAreadyExists(String directory) {
         Objects.requireNonNull(directory);
         return new CaseException(Type.DIRECTORY_ALREADY_EXISTS, "A directory with the same name already exists: " + directory);
     }
@@ -55,6 +62,11 @@ public static CaseException createFileNotImportable(Path file) {
         return new CaseException(Type.FILE_NOT_IMPORTABLE, "This file cannot be imported: " + file);
     }
 
+    public static CaseException createFileNotImportable(String file) {
+        Objects.requireNonNull(file);
+        return new CaseException(Type.FILE_NOT_IMPORTABLE, "This file cannot be imported: " + file);
+    }
+
     public static CaseException createStorageNotInitialized(Path storageRootDir) {
         Objects.requireNonNull(storageRootDir);
         return new CaseException(Type.STORAGE_DIR_NOT_CREATED, "The storage is not initialized: " + storageRootDir);
@@ -64,4 +76,28 @@ public static CaseException createIllegalCaseName(String caseName) {
         Objects.requireNonNull(caseName);
         return new CaseException(Type.ILLEGAL_FILE_NAME, "This is not an acceptable case name: " + caseName);
     }
+
+    public static CaseException createTempDirectory(UUID uuid, Exception e) {
+        Objects.requireNonNull(uuid);
+        return new CaseException(Type.TEMP_DIRECTORY_CREATION, "Error creating temporary directory: " + uuid, e);
+    }
+
+    public static CaseException initTempFile(UUID uuid, Exception e) {
+        Objects.requireNonNull(uuid);
+        return new CaseException(Type.TEMP_FILE_INIT, "Error initializing temporary case file: " + uuid, e);
+    }
+
+    public static CaseException initTempFile(UUID uuid) {
+        return CaseException.initTempFile(uuid, null);
+    }
+
+    public static CaseException processTempFile(UUID uuid, Exception e) {
+        Objects.requireNonNull(uuid);
+        return new CaseException(Type.TEMP_FILE_PROCESS, "Error processing temporary case file: " + uuid, e);
+    }
+
+    public static CaseException processTempFile(UUID uuid) {
+        return CaseException.processTempFile(uuid, null);
+    }
+
 }