org.keycloak.federation.ldap.mappers

Class AbstractLDAPFederationMapperFactory

java.lang.Object

org.keycloak.federation.ldap.mappers.AbstractLDAPFederationMapperFactory

All Implemented Interfaces:

UserFederationMapperFactory, ConfiguredProvider, ProviderFactory<UserFederationMapper>

Direct Known Subclasses:

FullNameLDAPFederationMapperFactory, GroupLDAPFederationMapperFactory, HardcodedLDAPRoleMapperFactory, MSADUserAccountControlMapperFactory, RoleLDAPFederationMapperFactory, UserAttributeLDAPFederationMapperFactory

public abstract class AbstractLDAPFederationMapperFactory
extends Object
implements UserFederationMapperFactory

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_MAPPER_CATEGORY
static String	GROUP_MAPPER_CATEGORY
static String	ROLE_MAPPER_CATEGORY

Constructor Summary

Constructors

Constructor and Description
AbstractLDAPFederationMapperFactory()

Method Summary

Modifier and Type	Method and Description
protected void	checkMandatoryConfigAttribute(String name, String displayName, UserFederationMapperModel mapperModel)
void	close()
UserFederationMapper	create(KeycloakSession session)
static ProviderConfigProperty	createConfigProperty(String name, String label, String helpText, String type, Object defaultValue)
protected abstract AbstractLDAPFederationMapper	createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)
String	getFederationProviderType()
UserFederationMapperSyncConfigRepresentation	getSyncConfig()
void	init(Config.Scope config)
void	postInit(KeycloakSessionFactory factory)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.mappers.UserFederationMapperFactory

getDefaultConfig, getDisplayCategory, getDisplayType, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

getId

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfigProperties, getHelpText

Field Detail

ATTRIBUTE_MAPPER_CATEGORY

public static final String ATTRIBUTE_MAPPER_CATEGORY

See Also:

Constant Field Values

ROLE_MAPPER_CATEGORY

public static final String ROLE_MAPPER_CATEGORY

See Also:

Constant Field Values

GROUP_MAPPER_CATEGORY

public static final String GROUP_MAPPER_CATEGORY

See Also:

Constant Field Values

Constructor Detail

AbstractLDAPFederationMapperFactory

public AbstractLDAPFederationMapperFactory()

Method Detail

init

public void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<UserFederationMapper>

create

public UserFederationMapper create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<UserFederationMapper>

createMapper

protected abstract AbstractLDAPFederationMapper createMapper(UserFederationMapperModel mapperModel,
                                                             LDAPFederationProvider federationProvider,
                                                             RealmModel realm)

getFederationProviderType

public String getFederationProviderType()

Specified by:

getFederationProviderType in interface UserFederationMapperFactory

postInit

public void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<UserFederationMapper>

getSyncConfig

public UserFederationMapperSyncConfigRepresentation getSyncConfig()

Specified by:

getSyncConfig in interface UserFederationMapperFactory

close

public void close()

Specified by:

close in interface ProviderFactory<UserFederationMapper>

createConfigProperty

public static ProviderConfigProperty createConfigProperty(String name,
                                                          String label,
                                                          String helpText,
                                                          String type,
                                                          Object defaultValue)

checkMandatoryConfigAttribute

protected void checkMandatoryConfigAttribute(String name,
                                             String displayName,
                                             UserFederationMapperModel mapperModel)
                                      throws MapperConfigValidationException

Throws:

MapperConfigValidationException