public class LDAPFederationProviderFactory extends UserFederationEventAwareProviderFactory implements UserFederationValidatingProviderFactory
Modifier and Type | Field and Description |
---|---|
static String |
PROVIDER_NAME |
Constructor and Description |
---|
LDAPFederationProviderFactory() |
Modifier and Type | Method and Description |
---|---|
void |
close()
This is called when the server shuts down.
|
UserFederationProvider |
create(KeycloakSession session)
This method is never called and is only an artifact of ProviderFactory.
|
protected KerberosServerSubjectAuthenticator |
createKerberosSubjectAuthenticator(CommonKerberosConfig kerberosConfig) |
protected KerberosUsernamePasswordAuthenticator |
createKerberosUsernamePasswordAuthenticator(CommonKerberosConfig kerberosConfig) |
protected SPNEGOAuthenticator |
createSPNEGOAuthenticator(String spnegoToken,
CommonKerberosConfig kerberosConfig) |
Set<String> |
getConfigurationOptions()
Config options to display in generic admin console page for federation
|
String |
getId()
This is the name of the provider and will be showed in the admin console as an option.
|
LDAPFederationProvider |
getInstance(KeycloakSession session,
UserFederationProviderModel model)
called per Keycloak transaction.
|
protected UserFederationSyncResult |
importLdapUsers(KeycloakSessionFactory sessionFactory,
String realmId,
UserFederationProviderModel fedModel,
List<LDAPObject> ldapUsers) |
void |
init(Config.Scope config)
Only called once when the factory is first created.
|
void |
onProviderModelCreated(RealmModel realm,
UserFederationProviderModel newProviderModel) |
UserFederationSyncResult |
syncAllUsers(KeycloakSessionFactory sessionFactory,
String realmId,
UserFederationProviderModel model)
Sync all users from the provider storage to Keycloak storage.
|
UserFederationSyncResult |
syncChangedUsers(KeycloakSessionFactory sessionFactory,
String realmId,
UserFederationProviderModel model,
Date lastSync)
Sync just changed (added / updated / removed) users from the provider storage to Keycloak storage.
|
protected UserFederationSyncResult |
syncImpl(KeycloakSessionFactory sessionFactory,
LDAPQuery userQuery,
String realmId,
UserFederationProviderModel fedModel) |
protected void |
syncMappers(KeycloakSessionFactory sessionFactory,
String realmId,
UserFederationProviderModel model) |
void |
validateConfig(RealmModel realm,
UserFederationProviderModel providerModel)
Called when instance of mapperModel is created for this factory through admin endpoint
|
postInit
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
postInit
public static final String PROVIDER_NAME
public UserFederationProvider create(KeycloakSession session)
UserFederationProviderFactory
create
in interface UserFederationProviderFactory
create
in interface ProviderFactory<UserFederationProvider>
public LDAPFederationProvider getInstance(KeycloakSession session, UserFederationProviderModel model)
UserFederationProviderFactory
getInstance
in interface UserFederationProviderFactory
public void validateConfig(RealmModel realm, UserFederationProviderModel providerModel) throws FederationConfigValidationException
UserFederationValidatingProviderFactory
validateConfig
in interface UserFederationValidatingProviderFactory
FederationConfigValidationException
- if configuration provided in mapperModel is not validpublic void init(Config.Scope config)
ProviderFactory
init
in interface ProviderFactory<UserFederationProvider>
public void close()
ProviderFactory
close
in interface ProviderFactory<UserFederationProvider>
public String getId()
UserFederationProviderFactory
getId
in interface UserFederationProviderFactory
getId
in interface ProviderFactory<UserFederationProvider>
public Set<String> getConfigurationOptions()
UserFederationProviderFactory
getConfigurationOptions
in interface UserFederationProviderFactory
public void onProviderModelCreated(RealmModel realm, UserFederationProviderModel newProviderModel)
onProviderModelCreated
in class UserFederationEventAwareProviderFactory
public UserFederationSyncResult syncAllUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model)
UserFederationProviderFactory
syncAllUsers
in interface UserFederationProviderFactory
public UserFederationSyncResult syncChangedUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model, Date lastSync)
UserFederationProviderFactory
syncChangedUsers
in interface UserFederationProviderFactory
protected void syncMappers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel model)
protected UserFederationSyncResult syncImpl(KeycloakSessionFactory sessionFactory, LDAPQuery userQuery, String realmId, UserFederationProviderModel fedModel)
protected UserFederationSyncResult importLdapUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel fedModel, List<LDAPObject> ldapUsers)
protected SPNEGOAuthenticator createSPNEGOAuthenticator(String spnegoToken, CommonKerberosConfig kerberosConfig)
protected KerberosServerSubjectAuthenticator createKerberosSubjectAuthenticator(CommonKerberosConfig kerberosConfig)
protected KerberosUsernamePasswordAuthenticator createKerberosUsernamePasswordAuthenticator(CommonKerberosConfig kerberosConfig)
Copyright © 2016 JBoss by Red Hat. All rights reserved.