[KEYCLOAK-5660] - Adding UserQueryProvider.getUsersCount(realm, includeServiceAccount) method

model/infinispan/src/main/java/org/keycloak/models/cache/infinispan/UserCacheSession.java

@@ -597,9 +597,14 @@ public class UserCacheSession implements UserCache {
         return getDelegate().getUsers(realm, includeServiceAccounts);
     }
 
+    @Override
+    public int getUsersCount(RealmModel realm, boolean includeServiceAccount) {
+        return getDelegate().getUsersCount(realm, includeServiceAccount);
+    }
+
     @Override
     public int getUsersCount(RealmModel realm) {
-        return getDelegate().getUsersCount(realm);
+        return getUsersCount(realm, false);
     }
 
     @Override

model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java

@@ -596,13 +596,24 @@ public class JpaUserProvider implements UserProvider, UserCredentialStore {
     }
 
     @Override
-    public int getUsersCount(RealmModel realm) {
+    public int getUsersCount(RealmModel realm, boolean includeServiceAccount) {
-        Object count = em.createNamedQuery("getRealmUserCount")
+        String namedQuery = "getRealmUserCountExcludeServiceAccount";
+
+        if (includeServiceAccount) {
+            namedQuery = "getRealmUserCount";
+        }
+
+        Object count = em.createNamedQuery(namedQuery)
                 .setParameter("realmId", realm.getId())
                 .getSingleResult();
         return ((Number)count).intValue();
     }
 
+    @Override
+    public int getUsersCount(RealmModel realm) {
+        return getUsersCount(realm, false);
+    }
+
     @Override
     public List<UserModel> getUsers(RealmModel realm) {
         return getUsers(realm, false);

model/jpa/src/main/java/org/keycloak/models/jpa/entities/UserEntity.java

@@ -48,7 +48,8 @@ import java.util.Collection;
         @NamedQuery(name="getRealmUserByLastName", query="select u from UserEntity u where u.lastName = :lastName and u.realmId = :realmId"),
         @NamedQuery(name="getRealmUserByFirstLastName", query="select u from UserEntity u where u.firstName = :first and u.lastName = :last and u.realmId = :realmId"),
         @NamedQuery(name="getRealmUserByServiceAccount", query="select u from UserEntity u where u.serviceAccountClientLink = :clientInternalId and u.realmId = :realmId"),
-        @NamedQuery(name="getRealmUserCount", query="select count(u) from UserEntity u where u.realmId = :realmId and (u.serviceAccountClientLink is null)"),
+        @NamedQuery(name="getRealmUserCount", query="select count(u) from UserEntity u where u.realmId = :realmId"),
+        @NamedQuery(name="getRealmUserCountExcludeServiceAccount", query="select count(u) from UserEntity u where u.realmId = :realmId and (u.serviceAccountClientLink is null)"),
         @NamedQuery(name="getRealmUsersByAttributeNameAndValue", query="select u from UserEntity u join u.attributes attr " +
                 "where u.realmId = :realmId and attr.name = :name and attr.value = :value"),
         @NamedQuery(name="deleteUsersByRealm", query="delete from UserEntity u where u.realmId = :realmId"),

server-spi/src/main/java/org/keycloak/storage/user/UserQueryProvider.java

@@ -35,8 +35,25 @@ import java.util.Map;
  */
 public interface UserQueryProvider {
 
+    /**
+     * Returns the number of users, without consider any service account.
+     *
+     * @param realm the realm
+     * @return the number of users
+     */
     int getUsersCount(RealmModel realm);
 
+    /**
+     * Returns the number of users.
+     *
+     * @param realm the realm
+     * @param includeServiceAccount if true, the number of users will also include service accounts. Otherwise, only the number of users.
+     * @return the number of users
+     */
+    default int getUsersCount(RealmModel realm, boolean includeServiceAccount) {
+        throw new RuntimeException("Not implemented");
+    }
+
     List<UserModel> getUsers(RealmModel realm);
     List<UserModel> getUsers(RealmModel realm, int firstResult, int maxResults);
 

services/src/main/java/org/keycloak/exportimport/util/MultipleStepsExportProvider.java

@@ -81,7 +81,7 @@ public abstract class MultipleStepsExportProvider implements ExportProvider {
 
                 // Count total number of users
                 if (!exportUsersIntoRealmFile) {
-                    usersHolder.totalCount = session.users().getUsersCount(realm);
+                    usersHolder.totalCount = session.users().getUsersCount(realm, true);
                     federatedUsersHolder.totalCount = session.userFederatedStorage().getStoredUsersCount(realm);
                 }
             }

services/src/main/java/org/keycloak/storage/UserStorageManager.java

@@ -399,14 +399,19 @@ public class UserStorageManager implements UserProvider, OnUserCache, OnCreateCo
     }
 
     @Override
-    public int getUsersCount(RealmModel realm) {
+    public int getUsersCount(RealmModel realm, boolean includeServiceAccount) {
-        int size = localStorage().getUsersCount(realm);
+        int size = localStorage().getUsersCount(realm, includeServiceAccount);
         for (UserQueryProvider provider : getStorageProviders(session, realm, UserQueryProvider.class)) {
             size += provider.getUsersCount(realm);
         }
         return size;
     }
 
+    @Override
+    public int getUsersCount(RealmModel realm) {
+        return getUsersCount(realm, false);
+    }
+
     @FunctionalInterface
     interface PaginatedQuery {
         List<UserModel> query(Object provider, int first, int max);

testsuite/integration-deprecated/src/test/java/org/keycloak/testsuite/model/UserModelTest.java

@@ -357,6 +357,9 @@ public class UserModelTest extends AbstractModelTest {
         Assert.assertTrue(users.contains(user1));
         Assert.assertTrue(users.contains(user2));
 
+        Assert.assertEquals(2, session.users().getUsersCount(realm, true));
+        Assert.assertEquals(1, session.users().getUsersCount(realm, false));
+
         // Remove client
         new ClientManager(realmManager).removeClient(realm, client);
         commit();