Package org.keycloak.storage.ldap.mappers

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 final List<ProviderConfigProperty>	configProperties
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
UserAttributeLDAPStorageMapperFactory()

Method Summary

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, 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 Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

configProperties

protected static final List<ProviderConfigProperty> configProperties

Constructor Details

UserAttributeLDAPStorageMapperFactory

public UserAttributeLDAPStorageMapperFactory()

Method Details

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

Specified by:

getHelpText in interface LDAPStorageMapperFactory<LDAPStorageMapper>

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

Specified by:

getConfigProperties in interface LDAPStorageMapperFactory<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 interface LDAPStorageMapperFactory<LDAPStorageMapper>

Specified by:

getId in interface ProviderFactory<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 interface ComponentFactory<LDAPStorageMapper,LDAPStorageMapper>

Specified by:

validateConfiguration in interface LDAPStorageMapperFactory<LDAPStorageMapper>

Throws:

ComponentValidationException

createMapper

protected AbstractLDAPStorageMapper createMapper(ComponentModel mapperModel,
 LDAPStorageProvider federationProvider)

Specified by:

createMapper in class AbstractLDAPStorageMapperFactory

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties(RealmModel realm,
 ComponentModel parent)

Specified by:

getConfigProperties in interface SubComponentFactory<LDAPStorageMapper,LDAPStorageMapper>

updateLDAPConfig

public void updateLDAPConfig(LDAPConfig ldapConfig,
 ComponentModel mapperModel)

Specified by:

updateLDAPConfig in interface LDAPConfigDecorator