Package org.keycloak.broker.oidc.mappers
Class AbstractClaimToGroupMapper
- java.lang.Object
-
- org.keycloak.broker.provider.AbstractIdentityProviderMapper
-
- org.keycloak.broker.oidc.mappers.AbstractClaimMapper
-
- org.keycloak.broker.oidc.mappers.AbstractClaimToGroupMapper
-
- All Implemented Interfaces:
org.keycloak.broker.provider.IdentityProviderMapper
,org.keycloak.provider.ConfiguredProvider
,org.keycloak.provider.Provider
,org.keycloak.provider.ProviderFactory<org.keycloak.broker.provider.IdentityProviderMapper>
- Direct Known Subclasses:
AdvancedClaimToGroupMapper
public abstract class AbstractClaimToGroupMapper extends AbstractClaimMapper
- Author:
- Artur Baltabayev, Daniel Fesenmeyer
-
-
Field Summary
-
Fields inherited from class org.keycloak.broker.oidc.mappers.AbstractClaimMapper
CLAIM, CLAIM_VALUE
-
-
Constructor Summary
Constructors Constructor Description AbstractClaimToGroupMapper()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract boolean
applies(org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.broker.provider.BrokeredIdentityContext context)
This method must be implemented by subclasses and they must returntrue
if their mapping can be applied (i.e.void
importNewUser(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.broker.provider.BrokeredIdentityContext context)
void
updateBrokeredUser(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.broker.provider.BrokeredIdentityContext context)
-
Methods inherited from class org.keycloak.broker.oidc.mappers.AbstractClaimMapper
getClaimValue, getClaimValue, getClaimValue, hasClaimValue, valueEquals
-
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
-
-
-
-
Method Detail
-
importNewUser
public void importNewUser(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.broker.provider.BrokeredIdentityContext context)
- Specified by:
importNewUser
in interfaceorg.keycloak.broker.provider.IdentityProviderMapper
- Overrides:
importNewUser
in classorg.keycloak.broker.provider.AbstractIdentityProviderMapper
-
updateBrokeredUser
public void updateBrokeredUser(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.broker.provider.BrokeredIdentityContext context)
- Specified by:
updateBrokeredUser
in interfaceorg.keycloak.broker.provider.IdentityProviderMapper
- Overrides:
updateBrokeredUser
in classorg.keycloak.broker.provider.AbstractIdentityProviderMapper
-
applies
protected abstract boolean applies(org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.broker.provider.BrokeredIdentityContext context)
This method must be implemented by subclasses and they must returntrue
if their mapping can be applied (i.e. user has the OIDC claim 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.*
-
-