Added sync support to UserFederationMapper

model/api/src/main/java/org/keycloak/mappers/UserFederationMapper.java

@@ -1,5 +1,10 @@
 package org.keycloak.mappers;
 
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.RealmModel;
+import org.keycloak.models.UserFederationMapperModel;
+import org.keycloak.models.UserFederationProvider;
+import org.keycloak.models.UserFederationSyncResult;
 import org.keycloak.provider.Provider;
 
 /**
@@ -7,4 +12,28 @@ import org.keycloak.provider.Provider;
  */
 public interface UserFederationMapper extends Provider {
 
+    /**
+     * Sync data from federation storage to Keycloak. It's useful just if mapper needs some data preloaded from federation storage (For example
+     * load roles from federation provider and sync them to Keycloak database)
+     *
+     * Applicable just if sync is supported (see UserFederationMapperFactory.getSyncConfig() )
+     *
+     * @see UserFederationMapperFactory#getSyncConfig()
+     * @param mapperModel
+     * @param federationProvider
+     * @param session
+     * @param realm
+     */
+    UserFederationSyncResult syncDataFromFederationProviderToKeycloak(UserFederationMapperModel mapperModel, UserFederationProvider federationProvider, KeycloakSession session, RealmModel realm);
+
+    /**
+     * Sync data from Keycloak back to federation storage
+     *
+     * @see UserFederationMapperFactory#getSyncConfig()
+     * @param mapperModel
+     * @param federationProvider
+     * @param session
+     * @param realm
+     */
+    UserFederationSyncResult syncDataFromKeycloakToFederationProvider(UserFederationMapperModel mapperModel, UserFederationProvider federationProvider, KeycloakSession session, RealmModel realm);
 }

model/api/src/main/java/org/keycloak/mappers/UserFederationMapperFactory.java

@@ -1,12 +1,9 @@
 package org.keycloak.mappers;
 
-import java.util.List;
-
-import org.keycloak.models.RealmModel;
 import org.keycloak.models.UserFederationMapperModel;
 import org.keycloak.provider.ConfiguredProvider;
-import org.keycloak.provider.ProviderConfigProperty;
 import org.keycloak.provider.ProviderFactory;
+import org.keycloak.representations.idm.UserFederationMapperSyncConfigRepresentation;
 
 /**
  * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>
@@ -23,6 +20,14 @@ public interface UserFederationMapperFactory extends ProviderFactory<UserFederat
     String getDisplayCategory();
     String getDisplayType();
 
+    /**
+     * Specifies if mapper supports sync data from federation storage to keycloak and viceversa.
+     * Also specifies messages to be displayed in admin console UI (For example "Sync roles from LDAP" etc)
+     *
+     * @return syncConfig representation
+     */
+    UserFederationMapperSyncConfigRepresentation getSyncConfig();
+
     /**
      * Called when instance of mapperModel is created for this factory through admin endpoint
      *

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

@@ -29,12 +29,6 @@ public interface RealmModel extends RoleContainerModel {
         RealmModel getRealm();
     }
 
-    interface UserFederationMapperEvent extends ProviderEvent {
-        UserFederationMapperModel getFederationMapper();
-        RealmModel getRealm();
-        KeycloakSession getSession();
-    }
-
     String getId();
 
     String getName();

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

@@ -1,33 +0,0 @@
-package org.keycloak.models;
-
-/**
- * Called during creation or update of UserFederationMapperModel
- *
- * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>
- */
-public class UserFederationMapperEventImpl implements RealmModel.UserFederationMapperEvent {
-
-    private final UserFederationMapperModel mapperModel;
-    private final RealmModel realm;
-    private final KeycloakSession session;
-
-    public UserFederationMapperEventImpl(UserFederationMapperModel mapperModel, RealmModel realm, KeycloakSession session) {
-        this.mapperModel = mapperModel;
-        this.realm = realm;
-        this.session = session;
-    }
-
-    @Override
-    public UserFederationMapperModel getFederationMapper() {
-        return mapperModel;
-    }
-
-    @Override
-    public RealmModel getRealm() {
-        return realm;
-    }
-
-    public KeycloakSession getSession() {
-        return session;
-    }
-}