org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory クラス

org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory の継承関係図

org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory 連携図

公開メンバ関数
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties ()
String	getId ()
void	validateConfiguration (KeycloakSession session, RealmModel realm, ComponentModel config) throws ComponentValidationException
List< ProviderConfigProperty >	getConfigProperties (RealmModel realm, ComponentModel parent)
void	updateLDAPConfig (LDAPConfig ldapConfig, ComponentModel mapperModel)
void	init (Config.Scope config)
LDAPStorageMapper	create (KeycloakSession session, ComponentModel model)
void	postInit (KeycloakSessionFactory factory)
Map< String, Object >	getTypeMetadata ()
void	close ()
default void	onParentUpdate (RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel)
default void	onCreate (KeycloakSession session, RealmModel realm, ComponentModel model)

静的公開メンバ関数
static ProviderConfigProperty	createConfigProperty (String name, String label, String helpText, String type, List< String > options)

静的公開変数類
static final String	PROVIDER_ID = "user-attribute-ldap-mapper"

限定公開メンバ関数
AbstractLDAPStorageMapper	createMapper (ComponentModel mapperModel, LDAPStorageProvider federationProvider)
void	checkMandatoryConfigAttribute (String name, String displayName, ComponentModel mapperModel) throws ComponentValidationException

静的限定公開変数類
static final List< ProviderConfigProperty >	configProperties

静的関数
	[static initializer]

静的非公開メンバ関数
static List< ProviderConfigProperty >	getConfigProps (ComponentModel p)

詳解

著者

Marek Posolda

関数詳解

[static initializer]()

org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory.[static initializer] ( )

inlinestaticpackage

checkMandatoryConfigAttribute()

void org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.checkMandatoryConfigAttribute ( String  name, String  displayName, ComponentModel  mapperModel  ) throws ComponentValidationException

inlineprotectedinherited

                                                                                                                                                  {
        String attrConfigValue = mapperModel.getConfig().getFirst(name);
        if (attrConfigValue == null || attrConfigValue.trim().isEmpty()) {
            throw new ComponentValidationException("Missing configuration for '" + displayName + "'");
        }
    }

close()

void org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.close ( )

inlineinherited

                        {
    }

create()

LDAPStorageMapper org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.create ( KeycloakSession  session, ComponentModel  model  )

inlineinherited

                                                                                   {
        // LDAPStorageProvider is in the session already as mappers are always called from it
        String ldapProviderModelId = model.getParentId();
        LDAPStorageProvider ldapProvider = (LDAPStorageProvider) session.getAttribute(ldapProviderModelId);

        return createMapper(model, ldapProvider);
    }

createConfigProperty()

static ProviderConfigProperty org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.createConfigProperty ( String  name, String  label, String  helpText, String  type, List< String >  options  )

inlinestaticinherited

                                                                                                                                             {
        ProviderConfigProperty configProperty = new ProviderConfigProperty();
        configProperty.setName(name);
        configProperty.setLabel(label);
        configProperty.setHelpText(helpText);
        configProperty.setType(type);
        configProperty.setOptions(options);
        return configProperty;
    }

createMapper()

AbstractLDAPStorageMapper org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory.createMapper ( ComponentModel  mapperModel, LDAPStorageProvider  federationProvider  )

inlineprotected

                                                                                                                         {
        return new UserAttributeLDAPStorageMapper(mapperModel, federationProvider);
    }

getConfigProperties() [1/2]

List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory.getConfigProperties ( )

inline

                                                              {
        return configProperties;
    }

getConfigProperties() [2/2]

List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory.getConfigProperties ( RealmModel  realm, ComponentModel  parent  )

inline

                                                                                                     {
        return getConfigProps(parent);
    }

getConfigProps()

static List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory.getConfigProps ( ComponentModel  p )

