Feature #14033

Now the creation and the deletion of a community of users is notified.
This can be used for external components to access the newly created
commiunity of users in order to perform some post-processing with the
community.

New CommunityOfUsers#getGroupOfMembers() method. This method returns the
group of members in the community. If such a group doesn't yet exist,
then it is created for the community of users. It is a way to get all
the actual members of a community without having to filter the
memberships by their status.

New CommunityOfUsers#getAll() static method to get all the existing
community of users.

Author: mmoqui

community/community-library/src/integration-test/java/org/silverpeas/components/community/CommunityAppIT.java

@@ -85,7 +85,7 @@ public void initCurrentRequester() {
   public void createANewAppInstanceShouldCreateACommunity() throws AdminException, QuotaException {
     Administration admin = Administration.get();
     User user = User.getCurrentUser();
-    ComponentInst componentInst = newCommunityAppInstance();
+    ComponentInst componentInst = TestScope.newCommunityAppInstance();
     String instanceId = admin.addComponentInst(user.getId(), componentInst);
 
     SpaceInst spaceInst = admin.getSpaceInstById(componentInst.getSpaceId());
@@ -109,18 +109,4 @@ public void deleteAnExistingAppInstanceShouldDeleteTheCommunity() throws AdminEx
     Optional<CommunityOfUsers> community = CommunityOfUsers.getByComponentInstanceId(instanceId);
     assertThat(community.isEmpty(), is(true));
   }
-
-  private static ComponentInst newCommunityAppInstance() {
-    ComponentInst componentInst = new ComponentInst();
-    componentInst.setDomainFatherId("WA4");
-    componentInst.setCreatorUserId(User.getCurrentUser().getId());
-    componentInst.setName("community");
-    componentInst.setLabel("WA4 Community");
-    componentInst.setDescription("Community of users for space WA4");
-    componentInst.setPublic(true);
-    componentInst.setHidden(false);
-    componentInst.setInheritanceBlocked(true);
-    componentInst.setParameters(new ArrayList<>());
-    return componentInst;
-  }
 }

community/community-library/src/integration-test/java/org/silverpeas/components/community/CommunityManagementIT.java

@@ -111,6 +111,16 @@ public void getAnExistingCommunity() {
     assertThat(actualCommunity.getCharterURL().toString(), is("https://www.silverpeas.org"));
   }
 
