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

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

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

公開メンバ関数
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties ()
String	getId ()
void	validateConfiguration (KeycloakSession session, RealmModel realm, ComponentModel config) throws ComponentValidationException
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 = "hardcoded-ldap-role-mapper"

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

静的限定公開変数類
static final List< ProviderConfigProperty >	configProperties = new ArrayList<ProviderConfigProperty>()

静的関数
	[static initializer]

詳解

著者

Marek Posolda

関数詳解

[static initializer]()

org.keycloak.storage.ldap.mappers.HardcodedLDAPRoleStorageMapperFactory.[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.HardcodedLDAPRoleStorageMapperFactory.createMapper ( ComponentModel  mapperModel, LDAPStorageProvider  federationProvider  )

inlineprotected

                                                                                                                         {
        return new HardcodedLDAPRoleStorageMapper(mapperModel, federationProvider);
    }

getConfigProperties()

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

inline

                                                              {
        return configProperties;
    }

getHelpText()

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

inline

                                {
        return "When user is imported from LDAP, he will be automatically added into this configured role.";
    }

getId()

String org.keycloak.storage.ldap.mappers.HardcodedLDAPRoleStorageMapperFactory.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

                                                         {
    }

validateConfiguration()

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

inline

                                                                                                                                            {
        String roleName = config.getConfig().getFirst(HardcodedLDAPRoleStorageMapper.ROLE);
        if (roleName == null) {
            throw new ComponentValidationException("Role can't be null");
        }
        RoleModel role = KeycloakModelUtils.getRoleFromString(realm, roleName);
        if (role == null) {
            throw new ComponentValidationException("There is no role corresponding to configured value");
        }
    }

メンバ詳解

configProperties

final List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.HardcodedLDAPRoleStorageMapperFactory.configProperties = new ArrayList<ProviderConfigProperty>()

staticprotected

PROVIDER_ID

final String org.keycloak.storage.ldap.mappers.HardcodedLDAPRoleStorageMapperFactory.PROVIDER_ID = "hardcoded-ldap-role-mapper"

static

---

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

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