Sync - first iteration

model/api/src/main/java/org/keycloak/models/KeycloakSessionTask.java

@@ -0,0 +1,12 @@
+package org.keycloak.models;
+
+/**
+ * Task to be executed inside transaction
+ *
+ * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>
+ */
+public interface KeycloakSessionTask {
+
+    public void run(KeycloakSession session);
+
+}

model/api/src/main/java/org/keycloak/models/LDAPConstants.java

@@ -22,5 +22,9 @@ public class LDAPConstants {
     public static final String CONNECTION_POOLING = "connectionPooling";
     public static final String PAGINATION = "pagination";
 
+    // Count of users processed per single transaction during sync process
+    public static final String BATCH_SIZE_FOR_SYNC = "batchSizeForSync";
+    public static final int DEFAULT_BATCH_SIZE_FOR_SYNC = 1000;
+
     public static final String USER_ACCOUNT_CONTROLS_AFTER_PASSWORD_UPDATE = "userAccountControlsAfterPasswordUpdate";
 }

model/api/src/main/java/org/keycloak/models/UserFederationProviderFactory.java

@@ -2,6 +2,7 @@ package org.keycloak.models;
 
 import org.keycloak.provider.ProviderFactory;
 
+import java.util.Date;
 import java.util.Set;
 
 /**
@@ -32,4 +33,26 @@ public interface UserFederationProviderFactory extends ProviderFactory<UserFeder
      */
     @Override
     String getId();
+
+    /**
+     * Sync all users from the provider storage to Keycloak storage.
+     *
+     * @param sessionFactory
+     * @param realmId
+     * @param model
+     */
+    void syncAllUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model);
+
+    /**
+     * Sync just changed (added / updated / removed) users from the provider storage to Keycloak storage. This is useful in case
+     * that your storage supports "changelogs" (Tracking what users changed since specified date). It's implementation specific to
+     * decide what exactly will be changed (For example LDAP supports tracking of added / updated users, but not removed users. So
+     * removed users are not synced)
+     *
+     * @param sessionFactory
+     * @param realmId
+     * @param model
+     * @param lastSync
+     */
+    void syncChangedUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model, Date lastSync);
 }

model/api/src/main/java/org/keycloak/models/utils/KeycloakModelUtils.java

@@ -5,6 +5,9 @@ import org.keycloak.models.ApplicationModel;
 import org.keycloak.models.ClaimMask;
 import org.keycloak.models.ClientModel;
 import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.KeycloakSessionFactory;
+import org.keycloak.models.KeycloakSessionTask;
+import org.keycloak.models.KeycloakTransaction;
 import org.keycloak.models.RealmModel;
 import org.keycloak.models.RoleModel;
 import org.keycloak.models.UserCredentialModel;
@@ -132,4 +135,36 @@ public final class KeycloakModelUtils {
         }
         return user;
     }
+
+    /**
+     * Wrap given runnable job into KeycloakTransaction.
+     *
+     * @param factory
+     * @param task
+     */
+    public static void runJobInTransaction(KeycloakSessionFactory factory, KeycloakSessionTask task) {
+        KeycloakSession session = factory.create();
+        KeycloakTransaction tx = session.getTransaction();
+        try {
+            tx.begin();
+            task.run(session);
+
+            if (tx.isActive()) {
+                if (tx.getRollbackOnly()) {
+                    tx.rollback();
+                } else {
+                    tx.commit();
+                }
+            }
+        } finally {
+            if (tx.isActive()) {
+                tx.rollback();
+            }
+            session.close();
+        }
+    }
+
+    public static String getMasterRealmAdminApplicationName(RealmModel realm) {
+        return realm.getName() + "-realm";
+    }
 }