Standardize exception handling

pom.xml

@@ -161,6 +161,12 @@
 
     <dependencyManagement>
         <dependencies>
+            <!-- TODO remove when gridsuite-dependencies is released with this version -->
+            <dependency>
+                <groupId>com.powsybl</groupId>
+                <artifactId>powsybl-ws-commons</artifactId>
+                <version>1.30.0</version>
+            </dependency>
             <!-- imports -->
             <dependency>
                 <groupId>org.gridsuite</groupId>

src/main/java/org/gridsuite/directory/server/PropertyServerNameProvider.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 org.gridsuite.directory.server;
+
+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:directory-server}") String name) {
+        this.name = name;
+    }
+
+    @Override
+    public String serverName() {
+        return name;
+    }
+}

src/main/java/org/gridsuite/directory/server/error/DirectoryBusinessErrorCode.java

@@ -0,0 +1,33 @@
+/**
+ * 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 org.gridsuite.directory.server.error;
+
+import com.powsybl.ws.commons.error.BusinessErrorCode;
+
+/**
+ * @author Mohamed Ben-rejeb {@literal <mohamed.ben-rejeb at rte-france.com>}
+ *
+ * Business error codes emitted by the directory service.
+ */
+public enum DirectoryBusinessErrorCode implements BusinessErrorCode {
+    DIRECTORY_PERMISSION_DENIED("directory.permissionDenied"),
+    DIRECTORY_ELEMENT_NAME_BLANK("directory.elementNameBlank"),
+    DIRECTORY_NOT_DIRECTORY("directory.notDirectory"),
+    DIRECTORY_ELEMENT_NAME_CONFLICT("directory.elementNameConflict"),
+    DIRECTORY_MOVE_IN_DESCENDANT_NOT_ALLOWED("directory.moveInDescendantNotAllowed"),
+    DIRECTORY_SOME_ELEMENTS_ARE_MISSING("directory.someElementsAreMissing"),
+    DIRECTORY_ELEMENT_NOT_FOUND("directory.elementNotFound");
+    private final String code;
+
+    DirectoryBusinessErrorCode(String code) {
+        this.code = code;
+    }
+
+    public String value() {
+        return code;
+    }
+}

src/main/java/org/gridsuite/directory/server/error/DirectoryException.java

@@ -0,0 +1,49 @@
+/**
+ * Copyright (c) 2021, 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 org.gridsuite.directory.server.error;
+
+import com.powsybl.ws.commons.error.AbstractBusinessException;
+import lombok.NonNull;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Objects;
+import java.util.UUID;
+
+/**
+ * @author Abdelsalem Hedhili <abdelsalem.hedhili at rte-france.com>
+ * @author Mohamed Ben-rejeb {@literal <mohamed.ben-rejeb at rte-france.com>}
+ */
+public class DirectoryException extends AbstractBusinessException {
+
+    private final DirectoryBusinessErrorCode errorCode;
+
+    public DirectoryException(DirectoryBusinessErrorCode errorCode, String message) {
+        super(Objects.requireNonNull(message, "message must not be null"));
+        this.errorCode = Objects.requireNonNull(errorCode, "errorCode must not be null");
+    }
+
+    public static DirectoryException createElementNotFound(@NonNull String type, @NonNull UUID uuid) {
+        return new DirectoryException(DirectoryBusinessErrorCode.DIRECTORY_ELEMENT_NOT_FOUND,
+                String.format("%s '%s' not found !", type, uuid));
+    }
+
+    public static DirectoryException createElementNameAlreadyExists(@NonNull String name) {
+        return new DirectoryException(DirectoryBusinessErrorCode.DIRECTORY_ELEMENT_NAME_CONFLICT,
+                String.format("Element with the same name '%s' already exists in the directory !", name));
+    }
+
+    public static DirectoryException of(DirectoryBusinessErrorCode errorCode, String message, Object... args) {
+        return new DirectoryException(errorCode, args.length == 0 ? message : String.format(message, args));
+    }
+
+    @NotNull
+    @Override
+    public DirectoryBusinessErrorCode getBusinessErrorCode() {
+        return errorCode;
+    }
+
+}

src/main/java/org/gridsuite/directory/server/error/RestResponseEntityExceptionHandler.java

