Migration to the new error management system (#137)

Signed-off-by: benrejebmoh <mohamed.ben-rejeb@rte-france.com>

Author: benrejebmoh

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

@@ -8,6 +8,7 @@
 
 import com.powsybl.caseserver.dto.CaseInfos;
 import com.powsybl.caseserver.elasticsearch.CaseInfosService;
+import com.powsybl.caseserver.error.CaseRuntimeException;
 import com.powsybl.caseserver.service.CaseObserver;
 import com.powsybl.caseserver.service.MetadataService;
 import com.powsybl.caseserver.service.CaseService;
@@ -35,7 +36,6 @@
 import java.util.Optional;
 import java.util.UUID;
 
-import static com.powsybl.caseserver.CaseException.createDirectoryNotFound;
 import static com.powsybl.caseserver.Utils.buildHeaders;
 
 /**
@@ -90,7 +90,7 @@ public ResponseEntity<CaseInfos> getCaseInfos(@PathVariable("caseUuid") UUID cas
     public ResponseEntity<String> getCaseFormat(@PathVariable("caseUuid") UUID caseUuid) {
         LOGGER.debug("getCaseFormat request received");
         if (!caseService.caseExists(caseUuid)) {
-            throw createDirectoryNotFound(caseUuid);
+            throw CaseRuntimeException.directoryNotFound(caseUuid);
         }
         String caseFormat = caseService.getFormat(caseUuid);
         return ResponseEntity.ok().body(caseFormat);
@@ -101,7 +101,7 @@ public ResponseEntity<String> getCaseFormat(@PathVariable("caseUuid") UUID caseU
     public ResponseEntity<String> getCaseName(@PathVariable("caseUuid") UUID caseUuid) {
         LOGGER.debug("getCaseName request received");
         if (!caseService.caseExists(caseUuid)) {
-            throw createDirectoryNotFound(caseUuid);
+            throw CaseRuntimeException.directoryNotFound(caseUuid);
         }
         String caseName = caseService.getCaseName(caseUuid);
         return ResponseEntity.ok().body(caseName);
@@ -194,7 +194,7 @@ public ResponseEntity<Void> disableCaseExpiration(@PathVariable("caseUuid") UUID
     public ResponseEntity<Void> deleteCase(@PathVariable("caseUuid") UUID caseUuid) {
         LOGGER.debug("deleteCase request received with parameter caseUuid = {}", caseUuid);
         if (!caseService.caseExists(caseUuid)) {
-            throw createDirectoryNotFound(caseUuid);
+            throw CaseRuntimeException.directoryNotFound(caseUuid);
         }
         caseService.deleteCase(caseUuid);
         return ResponseEntity.ok().build();

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

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.caseserver;
+
+import com.powsybl.ws.commons.error.ServerNameProvider;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Component;
+
+/**
+ * @author Mohamed Ben-rejeb {@literal <mohamed.ben-rejeb at rte-france.com>}
+ */
+@Component
+public class PropertyServerNameProvider implements ServerNameProvider {
+
+    private final String name;
+
+    public PropertyServerNameProvider(@Value("${spring.application.name:powsybl-case-server}") String name) {
+        this.name = name;
+    }
+
+    @Override
+    public String serverName() {
+        return name;
+    }
+}

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

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2026, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.caseserver.error;
+
+import com.powsybl.ws.commons.error.BusinessErrorCode;
+
+/**
+ * @author Mohamed Ben-rejeb <mohamed.ben-rejeb at rte-france.com>
+ */
+public enum CaseBusinessErrorCode implements BusinessErrorCode {
+    NO_AVAILABLE_IMPORTER("case.noAvailableImporter"),
+    ILLEGAL_FILE_NAME("case.illegalFileName");
+    private final String code;
+    CaseBusinessErrorCode(String code) {
+        this.code = code;
+    }
+
+    public String value() {
+        return code;
+    }
+}

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

@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) 2026, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.caseserver.error;
+
+import com.powsybl.ws.commons.error.AbstractBusinessException;
+import lombok.Getter;
+import lombok.NonNull;
+
+import java.nio.file.Path;
+import java.util.Objects;
+
+/**
+ * @author Abdelsalem Hedhili <abdelsalem.hedhili at rte-france.com>
+ * @author Mohamed Ben-rejeb <mohamed.ben-rejeb at rte-france.com>
+ */
+@Getter
+public final class CaseBusinessException extends AbstractBusinessException {
+
+    private final CaseBusinessErrorCode errorCode;
+
+    private CaseBusinessException(CaseBusinessErrorCode errorCode, String message) {
+        super(Objects.requireNonNull(message, "message must not be null"));
+        this.errorCode = Objects.requireNonNull(errorCode, "errorCode must not be null");
+    }
+
+    public static CaseBusinessException createIllegalCaseName(String caseName) {
+        Objects.requireNonNull(caseName);
+        return new CaseBusinessException(CaseBusinessErrorCode.ILLEGAL_FILE_NAME, "This is not an acceptable case name: " + caseName);
+    }
+
+    public static CaseBusinessException noAvailableImporter(Path file) {
+        Objects.requireNonNull(file);
+        return new CaseBusinessException(CaseBusinessErrorCode.NO_AVAILABLE_IMPORTER, "No available importer found for this file: " + file);
+    }
+
+    @NonNull
+    @Override
+    public CaseBusinessErrorCode getBusinessErrorCode() {
+        return errorCode;
+    }
+}

