Feature #14738

Change the signature of the callback in CDIResourceEventListener.
Take into account the change in the signature of the methods in
CDIResourceEventListener in the implementors.

Add a mechanism to notify about the removal of a user in some roles he
played (either explicitly or through a user group) in some component
instances. For doing, two listeners are added:
- ProfileInstUpdateEventListener to listen for update in the list of
  users and groups of a given access right profile of a component
  instance.
- GroupUserUnlinkEventListener to listen for removal of a user from a
  user group (this group could play some roles in some component
  instances).

Add integration tests covering this new mechanism.

Author: mmoqui

core-api/src/main/java/org/silverpeas/core/notification/system/AbstractResourceEvent.java

@@ -28,10 +28,7 @@
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
 import java.io.Serializable;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
 
 /**
  * It is an abstract implementation of a notification event on a resource's state change. It defines
@@ -67,6 +64,7 @@ protected AbstractResourceEvent() {
    * resource is expected:  the first being the resource before the update, the second being the
    * resource after the update (the result of the update).
    */
+  @SafeVarargs
   protected AbstractResourceEvent(Type type, @NotNull T... resource) {
     this.type = type;
     if (type == Type.CREATION) {
@@ -128,16 +126,11 @@ public boolean equals(final Object o) {
     }
 
     final AbstractResourceEvent<?> that = (AbstractResourceEvent<?>) o;
-    if (!transition.equals(that.transition)) {
-      return false;
-    }
-    return type == that.type;
+    return transition.equals(that.transition) && type == that.type;
   }
 
   @Override
   public int hashCode() {
-    int result = type.hashCode();
-    result = 31 * result + transition.hashCode();
-    return result;
+    return Objects.hash(this.type, this.transition);
   }
 }

core-api/src/main/java/org/silverpeas/core/notification/system/CDIAfterSuccessfulTransactionResourceEventListener.java

@@ -41,8 +41,8 @@
  * some of the following methods to transparently receive the events on which they are interested:
  * </p>
  * <p>