@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) 2021, 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 org.gridsuite.directory.server.error;
+
+import com.powsybl.ws.commons.error.AbstractBaseRestExceptionHandler;
+import com.powsybl.ws.commons.error.ServerNameProvider;
+import org.jetbrains.annotations.NotNull;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+
+/**
+ * @author Abdelsalem Hedhili <abdelsalem.hedhili at rte-france.com>
+ * @author Mohamed Ben-rejeb {@literal <mohamed.ben-rejeb at rte-france.com>}
+ */
+@ControllerAdvice
+public class RestResponseEntityExceptionHandler
+    extends AbstractBaseRestExceptionHandler<DirectoryException, DirectoryBusinessErrorCode> {
+
+    public RestResponseEntityExceptionHandler(ServerNameProvider serverNameProvider) {
+        super(serverNameProvider);
+    }
+
+    @NotNull
+    @Override
+    protected DirectoryBusinessErrorCode getBusinessCode(DirectoryException ex) {
+        return ex.getBusinessErrorCode();
+    }
+
+    @Override
+    protected HttpStatus mapStatus(DirectoryBusinessErrorCode errorCode) {
+        return switch (errorCode) {
+            case DIRECTORY_ELEMENT_NOT_FOUND, DIRECTORY_SOME_ELEMENTS_ARE_MISSING -> HttpStatus.NOT_FOUND;
+            case DIRECTORY_ELEMENT_NAME_CONFLICT -> HttpStatus.CONFLICT;
+            case DIRECTORY_PERMISSION_DENIED,
+                 DIRECTORY_ELEMENT_NAME_BLANK,
+                 DIRECTORY_NOT_DIRECTORY,
+                 DIRECTORY_MOVE_IN_DESCENDANT_NOT_ALLOWED -> HttpStatus.FORBIDDEN;
+        };
+    }
+
+}

src/test/java/org/gridsuite/directory/server/AccessRightsControlTest.java

