Class GroupLDAPStorageMapperFactory
java.lang.Object
org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory
org.keycloak.storage.ldap.mappers.membership.group.GroupLDAPStorageMapperFactory
- All Implemented Interfaces:
ComponentFactory<LDAPStorageMapper,
,LDAPStorageMapper> SubComponentFactory<LDAPStorageMapper,
,LDAPStorageMapper> ConfiguredProvider
,ProviderFactory<LDAPStorageMapper>
,LDAPStorageMapperFactory<LDAPStorageMapper>
- Author:
- Marek Posolda
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final List<ProviderConfigProperty>
static final String
protected static final Map<String,
UserRolesRetrieveStrategy> -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected AbstractLDAPStorageMapper
createMapper
(ComponentModel mapperModel, LDAPStorageProvider federationProvider) getConfigProperties
(RealmModel realm, ComponentModel parent) getId()
This is the name of the provider and will be showed in the admin console as an option.This is metadata about this component type.protected UserRolesRetrieveStrategy
getUserGroupsRetrieveStrategy
(String strategyKey) void
onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) Called when UserStorageProviderModel is created.void
onParentUpdate
(RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel) void
onUpdate
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) Called after the component is updated.void
validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) Called before a component is created or updated.Methods inherited from class org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory
checkMandatoryConfigAttribute, close, create, createConfigProperty, createConfigProperty, init, postInit
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.keycloak.component.ComponentFactory
create, getCommonProviderConfigProperties, preRemove
Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig
Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, order
Methods inherited from interface org.keycloak.component.SubComponentFactory
getTypeMetadata
-
Field Details
-
PROVIDER_ID
- See Also:
-
configProperties
-
userGroupsStrategies
-
MEMBERSHIP_TYPES
-
MODES
-
NO_IMPORT_MODES
-
-
Constructor Details
-
GroupLDAPStorageMapperFactory
public GroupLDAPStorageMapperFactory()
-
-
Method Details
-
getHelpText
-
getConfigProperties
-
getId
Description copied from interface:LDAPStorageMapperFactory
This is the name of the provider and will be showed in the admin console as an option. -
getTypeMetadata
Description copied from interface:ComponentFactory
This is metadata about this component type. Its really configuration information about the component type and not an individual instance- Specified by:
getTypeMetadata
in interfaceComponentFactory<LDAPStorageMapper,
LDAPStorageMapper> - Overrides:
getTypeMetadata
in classAbstractLDAPStorageMapperFactory
- Returns:
-
onParentUpdate
public void onParentUpdate(RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel) -
onCreate
Description copied from interface:LDAPStorageMapperFactory
Called when UserStorageProviderModel is created. This allows you to do initialization of any additional configuration you need to add. For example, you may be introspecting a database or ldap schema to automatically create mappings. -
onUpdate
public void onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) Description copied from interface:ComponentFactory
Called after the component is updated.oldModel
- old saved modelnewModel
- new configuration
-
getConfigProperties
-
validateConfiguration
public void validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) throws ComponentValidationException Description copied from interface:ComponentFactory
Called before a component is created or updated. Allows you to validate the configuration- Throws:
ComponentValidationException
-
createMapper
protected AbstractLDAPStorageMapper createMapper(ComponentModel mapperModel, LDAPStorageProvider federationProvider) - Specified by:
createMapper
in classAbstractLDAPStorageMapperFactory
-
getUserGroupsRetrieveStrategy
-