org.keycloak.storage.ldap.mappers.membership.role

Class RoleLDAPStorageMapperFactory

java.lang.Object

org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory

org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapperFactory

All Implemented Interfaces:

ComponentFactory<LDAPStorageMapper,LDAPStorageMapper>, SubComponentFactory<LDAPStorageMapper,LDAPStorageMapper>, ConfiguredProvider, ProviderFactory<LDAPStorageMapper>, LDAPStorageMapperFactory<LDAPStorageMapper>

public class RoleLDAPStorageMapperFactory
extends AbstractLDAPStorageMapperFactory

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<ProviderConfigProperty>	configProperties
protected static List<String>	MEMBERSHIP_TYPES
protected static List<String>	MODES
static String	PROVIDER_ID
protected static List<String>	roleRetrievers
protected static Map<String,UserRolesRetrieveStrategy>	userRolesStrategies

Fields inherited from class org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory

ATTRIBUTE_MAPPER_CATEGORY, GROUP_MAPPER_CATEGORY, ROLE_MAPPER_CATEGORY

Constructor Summary

Constructors

Constructor and Description
RoleLDAPStorageMapperFactory()

Method Summary

Modifier and Type	Method and Description
protected AbstractLDAPStorageMapper	createMapper(ComponentModel mapperModel, LDAPStorageProvider federationProvider)
List<ProviderConfigProperty>	getConfigProperties()
String	getHelpText()
String	getId() This is the name of the provider and will be showed in the admin console as an option.
Map<String,Object>	getTypeMetadata()
protected UserRolesRetrieveStrategy	getUserRolesRetrieveStrategy(String strategyKey)
void	validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config)

Methods inherited from class org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory

checkMandatoryConfigAttribute, close, create, createConfigProperty, init, postInit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory

onCreate

Methods inherited from interface org.keycloak.component.SubComponentFactory

getConfigProperties, getTypeMetadata

Methods inherited from interface org.keycloak.component.ComponentFactory

create, getCommonProviderConfigProperties, onUpdate

Field Detail

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

Constant Field Values

configProperties

protected static final List<ProviderConfigProperty> configProperties

userRolesStrategies

protected static final Map<String,UserRolesRetrieveStrategy> userRolesStrategies

MEMBERSHIP_TYPES

protected static final List<String> MEMBERSHIP_TYPES

MODES

protected static final List<String> MODES

roleRetrievers

protected static final List<String> roleRetrievers

Constructor Detail

RoleLDAPStorageMapperFactory

public RoleLDAPStorageMapperFactory()

Method Detail

getHelpText

public String getHelpText()

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

getId

public String getId()

Description copied from interface: LDAPStorageMapperFactory

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

getTypeMetadata

public Map<String,Object> getTypeMetadata()

Specified by:

getTypeMetadata in interface ComponentFactory<LDAPStorageMapper,LDAPStorageMapper>

Overrides:

getTypeMetadata in class AbstractLDAPStorageMapperFactory

validateConfiguration

public void validateConfiguration(KeycloakSession session,
                                  RealmModel realm,
                                  ComponentModel config)
                           throws ComponentValidationException

Throws:

ComponentValidationException

createMapper

protected AbstractLDAPStorageMapper createMapper(ComponentModel mapperModel,
                                                 LDAPStorageProvider federationProvider)

Specified by:

createMapper in class AbstractLDAPStorageMapperFactory

getUserRolesRetrieveStrategy

protected UserRolesRetrieveStrategy getUserRolesRetrieveStrategy(String strategyKey)