Package org.keycloak.storage.ldap.mappers

Class HardcodedLDAPRoleStorageMapperFactory

java.lang.Object

org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory

org.keycloak.storage.ldap.mappers.HardcodedLDAPRoleStorageMapperFactory

All Implemented Interfaces:

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

public class HardcodedLDAPRoleStorageMapperFactory
extends AbstractLDAPStorageMapperFactory

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<ProviderConfigProperty>	configProperties
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
HardcodedLDAPRoleStorageMapperFactory()

Method Summary

Modifier and Type	Method	Description
protected AbstractLDAPStorageMapper	createMapper(ComponentModel mapperModel, LDAPStorageProvider federationProvider)
Set<Class<? extends Provider>>	dependsOn()	Optional method used to declare that a ProviderFactory has a dependency on one or more Providers.
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.
void	validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config)	Called before a component is created or updated.

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

checkMandatoryConfigAttribute, close, create, createConfigProperty, createConfigProperty, getTypeMetadata, 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.component.ComponentFactory

create, getCommonProviderConfigProperties, onUpdate, preRemove

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

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

onCreate, onParentUpdate

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, order

Methods inherited from interface org.keycloak.component.SubComponentFactory

getConfigProperties, getTypeMetadata

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

configProperties

protected static final List<ProviderConfigProperty> configProperties

Constructor Details

HardcodedLDAPRoleStorageMapperFactory

public HardcodedLDAPRoleStorageMapperFactory()

Method Details

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.

dependsOn

public Set<Class<? extends Provider>> dependsOn()

Description copied from interface: ProviderFactory

Optional method used to declare that a ProviderFactory has a dependency on one or more Providers. If a Provider is declared here, it is guaranteed that the dependencies ProviderFactory.postInit(org.keycloak.models.KeycloakSessionFactory) method will be executed before this ProviderFactory's ProviderFactory.postInit(org.keycloak.models.KeycloakSessionFactory). Similarly, it's guaranteed that ProviderFactory.close() will be called on this ProviderFactory before ProviderFactory.close() is called on any of the dependent ProviderFactory implementations.

validateConfiguration

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

Description copied from interface: ComponentFactory

Called before a component is created or updated. Allows you to validate the configuration

Throws:

ComponentValidationException

createMapper

protected AbstractLDAPStorageMapper createMapper(ComponentModel mapperModel,
 LDAPStorageProvider federationProvider)

Specified by:

createMapper in class AbstractLDAPStorageMapperFactory