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

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

公開メンバ関数
String	getHelpText ()

List< ProviderConfigProperty >	getConfigProperties ()

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

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 = "full-name-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 parent)

詳解

著者: Marek Posolda

関数詳解

◆ [static initializer]()

org.keycloak.storage.ldap.mappers.FullNameLDAPStorageMapperFactory.[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

67 {

68 }

◆ 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.FullNameLDAPStorageMapperFactory.createMapper	(	ComponentModel	mapperModel,
		LDAPStorageProvider	federationProvider
	)

inlineprotected

                                                                                                                          {
         return new FullNameLDAPStorageMapper(mapperModel, federationProvider);
     }

◆ getConfigProperties() [1/2]

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

inline

                                                               {
         return configProperties;
     }

◆ getConfigProperties() [2/2]

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

inline

                                                                                                      {
         return getConfigProps(parent);
     }

◆ getConfigProps()

static List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.FullNameLDAPStorageMapperFactory.getConfigProps ( ComponentModel parent )

inlinestaticprivate

                                                                                       {
         boolean readOnly = false;
         if (parent != null) {
             LDAPConfig config = new LDAPConfig(parent.getConfig());
             readOnly = config.getEditMode() != UserStorageProvider.EditMode.WRITABLE;
         }
 
 
         return ProviderConfigurationBuilder.create()
                 .property().name(FullNameLDAPStorageMapper.LDAP_FULL_NAME_ATTRIBUTE)
                            .label("LDAP Full Name Attribute")
                            .helpText("Name of LDAP attribute, which contains fullName of user. Usually it will be 'cn' ")
                            .type(ProviderConfigProperty.STRING_TYPE)
                            .defaultValue(LDAPConstants.CN)
                            .add()
                 .property().name(FullNameLDAPStorageMapper.READ_ONLY)
                            .label("Read Only")
                            .helpText("For Read-only is data imported from LDAP to Keycloak DB, but it's not saved back to LDAP when user is updated in Keycloak.")
                            .type(ProviderConfigProperty.BOOLEAN_TYPE)
                            .defaultValue(String.valueOf(readOnly))
                 .add()
                 .property().name(FullNameLDAPStorageMapper.WRITE_ONLY)
                            .label("Write Only")
                            .helpText("For Write-only is data propagated to LDAP when user is created or updated in Keycloak. But this mapper is not used to propagate data from LDAP back into Keycloak. " +
                         "This setting is useful if you configured separate firstName and lastName attribute mappers and you want to use those to read attribute from LDAP into Keycloak")
                            .type(ProviderConfigProperty.BOOLEAN_TYPE)
                            .defaultValue(String.valueOf(!readOnly))
                             .add()
                            .build();
     }

◆ getHelpText()

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

inline

                                 {
         return "Used to map full-name of user from single attribute in LDAP (usually 'cn' attribute) to firstName and lastName attributes of UserModel in Keycloak DB";
     }

◆ getId()

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

38 {

39 }

◆ 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

54 {

55 }

◆ validateConfiguration()

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

inline

                                                                                                                                             {
         checkMandatoryConfigAttribute(FullNameLDAPStorageMapper.LDAP_FULL_NAME_ATTRIBUTE, "LDAP Full Name Attribute", config);
 
 
         boolean readOnly = AbstractLDAPStorageMapper.parseBooleanParameter(config, FullNameLDAPStorageMapper.READ_ONLY);
         boolean writeOnly = AbstractLDAPStorageMapper.parseBooleanParameter(config, FullNameLDAPStorageMapper.WRITE_ONLY);
 
         ComponentModel parent = realm.getComponent(config.getParentId());
         if (parent == null) {
             throw new ComponentValidationException("can't find parent component model");
 
         }
         LDAPConfig cfg = new LDAPConfig(parent.getConfig());
         UserStorageProvider.EditMode editMode = cfg.getEditMode();
 
         if (writeOnly && cfg.getEditMode() != UserStorageProvider.EditMode.WRITABLE) {
             throw new ComponentValidationException("ldapErrorCantWriteOnlyForReadOnlyLdap");
         }
         if (writeOnly && readOnly) {
             throw new ComponentValidationException("ldapErrorCantWriteOnlyAndReadOnly");
         }
     }

メンバ詳解

◆ configProperties

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

staticprotected

◆ PROVIDER_ID

final String org.keycloak.storage.ldap.mappers.FullNameLDAPStorageMapperFactory.PROVIDER_ID = "full-name-ldap-mapper"

static

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

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

公開メンバ関数

静的公開メンバ関数

静的公開変数類

限定公開メンバ関数

静的限定公開変数類

静的関数

静的非公開メンバ関数

詳解

関数詳解

◆ [static initializer]()

◆ checkMandatoryConfigAttribute()

◆ close()

◆ create()

◆ createConfigProperty()

◆ createMapper()

◆ getConfigProperties() [1/2]

◆ getConfigProperties() [2/2]

◆ getConfigProps()

◆ getHelpText()

◆ getId()

◆ getTypeMetadata()

◆ init()

◆ onCreate()

◆ onParentUpdate()

◆ postInit()

◆ validateConfiguration()

メンバ詳解

◆ configProperties

◆ PROVIDER_ID