+  @Test
+  public void getAllExistingCommunities() {
+    List<String> appIds = List.of("community1", "community2", "community3");
+    List<CommunityOfUsers> communities = CommunityOfUsers.getAll();
+    assertThat(communities.size(), is(3));
+    boolean matches =
+        communities.stream().allMatch(c -> appIds.contains(c.getComponentInstanceId()));
+    assertThat(matches, is(true));
+  }
+
   @Test
   public void getANonExistingCommunity() {
     String instanceId = "community100";

community/community-library/src/integration-test/java/org/silverpeas/components/community/CommunityNotificationIT.java

@@ -0,0 +1,122 @@
+/*
+ * Copyright (C) 2000 - 2024 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:
+ * "http://www.silverpeas.com/legal/licensing"
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+package org.silverpeas.components.community;
+
+import org.jboss.arquillian.container.test.api.Deployment;
+import org.jboss.arquillian.junit.Arquillian;
+import org.jboss.shrinkwrap.api.Archive;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.silverpeas.components.community.model.CommunityOfUsers;
+import org.silverpeas.components.community.notification.CommunityEvent;
+import org.silverpeas.core.admin.component.model.ComponentInst;
+import org.silverpeas.core.admin.service.Administration;
+import org.silverpeas.core.admin.user.model.User;
+import org.silverpeas.core.annotation.Bean;
+import org.silverpeas.core.cache.service.CacheAccessorProvider;
+import org.silverpeas.core.cache.service.SessionCacheAccessor;
+import org.silverpeas.core.notification.system.CDIResourceEventListener;
+import org.silverpeas.core.test.integration.rule.DbSetupRule;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.*;
+
+/**
+ * Integration tests on the notification about the creation and the deletion of a community of
+ * users.
+ * @author mmoquillon
+ */
+@RunWith(Arquillian.class)
+public class CommunityNotificationIT {
+
+  private static final String DATABASE_CREATION_SCRIPT = "/community-database.sql";
+
+  private static final String DATASET_SCRIPT = "/community-dataset.sql";
+
+  @Rule
+  public DbSetupRule dbSetupRule = DbSetupRule.createTablesFrom(DATABASE_CREATION_SCRIPT)
+      .loadInitialDataSetFrom(DATASET_SCRIPT);
+
+  @Deployment
+  public static Archive<?> createTestArchive() {
+    return CommunityWarBuilder.onWarForTestClass(CommunityAppIT.class)
+        .initJcr()
+        .addAsResource("org/silverpeas/publication/publicationSettings.properties")
+        .addAsResource("org/silverpeas/publicationTemplate/settings/mapping.properties")
+        .addAsResource("org/silverpeas/publicationTemplate/settings/template.properties")
+        .addAsResource(DATABASE_CREATION_SCRIPT.substring(1))
+        .addAsResource(DATASET_SCRIPT.substring(1))
+        .build();
+  }
+
+  @Before
+  public void initCurrentRequester() {
+    SessionCacheAccessor sessionCacheAccessor =
+        CacheAccessorProvider.getSessionCacheAccessor();
+    sessionCacheAccessor.newSessionCache(User.getById("0"));
+  }
+
+  @Test
+  public void toBeNotifiedAtCommunityCreation() throws Exception {
+    Administration admin = Administration.get();
+    User user = User.getCurrentUser();
+    ComponentInst componentInst = TestScope.newCommunityAppInstance();
+    admin.addComponentInst(user.getId(), componentInst);
+  }
+
+  @Test
+  public void toBeNotifiedAtCommunityDeletion() throws Exception {
+    User admin = User.getCurrentUser();
+    String instanceId = "community2";
+    Administration.get().deleteComponentInst(admin.getId(), instanceId, true);
+  }
+
+  @Bean
+  public static class CommunityEventListener extends CDIResourceEventListener<CommunityEvent> {
+
+
+    @Override
+    public void onDeletion(CommunityEvent event) {
+      CommunityOfUsers community = event.getTransition().getBefore();
+      assertThat(community.isPersisted(), is(false));
+      var optionalCommunity =
+          CommunityOfUsers.getByComponentInstanceId(community.getComponentInstanceId());
+      assertThat(optionalCommunity.isEmpty(), is(true));
+    }
+
+    @Override
+    public void onCreation(CommunityEvent event) {
+      CommunityOfUsers community = event.getTransition().getAfter();
+      assertThat(community, is(notNullValue()));
+      assertThat(community.isPersisted(), is(true));
+      assertThat(community.getGroupOfMembers(), is(notNullValue()));
+      assertThat(community.getGroupOfMembers().getAllUsers(), is(empty()));
+      assertThat(community.getGroupOfMembers().getSubGroups(), is(empty()));
+    }
+  }
+}
+  

community/community-library/src/integration-test/java/org/silverpeas/components/community/TestScope.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (C) 2000 - 2024 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:
+ * "http://www.silverpeas.com/legal/licensing"
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+package org.silverpeas.components.community;
+
+import org.silverpeas.core.admin.component.model.ComponentInst;
+import org.silverpeas.core.admin.user.model.User;
+
+import java.util.ArrayList;
+
+/**
+ * Scope of a running integration test. It provides useful and utility methods for tests.
+ * @author mmoquillon
+ */
+public class TestScope {
+
+  public static ComponentInst newCommunityAppInstance() {
+    ComponentInst componentInst = new ComponentInst();
+    componentInst.setDomainFatherId("WA4");
+    componentInst.setCreatorUserId(User.getCurrentUser().getId());
+    componentInst.setName("community");
+    componentInst.setLabel("WA4 Community");
+    componentInst.setDescription("Community of users for space WA4");
+    componentInst.setPublic(true);
+    componentInst.setHidden(false);
+    componentInst.setInheritanceBlocked(true);
+    componentInst.setParameters(new ArrayList<>());
+    return componentInst;
+  }
+}
+  

community/community-library/src/main/java/org/silverpeas/components/community/CommunityInstancePostConstruction.java

@@ -24,7 +24,9 @@
 package org.silverpeas.components.community;
 
 import org.silverpeas.components.community.model.CommunityOfUsers;
+import org.silverpeas.components.community.notification.CommunityEventNotifier;
 import org.silverpeas.components.community.repository.CommunityOfUsersRepository;
+import org.silverpeas.core.notification.system.ResourceEvent;
 import org.silverpeas.kernel.SilverpeasRuntimeException;
 import org.silverpeas.core.admin.component.ComponentInstancePostConstruction;
 import org.silverpeas.core.admin.component.model.ComponentInst;
@@ -54,19 +56,24 @@ public class CommunityInstancePostConstruction implements ComponentInstancePostC
   @Inject
   private CommunityOfUsersRepository repository;
 
+  @Inject
+  private CommunityEventNotifier notifier;
+
 
   @Transactional
   @Override
   public void postConstruct(final String componentInstanceId) {
     ComponentInst instance = getComponentInst(componentInstanceId);
     SpaceInst spaceInst = getSpaceInst(instance.getSpaceId());
     CommunityOfUsers community = new CommunityOfUsers(instance.getId(), spaceInst.getId());
-    repository.save(community);
+    CommunityOfUsers savedCommunity = repository.save(community);
 
     spaceInst.setFirstPageExtraParam(componentInstanceId);
     spaceInst.setInheritanceBlocked(true);
     spaceInst.setFirstPageType(SpaceHomePageType.COMPONENT_INST.ordinal());
     updateSpaceInst(spaceInst);
+
+    notifier.notifyEventOn(ResourceEvent.Type.CREATION, savedCommunity);
   }
 
   private ComponentInst getComponentInst(final String instanceId) {

community/community-library/src/main/java/org/silverpeas/components/community/CommunityInstancePreDestruction.java

@@ -23,11 +23,13 @@
  */
 package org.silverpeas.components.community;
 
+import org.silverpeas.components.community.notification.CommunityEventNotifier;
 import org.silverpeas.components.community.repository.CommunityMembershipRepository;
 import org.silverpeas.components.community.repository.CommunityOfUsersRepository;
 import org.silverpeas.core.admin.component.ComponentInstancePreDestruction;
 import org.silverpeas.core.annotation.Bean;
 import org.silverpeas.core.contribution.model.WysiwygContent;
+import org.silverpeas.core.notification.system.ResourceEvent;
 
 import javax.inject.Inject;
 import javax.inject.Named;
@@ -45,6 +47,8 @@ public class CommunityInstancePreDestruction implements ComponentInstancePreDest
   private CommunityOfUsersRepository communitiesRepository;
   @Inject
   private CommunityMembershipRepository membersRepository;
+  @Inject
+  private CommunityEventNotifier notifier;
 
   @Transactional
   @Override
@@ -58,6 +62,7 @@ public void preDestroy(final String componentInstanceId) {
       membersRepository.getMembershipsTable(c).deleteAll();
       // delete finally the community of users
       c.delete();
+      notifier.notifyEventOn(ResourceEvent.Type.DELETION, c);
     });
   }
 }

