public abstract class AbstractLDAPFederationMapperFactory extends Object implements UserFederationMapperFactory
Modifier and Type | Field and Description |
---|---|
static String |
ATTRIBUTE_MAPPER_CATEGORY |
static String |
GROUP_MAPPER_CATEGORY |
static String |
ROLE_MAPPER_CATEGORY |
Constructor and Description |
---|
AbstractLDAPFederationMapperFactory() |
Modifier and Type | Method and Description |
---|---|
protected void |
checkMandatoryConfigAttribute(String name,
String displayName,
UserFederationMapperModel mapperModel) |
void |
close()
This is called when the server shuts down.
|
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()
Refers to providerName (type) of the federated provider, which this mapper can be used for.
|
UserFederationMapperSyncConfigRepresentation |
getSyncConfig()
Specifies if mapper supports sync data from federated storage to keycloak and viceversa.
|
void |
init(Config.Scope config)
Only called once when the factory is first created.
|
void |
postInit(KeycloakSessionFactory factory)
Called after all provider factories have been initialized
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDefaultConfig, getDisplayCategory, getDisplayType, validateConfig
getId
getConfigProperties, getHelpText
public static final String ATTRIBUTE_MAPPER_CATEGORY
public static final String ROLE_MAPPER_CATEGORY
public static final String GROUP_MAPPER_CATEGORY
public void init(Config.Scope config)
ProviderFactory
init
in interface ProviderFactory<UserFederationMapper>
public UserFederationMapper create(KeycloakSession session)
create
in interface ProviderFactory<UserFederationMapper>
protected abstract AbstractLDAPFederationMapper createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)
public String getFederationProviderType()
UserFederationMapperFactory
getFederationProviderType
in interface UserFederationMapperFactory
public void postInit(KeycloakSessionFactory factory)
ProviderFactory
postInit
in interface ProviderFactory<UserFederationMapper>
public UserFederationMapperSyncConfigRepresentation getSyncConfig()
UserFederationMapperFactory
getSyncConfig
in interface UserFederationMapperFactory
public void close()
ProviderFactory
close
in interface ProviderFactory<UserFederationMapper>
public static ProviderConfigProperty createConfigProperty(String name, String label, String helpText, String type, Object defaultValue)
protected void checkMandatoryConfigAttribute(String name, String displayName, UserFederationMapperModel mapperModel) throws FederationConfigValidationException
Copyright © 2016 JBoss by Red Hat. All rights reserved.