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

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

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

公開メンバ関数
void	init (Config.Scope config)
LDAPStorageMapper	create (KeycloakSession session, ComponentModel model)
void	postInit (KeycloakSessionFactory factory)
Map< String, Object >	getTypeMetadata ()
void	close ()
String	getId ()
default String	getHelpText ()
default List< ProviderConfigProperty >	getConfigProperties ()
default void	validateConfiguration (KeycloakSession session, RealmModel realm, ComponentModel config) throws ComponentValidationException
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)

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

詳解

著者

Marek Posolda

関数詳解

checkMandatoryConfigAttribute()

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

inlineprotected

                                                                                                                                                  {
        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 ( )

inline

                        {
    }

create()

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

inline

                                                                                   {
        // 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  )

inlinestatic

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

createMapper()

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

abstractprotected

getConfigProperties()

default List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.getConfigProperties ( )

inlineinherited

                                                               {
        return Collections.EMPTY_LIST;
    }

getHelpText()

default String org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.getHelpText ( )

inlineinherited

                                 {
        return "";
    }

getId()

String org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.getId ( )

inherited

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

戻り値

getTypeMetadata()

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

inline

                                                 {
        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 )

inline

                                          {
    }

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 )

inline

                                                         {
    }

validateConfiguration()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.validateConfiguration ( KeycloakSession  session, RealmModel  realm, ComponentModel  config  ) throws ComponentValidationException

inlineinherited

                                                                                                                                             {

    }

---

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

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