Class UserAttributeTemplatedLDAPStorageMapperFactory

  • All Implemented Interfaces:
    org.keycloak.component.ComponentFactory<org.keycloak.storage.ldap.mappers.LDAPStorageMapper,​org.keycloak.storage.ldap.mappers.LDAPStorageMapper>, org.keycloak.component.SubComponentFactory<org.keycloak.storage.ldap.mappers.LDAPStorageMapper,​org.keycloak.storage.ldap.mappers.LDAPStorageMapper>, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.ProviderFactory<org.keycloak.storage.ldap.mappers.LDAPStorageMapper>, org.keycloak.storage.ldap.mappers.LDAPConfigDecorator, org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory<org.keycloak.storage.ldap.mappers.LDAPStorageMapper>

    public class UserAttributeTemplatedLDAPStorageMapperFactory
    extends org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory
    implements org.keycloak.storage.ldap.mappers.LDAPConfigDecorator
    Author:
    Marek Posolda, Mauro Mugnaini
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper createMapper​(org.keycloak.component.ComponentModel mapperModel, org.keycloak.storage.ldap.LDAPStorageProvider federationProvider)  
      List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()  
      List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties​(org.keycloak.models.RealmModel realm, org.keycloak.component.ComponentModel parent)  
      String getHelpText()  
      String getId()  
      void updateLDAPConfig​(org.keycloak.storage.ldap.LDAPConfig ldapConfig, org.keycloak.component.ComponentModel mapperModel)  
      void validateConfiguration​(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.component.ComponentModel config)  
      • Methods inherited from class org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory

        checkMandatoryConfigAttribute, close, create, createConfigProperty, getTypeMetadata, init, postInit
      • 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

      • configProperties

        protected static final List<org.keycloak.provider.ProviderConfigProperty> configProperties
    • Constructor Detail

      • UserAttributeTemplatedLDAPStorageMapperFactory

        public UserAttributeTemplatedLDAPStorageMapperFactory()
    • Method Detail

      • getHelpText

        public String getHelpText()
        Specified by:
        getHelpText in interface org.keycloak.provider.ConfiguredProvider
        Specified by:
        getHelpText in interface org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory<org.keycloak.storage.ldap.mappers.LDAPStorageMapper>
      • getConfigProperties

        public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()
        Specified by:
        getConfigProperties in interface org.keycloak.provider.ConfiguredProvider
        Specified by:
        getConfigProperties in interface org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory<org.keycloak.storage.ldap.mappers.LDAPStorageMapper>
      • getId

        public String getId()
        Specified by:
        getId in interface org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory<org.keycloak.storage.ldap.mappers.LDAPStorageMapper>
        Specified by:
        getId in interface org.keycloak.provider.ProviderFactory<org.keycloak.storage.ldap.mappers.LDAPStorageMapper>
      • validateConfiguration

        public void validateConfiguration​(org.keycloak.models.KeycloakSession session,
                                          org.keycloak.models.RealmModel realm,
                                          org.keycloak.component.ComponentModel config)
                                   throws org.keycloak.component.ComponentValidationException
        Specified by:
        validateConfiguration in interface org.keycloak.component.ComponentFactory<org.keycloak.storage.ldap.mappers.LDAPStorageMapper,​org.keycloak.storage.ldap.mappers.LDAPStorageMapper>
        Specified by:
        validateConfiguration in interface org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory<org.keycloak.storage.ldap.mappers.LDAPStorageMapper>
        Throws:
        org.keycloak.component.ComponentValidationException
      • createMapper

        protected org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper createMapper​(org.keycloak.component.ComponentModel mapperModel,
                                                                                           org.keycloak.storage.ldap.LDAPStorageProvider federationProvider)
        Specified by:
        createMapper in class org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory
      • getConfigProperties

        public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties​(org.keycloak.models.RealmModel realm,
                                                                                      org.keycloak.component.ComponentModel parent)
        Specified by:
        getConfigProperties in interface org.keycloak.component.SubComponentFactory<org.keycloak.storage.ldap.mappers.LDAPStorageMapper,​org.keycloak.storage.ldap.mappers.LDAPStorageMapper>
      • updateLDAPConfig

        public void updateLDAPConfig​(org.keycloak.storage.ldap.LDAPConfig ldapConfig,
                                     org.keycloak.component.ComponentModel mapperModel)
        Specified by:
        updateLDAPConfig in interface org.keycloak.storage.ldap.mappers.LDAPConfigDecorator