Package org.keycloak.broker.saml.mappers
Class AbstractAttributeToGroupMapper
- java.lang.Object
-
- org.keycloak.broker.provider.AbstractIdentityProviderMapper
-
- org.keycloak.broker.saml.mappers.AbstractAttributeToGroupMapper
-
- All Implemented Interfaces:
IdentityProviderMapper
,ConfiguredProvider
,Provider
,ProviderFactory<IdentityProviderMapper>
- Direct Known Subclasses:
AdvancedAttributeToGroupMapper
public abstract class AbstractAttributeToGroupMapper extends AbstractIdentityProviderMapper
Abstract class that handles the logic for importing and updating brokered users for all mappers that map a SAML attribute into aKeycloak
group.- Author:
- Denis Bernard,
-
-
Field Summary
-
Fields inherited from interface org.keycloak.broker.provider.IdentityProviderMapper
ANY_PROVIDER, DEFAULT_IDENTITY_PROVIDER_MAPPER_SYNC_MODES
-
-
Constructor Summary
Constructors Constructor Description AbstractAttributeToGroupMapper()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract boolean
applies(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
This method must be implemented by subclasses and they must returntrue
if their mapping can be applied (i.e.void
importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
Called after UserModel is created for first time for this user.void
updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
Called when this user has logged in before and has already been imported.-
Methods inherited from class org.keycloak.broker.provider.AbstractIdentityProviderMapper
close, create, init, postInit, preprocessFederatedIdentity, updateBrokeredUserLegacy
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig, getConfigProperties, getHelpText
-
Methods inherited from interface org.keycloak.broker.provider.IdentityProviderMapper
getCompatibleProviders, getDisplayCategory, getDisplayType, supportsSyncMode
-
Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, getId, order
-
-
-
-
Method Detail
-
importNewUser
public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
Description copied from interface:IdentityProviderMapper
Called after UserModel is created for first time for this user. Called after "FirstBrokerLogin" flow- Specified by:
importNewUser
in interfaceIdentityProviderMapper
- Overrides:
importNewUser
in classAbstractIdentityProviderMapper
-
updateBrokeredUser
public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
Description copied from interface:IdentityProviderMapper
Called when this user has logged in before and has already been imported.- Specified by:
updateBrokeredUser
in interfaceIdentityProviderMapper
- Overrides:
updateBrokeredUser
in classAbstractIdentityProviderMapper
-
applies
protected abstract boolean applies(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
This method must be implemented by subclasses and they must returntrue
if their mapping can be applied (i.e. user has the SAML attribute that should be mapped) orfalse
otherwise.- Parameters:
mapperModel
- a reference to theIdentityProviderMapperModel
.context
- a reference to theBrokeredIdentityContext
.- Returns:
true
if the mapping can be applied orfalse
otherwise.
-
-