Class UserAttributeLDAPStorageMapperFactory
- java.lang.Object
-
- org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory
-
- org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory
-
- All Implemented Interfaces:
ComponentFactory<LDAPStorageMapper,LDAPStorageMapper>
,SubComponentFactory<LDAPStorageMapper,LDAPStorageMapper>
,ConfiguredProvider
,ProviderFactory<LDAPStorageMapper>
,LDAPConfigDecorator
,LDAPStorageMapperFactory<LDAPStorageMapper>
- Direct Known Subclasses:
CertificateLDAPStorageMapperFactory
public class UserAttributeLDAPStorageMapperFactory extends AbstractLDAPStorageMapperFactory implements LDAPConfigDecorator
- Author:
- Marek Posolda
-
-
Field Summary
Fields Modifier and Type Field Description protected static List<ProviderConfigProperty>
configProperties
static String
PROVIDER_ID
-
Constructor Summary
Constructors Constructor Description UserAttributeLDAPStorageMapperFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected AbstractLDAPStorageMapper
createMapper(ComponentModel mapperModel, LDAPStorageProvider federationProvider)
List<ProviderConfigProperty>
getConfigProperties()
List<ProviderConfigProperty>
getConfigProperties(RealmModel realm, ComponentModel parent)
String
getHelpText()
String
getId()
This is the name of the provider and will be showed in the admin console as an option.void
updateLDAPConfig(LDAPConfig ldapConfig, ComponentModel mapperModel)
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, getTypeMetadata, 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, onUpdate, preRemove
-
Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig
-
Methods inherited from interface org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory
onCreate, onParentUpdate
-
Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, order
-
Methods inherited from interface org.keycloak.component.SubComponentFactory
getTypeMetadata
-
-
-
-
Field Detail
-
PROVIDER_ID
public static final String PROVIDER_ID
- See Also:
- Constant Field Values
-
configProperties
protected static final List<ProviderConfigProperty> configProperties
-
-
Method Detail
-
getHelpText
public String getHelpText()
- Specified by:
getHelpText
in interfaceConfiguredProvider
- Specified by:
getHelpText
in interfaceLDAPStorageMapperFactory<LDAPStorageMapper>
-
getConfigProperties
public List<ProviderConfigProperty> getConfigProperties()
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
- Specified by:
getConfigProperties
in interfaceLDAPStorageMapperFactory<LDAPStorageMapper>
-
getId
public String getId()
Description copied from interface:LDAPStorageMapperFactory
This is the name of the provider and will be showed in the admin console as an option.- Specified by:
getId
in interfaceLDAPStorageMapperFactory<LDAPStorageMapper>
- Specified by:
getId
in interfaceProviderFactory<LDAPStorageMapper>
-
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- Specified by:
validateConfiguration
in interfaceComponentFactory<LDAPStorageMapper,LDAPStorageMapper>
- Specified by:
validateConfiguration
in interfaceLDAPStorageMapperFactory<LDAPStorageMapper>
- Throws:
ComponentValidationException
-
createMapper
protected AbstractLDAPStorageMapper createMapper(ComponentModel mapperModel, LDAPStorageProvider federationProvider)
- Specified by:
createMapper
in classAbstractLDAPStorageMapperFactory
-
getConfigProperties
public List<ProviderConfigProperty> getConfigProperties(RealmModel realm, ComponentModel parent)
- Specified by:
getConfigProperties
in interfaceSubComponentFactory<LDAPStorageMapper,LDAPStorageMapper>
-
updateLDAPConfig
public void updateLDAPConfig(LDAPConfig ldapConfig, ComponentModel mapperModel)
- Specified by:
updateLDAPConfig
in interfaceLDAPConfigDecorator
-
-