@@ -311,7 +311,7 @@ public void testElements() throws Exception {
     public void testExistence() throws Exception {
         // Insert root directory with same name not allowed
         UUID rootUuid1 = insertRootDirectory("user1", "root1");
-        insertRootDirectory("user1", "root1", HttpStatus.FORBIDDEN);
+        insertRootDirectory("user1", "root1", HttpStatus.CONFLICT);
 
         // Insert elements with same name in a directory not allowed
         UUID dirUuid1 = insertSubElement(rootUuid1, toElementAttributes(null, "dir1", DIRECTORY, "user1"));

src/test/java/org/gridsuite/directory/server/DirectoryBusinessErrorCodeTest.java

@@ -0,0 +1,25 @@
+/**
+ * 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 org.gridsuite.directory.server;
+
+import org.gridsuite.directory.server.error.DirectoryBusinessErrorCode;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.EnumSource;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Mohamed Ben-rejeb {@literal <mohamed.ben-rejeb at rte-france.com>}
+ */
+class DirectoryBusinessErrorCodeTest {
+
+    @ParameterizedTest
+    @EnumSource(DirectoryBusinessErrorCode.class)
+    void valueMatchesEnumName(DirectoryBusinessErrorCode code) {
+        assertThat(code.value()).startsWith("directory.");
+    }
+}

src/test/java/org/gridsuite/directory/server/DirectoryExceptionTest.java

@@ -0,0 +1,38 @@
+/**
+ * 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 org.gridsuite.directory.server;
+
+import org.gridsuite.directory.server.error.DirectoryBusinessErrorCode;
+import org.gridsuite.directory.server.error.DirectoryException;
+import org.junit.jupiter.api.Test;
+
+import java.util.UUID;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Mohamed Ben-rejeb {@literal <mohamed.ben-rejeb at rte-france.com>}
+ */
+class DirectoryExceptionTest {
+
+    @Test
+    void staticFactoriesProduceExpectedMessages() {
+        DirectoryException notFound = DirectoryException.createElementNotFound("Folder", UUID.fromString("123e4567-e89b-12d3-a456-426614174000"));
+        assertThat(notFound.getMessage()).contains("Folder");
+        assertThat(notFound.getBusinessErrorCode()).isEqualTo(DirectoryBusinessErrorCode.DIRECTORY_ELEMENT_NOT_FOUND);
+
+        DirectoryException conflict = DirectoryException.createElementNameAlreadyExists("report");
+        assertThat(conflict.getMessage()).contains("report");
+        assertThat(conflict.getBusinessErrorCode()).isEqualTo(DirectoryBusinessErrorCode.DIRECTORY_ELEMENT_NAME_CONFLICT);
+
+        DirectoryException formatted = DirectoryException.of(DirectoryBusinessErrorCode.DIRECTORY_ELEMENT_NAME_BLANK,
+            "Element '%s' invalid", "x");
+        assertThat(formatted.getMessage()).isEqualTo("Element 'x' invalid");
+        assertThat(formatted.getBusinessErrorCode()).isEqualTo(DirectoryBusinessErrorCode.DIRECTORY_ELEMENT_NAME_BLANK);
+    }
+
+}

src/test/java/org/gridsuite/directory/server/DirectoryServiceTest.java

@@ -9,6 +9,7 @@
 import org.gridsuite.directory.server.dto.ElementAttributes;
 import org.gridsuite.directory.server.dto.RootDirectoryAttributes;
 import org.gridsuite.directory.server.elasticsearch.DirectoryElementInfosRepository;
+import org.gridsuite.directory.server.error.DirectoryException;
 import org.gridsuite.directory.server.repository.DirectoryElementEntity;
 import org.gridsuite.directory.server.repository.DirectoryElementRepository;
 import org.gridsuite.directory.server.utils.elasticsearch.DisableElasticsearch;
@@ -28,6 +29,7 @@
 import static org.gridsuite.directory.server.dto.ElementAttributes.toElementAttributes;
 import static org.gridsuite.directory.server.utils.DirectoryTestUtils.createElement;
 import static org.gridsuite.directory.server.utils.DirectoryTestUtils.createRootElement;
+import static org.gridsuite.directory.server.error.DirectoryBusinessErrorCode.*;
 import static org.junit.jupiter.api.Assertions.*;
 import static org.mockito.Mockito.*;
 
@@ -118,7 +120,7 @@ void testDirectoryElementUniqueness() {
 
         // Insert the same element in the same directory throws an exception
         DirectoryException directoryException = assertThrows(DirectoryException.class, () -> directoryService.createElement(elementAttributes, rootUuid, "User1", false));
-        assertEquals(DirectoryException.Type.NAME_ALREADY_EXISTS, directoryException.getType());
+        assertEquals(DIRECTORY_ELEMENT_NAME_CONFLICT, directoryException.getBusinessErrorCode());
         assertEquals(DirectoryException.createElementNameAlreadyExists(elementAttributes.getElementName()).getMessage(), directoryException.getMessage());
 
         // Insert the same element in the same directory with new name generation does not throw an exception
@@ -137,7 +139,7 @@ void testDirectoryElementUniqueness() {
         InOrder inOrder = inOrder(directoryService);
         when(directoryService.getDuplicateNameCandidate(root2Uuid, elementAttributes.getElementName(), elementAttributes.getType(), "User1")).thenReturn(elementAttributes.getElementName());
         directoryException = assertThrows(DirectoryException.class, () -> directoryService.duplicateElement(element2Uuid, root2Uuid, root2Uuid, "User1"));
-        assertEquals(DirectoryException.Type.NAME_ALREADY_EXISTS, directoryException.getType());
+        assertEquals(DIRECTORY_ELEMENT_NAME_CONFLICT, directoryException.getBusinessErrorCode());
         assertEquals(DirectoryException.createElementNameAlreadyExists(elementAttributes.getElementName()).getMessage(), directoryException.getMessage());
         inOrder.verify(directoryService, calls(MAX_RETRY)).getDuplicateNameCandidate(root2Uuid, elementAttributes.getElementName(), elementAttributes.getType(), "User1");
     }
@@ -203,7 +205,7 @@ void testMoveElement() {
         // move directory to it's descendent
         List<UUID> list = List.of(dirUuid); // Just for Sonar issue (assertThrows)
         DirectoryException exception1 = assertThrows(DirectoryException.class, () -> directoryService.moveElementsDirectory(list, subDirUuid, "user1"));
-        assertEquals(DirectoryException.Type.MOVE_IN_DESCENDANT_NOT_ALLOWED, exception1.getType());
+        assertEquals(DIRECTORY_MOVE_IN_DESCENDANT_NOT_ALLOWED, exception1.getBusinessErrorCode());
     }
 
     @Test
@@ -231,6 +233,6 @@ void testMoveInNotDirectory() {
 
         List<UUID> list = List.of(elementUuid1); // Just for Sonar issue (assertThrows)
         DirectoryException exception2 = assertThrows(DirectoryException.class, () -> directoryService.moveElementsDirectory(list, elementUuid2, "user1"));
-        assertEquals(DirectoryException.Type.NOT_DIRECTORY, exception2.getType());
+        assertEquals(DIRECTORY_NOT_DIRECTORY, exception2.getBusinessErrorCode());
     }
 }