src/main/java/com/powsybl/caseserver/error/CaseBusinessErrorCode.java

@@ -0,0 +1,46 @@
+/**
+ * Copyright (c) 2026, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.caseserver.error;
+
+import com.powsybl.caseserver.PropertyServerNameProvider;
+import com.powsybl.ws.commons.error.AbstractBusinessExceptionHandler;
+import com.powsybl.ws.commons.error.PowsyblWsProblemDetail;
+import jakarta.servlet.http.HttpServletRequest;
+import lombok.NonNull;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+
+/**
+ * @author Abdelsalem Hedhili <abdelsalem.hedhili at rte-france.com>
+ * @author Mohamed Ben-rejeb <mohamed.ben-rejeb at rte-france.com>
+ */
+@ControllerAdvice
+public class CaseExceptionHandler extends AbstractBusinessExceptionHandler<CaseBusinessException, CaseBusinessErrorCode> {
+    protected CaseExceptionHandler(PropertyServerNameProvider serverNameProvider) {
+        super(serverNameProvider);
+    }
+
+    @Override
+    protected @NonNull CaseBusinessErrorCode getBusinessCode(CaseBusinessException e) {
+        return e.getBusinessErrorCode();
+    }
+
+    @ExceptionHandler(CaseBusinessException.class)
+    protected ResponseEntity<PowsyblWsProblemDetail> handleCaseBusinessException(
+        CaseBusinessException exception, HttpServletRequest request) {
+        return super.handleDomainException(exception, request);
+    }
+
+    @Override
+    protected HttpStatus mapStatus(CaseBusinessErrorCode errorCode) {
+        return switch (errorCode) {
+            case NO_AVAILABLE_IMPORTER, ILLEGAL_FILE_NAME -> HttpStatus.UNPROCESSABLE_ENTITY;
+        };
+    }
+}

src/main/java/com/powsybl/caseserver/error/CaseBusinessException.java

@@ -0,0 +1,50 @@
+/**
+ * Copyright (c) 2026, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.caseserver.error;
+
+import java.nio.file.Path;
+import java.util.Objects;
+import java.util.UUID;
+
+/**
+ * @author Mohamed Ben-rejeb <mohamed.ben-rejeb at rte-france.com>
+ */
+public class CaseRuntimeException extends RuntimeException {
+
+    public CaseRuntimeException(String message) {
+        super(message);
+    }
+
+    public CaseRuntimeException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    public static CaseRuntimeException directoryNotFound(UUID uuid) {
+        Objects.requireNonNull(uuid);
+        return new CaseRuntimeException("The directory with the following uuid doesn't exist: " + uuid);
+    }
+
+    public static CaseRuntimeException originalFileNotFound(UUID uuid) {
+        Objects.requireNonNull(uuid);
+        return new CaseRuntimeException("The original file were not retrieved in the directory with the following uuid: " + uuid);
+    }
+
+    public static CaseRuntimeException tempDirectoryCreation(UUID uuid, Exception e) {
+        Objects.requireNonNull(uuid);
+        return new CaseRuntimeException("Error creating temporary directory: " + uuid, e);
+    }
+
+    public static CaseRuntimeException initTempFile(UUID uuid, Throwable e) {
+        Objects.requireNonNull(uuid);
+        return new CaseRuntimeException("Error initializing temporary case file: " + uuid, e);
+    }
+
+    public static CaseRuntimeException fileNotImportable(Path file, Exception e) {
+        Objects.requireNonNull(file);
+        return new CaseRuntimeException("This file cannot be imported: " + file + " details: " + e.getMessage());
+    }
+}