community/community-library/src/main/java/org/silverpeas/components/community/model/CommunityOfUsers.java

@@ -70,9 +70,12 @@
  * difference is the community space is visible to all users of the platform without requiring this
  * space to be public; they have just a view of it and of its presentation page.
  * <p>
- * The actual members of a community of users are all included in a specific group of users
- * that is automatically created lazily when a first member joins the community. This group of
- * members is a easy way to access all the members of the community.
+ * The actual members of a community of users are all included in a specific group of users that is
+ * automatically created when the community is spawned. This group of members is kept up-to-date
+ * with the users playing a role in the community space. The group of members allow to get in one
+ * shot all the actual members of the community. To have a glance about the memberships to the
+ * community, passed, actual and pending, please asks to the {@link CommunityMembershipsProvider}
+ * object associated with the community of users.
  * </p>
  */
 @Entity
@@ -130,6 +133,15 @@ public CommunityOfUsers(final String componentInstanceId, final String spaceId)
     this.communitySpace = new CommunitySpace(this);
   }
 
+  /**
+   * Gets all the communities of users existing in Silverpeas.
+   * @return a list of exiting community of users.
+   */
+  public static List<CommunityOfUsers> getAll() {
+    CommunityOfUsersRepository repository = CommunityOfUsersRepository.get();
+    return repository.getAll();
+  }
+
   /**
    * Gets the community of users managed by the specified component instance. If the component
    * instance doesn't exist then nothing is returned.
@@ -403,6 +415,36 @@ public void delete() {
     });
   }
 
+  /**
+   * Gets the group of all the members of this community of users. If this community isn't
+   * persisted, null is returned. Otherwise the group of members of this community of users is
+   * returned. In the case such a group isn't yet created, then this method will create it before
+   * returning it. If no users are currently members in this community, then the returned group of
+   * users will be empty.
+   *
+   * @return the group of users who are all members of this community or null if this community
+   * isn't yet persisted.
+   * @throws SilverpeasRuntimeException if an error occurs while creating or getting the group of
+   * members.
+   */
+  public GroupDetail getGroupOfMembers() {
+    if (!isPersisted()) {
+      return null;
+    }
+    GroupDetail group;
+    try {
+      if (groupId == null) {
+        SpaceInst spaceInst = getCommunitySpace().getSilverpeasSpace();
+        group = getCommunitySpace().createMembersGroup(spaceInst);
+      } else {
+        group = getCommunitySpace().getMembersGroup();
+      }
+    } catch (AdminException e) {
+      throw new SilverpeasRuntimeException(e);
+    }
+    return group;
+  }
+
   @Override
   public boolean equals(final Object obj) {
     return super.equals(obj);
@@ -626,6 +668,13 @@ private void addUserInMembershipGroup(User user, SpaceInst space) throws AdminEx
       }
     }
 
+    /**
+     * Creates the group of the members for the specified community space.
+     *
+     * @param space an existing community space in Silverpeas
+     * @return the created group of members
+     * @throws AdminException if an error occurs while creating the group of members.
+     */
     private GroupDetail createMembersGroup(SpaceInst space) throws AdminException {
       GroupDetail group;
       group = new GroupDetail();
@@ -715,8 +764,9 @@ class SynchronizationTask {
        * this space is up-to-date with the users playing a role in it. If a user playing a role in
        * the space isn't yet in the members group, then he's added in this group. If the a user in
        * the group isn't playing any role in the space, then he's removed from the members group.
-       * @param usersPlayingARole a set with the unique identifiers of the users who play a role
-       * in the community space.
+       *
+       * @param usersPlayingARole a set with the unique identifiers of the users who play a role in
+       * the community space.
        */
       void synchronizeMembersGroup(final Set<String> usersPlayingARole) {
         execute(() -> {