inlinestaticprivate

                                                                                 {
        String readOnly = "false";
        UserStorageProviderModel parent = new UserStorageProviderModel();
        if (p != null) {
            parent = new UserStorageProviderModel(p);
            LDAPConfig ldapConfig = new LDAPConfig(parent.getConfig());
            readOnly = ldapConfig.getEditMode() == UserStorageProvider.EditMode.WRITABLE ? "false" : "true";
        }
        ProviderConfigurationBuilder config = ProviderConfigurationBuilder.create()
                .property().name(UserAttributeLDAPStorageMapper.USER_MODEL_ATTRIBUTE)
                .label("User Model Attribute")
                .helpText("Name of the UserModel property or attribute you want to map the LDAP attribute into. For example 'firstName', 'lastName, 'email', 'street' etc.")
                .type(ProviderConfigProperty.STRING_TYPE)
                .add()
                .property().name(UserAttributeLDAPStorageMapper.LDAP_ATTRIBUTE).label("LDAP Attribute").helpText("Name of mapped attribute on LDAP object. For example 'cn', 'sn, 'mail', 'street' etc.")
                .type(ProviderConfigProperty.STRING_TYPE)
                .add()
                .property().name(UserAttributeLDAPStorageMapper.READ_ONLY).label("Read Only")
                .helpText("Read-only attribute is imported from LDAP to UserModel, but it's not saved back to LDAP when user is updated in Keycloak.")
                .type(ProviderConfigProperty.BOOLEAN_TYPE)
                .defaultValue(readOnly)
                .add();
        if (parent.isImportEnabled()) {
            config.
            property().name(UserAttributeLDAPStorageMapper.ALWAYS_READ_VALUE_FROM_LDAP).label("Always Read Value From LDAP")
                    .helpText("If on, then during reading of the LDAP attribute value will always used instead of the value from Keycloak DB")
                    .type(ProviderConfigProperty.BOOLEAN_TYPE).defaultValue("false").add();
        }
        config.property().name(UserAttributeLDAPStorageMapper.IS_MANDATORY_IN_LDAP).label("Is Mandatory In LDAP")
                .helpText("If true, attribute is mandatory in LDAP. Hence if there is no value in Keycloak DB, the empty value will be set to be propagated to LDAP")
                .type(ProviderConfigProperty.BOOLEAN_TYPE)
                .defaultValue("false").add()
                .property().name(UserAttributeLDAPStorageMapper.IS_BINARY_ATTRIBUTE).label("Is Binary Attribute")
                .helpText("Should be true for binary LDAP attributes")
                .type(ProviderConfigProperty.BOOLEAN_TYPE)
                .defaultValue("false").add();
        return config.build();
    }

getHelpText()

String org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory.getHelpText ( )

inline

                                {
        return "Used to map single attribute from LDAP user to attribute of UserModel in Keycloak DB";
    }

getId()

String org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory.getId ( )

inline

                          {
        return PROVIDER_ID;
    }

getTypeMetadata()

Map<String, Object> org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.getTypeMetadata ( )

inlineinherited

                                                 {
        Map<String, Object> metadata = new HashMap<>();
        metadata.put("fedToKeycloakSyncSupported", false);
        metadata.put("keycloakToFedSyncSupported", false);

        return metadata;
    }

init()

void org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.init ( Config.Scope  config )

inlineinherited

                                          {
    }

onCreate()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.onCreate ( KeycloakSession  session, RealmModel  realm, ComponentModel  model  )

inlineinherited

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.

引数

session
realm
model

                                                                                           {

    }

onParentUpdate()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.onParentUpdate ( RealmModel  realm, UserStorageProviderModel  oldParent, UserStorageProviderModel  newParent, ComponentModel  mapperModel  )

inlineinherited

                                                                                                                                                      {

    }

postInit()

void org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.postInit ( KeycloakSessionFactory  factory )

inlineinherited

                                                         {
    }

updateLDAPConfig()

void org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory.updateLDAPConfig ( LDAPConfig  ldapConfig, ComponentModel  mapperModel  )

inline

org.keycloak.storage.ldap.mappers.LDAPConfigDecoratorを実装しています。

                                                                                    {
        boolean isBinaryAttribute = mapperModel.get(UserAttributeLDAPStorageMapper.IS_BINARY_ATTRIBUTE, false);
        if (isBinaryAttribute) {
            String ldapAttrName = mapperModel.getConfig().getFirst(UserAttributeLDAPStorageMapper.LDAP_ATTRIBUTE);
            ldapConfig.addBinaryAttribute(ldapAttrName);
        }
    }

validateConfiguration()

void org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory.validateConfiguration ( KeycloakSession  session, RealmModel  realm, ComponentModel  config  ) throws ComponentValidationException

inline

                                                                                                                                            {
        checkMandatoryConfigAttribute(UserAttributeLDAPStorageMapper.USER_MODEL_ATTRIBUTE, "User Model Attribute", config);
        checkMandatoryConfigAttribute(UserAttributeLDAPStorageMapper.LDAP_ATTRIBUTE, "LDAP Attribute", config);

        boolean isBinaryAttribute = config.get(UserAttributeLDAPStorageMapper.IS_BINARY_ATTRIBUTE, false);
        boolean alwaysReadValueFromLDAP = config.get(UserAttributeLDAPStorageMapper.ALWAYS_READ_VALUE_FROM_LDAP, false);
        if (isBinaryAttribute && !alwaysReadValueFromLDAP) {
            throw new ComponentValidationException("With Binary attribute enabled, the ''Always read value from LDAP'' must be enabled too");
        }

    }

メンバ詳解

configProperties

final List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory.configProperties

staticprotected

PROVIDER_ID

final String org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapperFactory.PROVIDER_ID = "user-attribute-ldap-mapper"

static

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/storage/ldap/mappers/UserAttributeLDAPStorageMapperFactory.java