- * If the observation is performed into a transaction, all the events are performed just after a
- * successful commit.
+ * If the observation is performed within a transaction, all the events are then just received
+ * after a successful commit.
  * </p>
  * <ul>
  *   <li>{@code org.silverpeas.core.notification.system.ResourceEventListener#onCreation(ResourceEvent} to
@@ -72,7 +72,7 @@ public abstract class CDIAfterSuccessfulTransactionResourceEventListener<T exten
    * @param event an event.
    * @throws Exception if the processing of the event fails.
    */
-  public void onEvent(@Observes(during = AFTER_SUCCESS) T event) throws Exception {
+  public void onEvent(@Observes(during = AFTER_SUCCESS) T event) {
     Transaction.performInNew(() -> {
       try {
         dispatchEvent(event);

core-api/src/main/java/org/silverpeas/core/notification/system/CDIResourceEventListener.java

@@ -64,7 +64,7 @@ public abstract class CDIResourceEventListener<T extends ResourceEvent<?>>
    * @param event an event.
    * @throws Exception if the processing of the event fails.
    */
-  public void onEvent(@Observes T event) throws Exception {
+  public void onEvent(@Observes T event) {
     dispatchEvent(event);
   }
 }

core-api/src/main/java/org/silverpeas/core/notification/system/ResourceEventListener.java

@@ -53,65 +53,58 @@ public interface ResourceEventListener<T extends ResourceEvent<?>> {
    * nonrecoverable. By default, this method does nothing.
    *
    * @param event the event on the deletion of a resource.
-   * @throws java.lang.Exception if an error occurs while treating the event.
    */
-  default void onDeletion(final T event) throws Exception {
+  default void onDeletion(final T event) {
   }
 
   /**
    * An event on the removing of a resource has be listened. A removed resource is again existent
    * and it is recoverable; it is usually put in a trash. By default, this method does nothing.
    *
    * @param event the event on the removing of a resource.
-   * @throws java.lang.Exception if an error occurs while treating the event.
    */
-  default void onRemoving(final T event) throws Exception {
+  default void onRemoving(final T event) {
   }
 
   /**
    * An event on the recovery of a removed resource has be listened. By default, this method does
    * nothing.
    *
    * @param event the event on the removing of a resource.
-   * @throws java.lang.Exception if an error occurs while treating the event.
    */
-  default void onRecovery(final T event) throws Exception {
+  default void onRecovery(final T event) {
   }
 
   /**
    * An event on the update of a resource has be listened. By default, this method does nothing.
    *
    * @param event the event on the update of a resource.
-   * @throws java.lang.Exception if an error occurs while treating the event.
    */
-  default void onUpdate(final T event) throws Exception {
+  default void onUpdate(final T event) {
   }
 
   /**
    * An event on the move of a resource has be listened. By default, this method does nothing.
    *
    * @param event the event on the move of a resource.
-   * @throws java.lang.Exception if an error occurs while treating the event.
    */
-  default void onMove(final T event) throws Exception {
+  default void onMove(final T event) {
   }
 
   /**
    * An event on the creation of a resource has be listened. By default, this method does nothing.
    *
    * @param event the event on the creation of a resource.
-   * @throws java.lang.Exception if an error occurs while treating the event.
    */
-  default void onCreation(final T event) throws Exception {
+  default void onCreation(final T event) {
   }
 
   /**
    * An event on the unlock of a resource has be listened. By default, this method does nothing.
    *
    * @param event the event on the unlock of a resource.
-   * @throws java.lang.Exception if an error occurs while treating the event.
    */
-  default void onUnlock(final T event) throws Exception {
+  default void onUnlock(final T event) {
   }
 
   /**
@@ -135,9 +128,8 @@ default void onUnlock(final T event) throws Exception {
    * </p>
    *
    * @param event the event to dispatch.
-   * @throws java.lang.Exception if an error occurs while treating the event.
    */
-  default void dispatchEvent(final T event) throws Exception {
+  default void dispatchEvent(final T event) {
     if (isEnabled()) {
       switch (event.getType()) {
         case CREATION:

core-library/src/integration-test/java/org/silverpeas/core/admin/user/notification/role/BaseUserRoleEventListenerTest.java

@@ -0,0 +1,176 @@
+/*
+ * Copyright (C) 2000 - 2025 Silverpeas
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * As a special exception to the terms and conditions of version 3.0 of
+ * the GPL, you may redistribute this Program in connection with Free/Libre
+ * Open Source Software ("FLOSS") applications as described in Silverpeas's
+ * FLOSS exception.  You should have received a copy of the text describing
+ * the FLOSS exception, and it is also available here:
+ * "https://www.silverpeas.org/legal/floss_exception.html"
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package org.silverpeas.core.admin.user.notification.role;
+
+import org.jboss.shrinkwrap.api.Archive;
+import org.junit.Before;
+import org.junit.Rule;
+import org.silverpeas.core.admin.service.AdminException;
+import org.silverpeas.core.admin.service.Administration;
+import org.silverpeas.core.admin.user.ProfileInstManager;
+import org.silverpeas.core.admin.user.model.ProfileInst;
+import org.silverpeas.core.admin.user.model.User;
+import org.silverpeas.core.admin.user.notification.role.test.Validator;
+import org.silverpeas.core.cache.service.CacheAccessorProvider;
+import org.silverpeas.core.cache.service.SessionCacheAccessor;
+import org.silverpeas.core.persistence.Transaction;
+import org.silverpeas.core.test.WarBuilder4LibCore;
+import org.silverpeas.core.test.integration.rule.DbSetupRule;
+import org.silverpeas.kernel.SilverpeasRuntimeException;
+
+import javax.inject.Inject;
+import java.util.List;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * Base class of the integration tests on the
+ * {@link org.silverpeas.core.admin.user.notification.role.UserRoleEvent} event listeners.
+ *
+ * @author mmoquillon
+ */
+public abstract class BaseUserRoleEventListenerTest {
+
+  public static final String VALIDATOR_ROLE = "validator";
+  public static final String READER_ROLE = "reader";
+  public static final List<String> NO_IDS = List.of();
+  public static final String INSTANCE_ID = "myComponent1";
+
+  @Rule
+  public DbSetupRule dbSetupRule = DbSetupRule.createTablesFrom("create_database.sql")
+      .loadInitialDataSetFrom("insert_dataset.sql");
+
+  @Inject
+  private ProfileInstManager profileInstManager;
+
+  @Inject
+  private Administration admin;
+
+  public static Archive<?> createTestArchiveFor(Class<? extends BaseUserRoleEventListenerTest> test) {
+    return WarBuilder4LibCore.onWarForTestClass(test)
+        .addSilverpeasExceptionBases()
+        .addAdministrationFeatures()
+        .addDatabaseToolFeatures()
+        .addJpaPersistenceFeatures()
+        .addPublicationTemplateFeatures()
+        .addAsResource("org/silverpeas/core/admin/user/notification/role")
+        .testFocusedOn(warBuilder ->
+            warBuilder.addPackages(true, test.getPackageName()))
+        .build();
+  }
+
+  @Before
+  public void setUpCurrentRequester() {
+    SessionCacheAccessor sessionCacheAccessor =
+        CacheAccessorProvider.getSessionCacheAccessor();
+    sessionCacheAccessor.newSessionCache(User.getById("1"));
+  }
+
+  @Before
+  public void reloadAdminCache() {
+    admin.reloadCache();
+  }
+
+  public ProfileInst getProfileInst(String roleName) {
+    String id;
+    switch (roleName) {
+      case "admin":
+        id = "1";
+        break;
+      case VALIDATOR_ROLE:
+        id = "2";
+        break;
+      default:
+        id = "3";
+        break;
+    }
+    return getProfileInstById(id);
+  }
+
+  public ProfileInst getProfileInstById(String id) {
+    return Transaction.performInOne(() -> {
+      try {
+        return profileInstManager.getProfileInst(id, false);
+      } catch (AdminException e) {
+        throw new SilverpeasRuntimeException(e);
+      }
+    });
+  }
+
+  public void updateProfileInst(ProfileInst profileInst) {
+    Transaction.performInOne(() -> {
+      try {
+        profileInstManager.updateProfileInst(profileInst);
+      } catch (AdminException e) {
+        throw new SilverpeasRuntimeException(e);
+      }
+      return null;
+    });
+  }
+
+  private String createProfileInst(ProfileInst profileInst) {
+    return Transaction.performInOne(() -> {
+      try {
+        return profileInstManager.createProfileInst(profileInst,
+            profileInst.getComponentFatherId());
+      } catch (AdminException e) {
+        throw new SilverpeasRuntimeException(e);
+      }
+    });
+  }
+
+  public void setUpProfileInstWith(String profileName, List<String> users, List<String> groups) {
+    ProfileInst initialProfile = getProfileInst(profileName);
+    initialProfile.getAllUsers().addAll(users);
+    initialProfile.getAllGroups().addAll(groups);
+    updateProfileInst(initialProfile);
+  }
+
+  public String setUpInheritedProfileInstWith(String profileName, List<String> users,
+      List<String> groups) {
+    ProfileInst initialProfile = new ProfileInst();
+    initialProfile.setComponentFatherId(1);
+    initialProfile.setInherited(true);
+    initialProfile.setName(profileName);
+    initialProfile.setLabel(profileName);
+    initialProfile.getAllUsers().addAll(users);
+    initialProfile.getAllGroups().addAll(groups);
+    return createProfileInst(initialProfile);
+  }
+
+  public static void assertValidatorsEquality(List<Validator> actualValidators,
+      List<Validator> expectedValidators) {
+      assertEquals(expectedValidators.size(), actualValidators.size());
+      assertTrue(actualValidators.containsAll(expectedValidators));
+  }
+
+  public static void assertValidatorIsRemoved(String validatorId,
+      List<Validator> actualValidators) {
+    assertTrue(actualValidators.stream()
+        .noneMatch(v -> v.getUserId().equals(validatorId)));
+  }
+}
+