org.keycloak.storage.ldap.mappers

Interface LDAPStorageMapperFactory<T extends LDAPStorageMapper>

All Superinterfaces:

ComponentFactory<T,LDAPStorageMapper>, ConfiguredProvider, ProviderFactory<LDAPStorageMapper>, SubComponentFactory<T,LDAPStorageMapper>

All Known Implementing Classes:

AbstractLDAPStorageMapperFactory, FullNameLDAPStorageMapperFactory, GroupLDAPStorageMapperFactory, HardcodedLDAPAttributeMapperFactory, HardcodedLDAPRoleStorageMapperFactory, MSADLDSUserAccountControlStorageMapperFactory, MSADUserAccountControlStorageMapperFactory, RoleLDAPStorageMapperFactory, UserAttributeLDAPStorageMapperFactory

public interface LDAPStorageMapperFactory<T extends LDAPStorageMapper>
extends SubComponentFactory<T,LDAPStorageMapper>

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
default void	close()
T	create(KeycloakSession session, ComponentModel model) called per Keycloak transaction.
default List<ProviderConfigProperty>	getConfigProperties()
default String	getHelpText()
String	getId() This is the name of the provider and will be showed in the admin console as an option.
default void	init(Config.Scope config)
default void	onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) Called when UserStorageProviderModel is created.
default void	onParentUpdate(RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel)
default void	postInit(KeycloakSessionFactory factory)
default void	validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config)

Methods inherited from interface org.keycloak.component.SubComponentFactory

getConfigProperties, getTypeMetadata

Methods inherited from interface org.keycloak.component.ComponentFactory

create, getCommonProviderConfigProperties, getTypeMetadata, onUpdate

Method Detail

create

T create(KeycloakSession session,
         ComponentModel model)

called per Keycloak transaction.

Specified by:

create in interface ComponentFactory<T extends LDAPStorageMapper,LDAPStorageMapper>

Parameters:

session -

model -

Returns:

getId

String getId()

This is the name of the provider and will be showed in the admin console as an option.

Specified by:

getId in interface ProviderFactory<LDAPStorageMapper>

Returns:

init

default void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<LDAPStorageMapper>

postInit

default void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<LDAPStorageMapper>

close

default void close()

Specified by:

close in interface ProviderFactory<LDAPStorageMapper>

getHelpText

default String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

getConfigProperties

default List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

validateConfiguration

default void validateConfiguration(KeycloakSession session,
                                   RealmModel realm,
                                   ComponentModel config)
                            throws ComponentValidationException

Specified by:

validateConfiguration in interface ComponentFactory<T extends LDAPStorageMapper,LDAPStorageMapper>

Throws:

ComponentValidationException

onParentUpdate

default void onParentUpdate(RealmModel realm,
                            UserStorageProviderModel oldParent,
                            UserStorageProviderModel newParent,
                            ComponentModel mapperModel)

onCreate

default void onCreate(KeycloakSession session,
                      RealmModel realm,
                      ComponentModel model)

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.

Specified by:

onCreate in interface ComponentFactory<T extends LDAPStorageMapper,LDAPStorageMapper>

Parameters:

session -

realm -

model -