Package org.keycloak.broker.oidc.mappers
Class AdvancedClaimToGroupMapper
- java.lang.Object
-
- org.keycloak.broker.provider.AbstractIdentityProviderMapper
-
- org.keycloak.broker.oidc.mappers.AbstractClaimMapper
-
- org.keycloak.broker.oidc.mappers.AbstractClaimToGroupMapper
-
- org.keycloak.broker.oidc.mappers.AdvancedClaimToGroupMapper
-
- 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>
public class AdvancedClaimToGroupMapper extends AbstractClaimToGroupMapper
-
-
Field Summary
Fields Modifier and Type Field Description static String
ARE_CLAIM_VALUES_REGEX_PROPERTY_NAME
static String
CLAIM_PROPERTY_NAME
static String[]
COMPATIBLE_PROVIDERS
static String
PROVIDER_ID
-
Fields inherited from class org.keycloak.broker.oidc.mappers.AbstractClaimMapper
CLAIM, CLAIM_VALUE
-
-
Constructor Summary
Constructors Constructor Description AdvancedClaimToGroupMapper()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected 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.String[]
getCompatibleProviders()
List<org.keycloak.provider.ProviderConfigProperty>
getConfigProperties()
String
getDisplayCategory()
String
getDisplayType()
String
getHelpText()
String
getId()
boolean
supportsSyncMode(org.keycloak.models.IdentityProviderSyncMode syncMode)
-
Methods inherited from class org.keycloak.broker.oidc.mappers.AbstractClaimToGroupMapper
importNewUser, updateBrokeredUser
-
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
-
-
-
-
Field Detail
-
CLAIM_PROPERTY_NAME
public static final String CLAIM_PROPERTY_NAME
- See Also:
- Constant Field Values
-
ARE_CLAIM_VALUES_REGEX_PROPERTY_NAME
public static final String ARE_CLAIM_VALUES_REGEX_PROPERTY_NAME
- See Also:
- Constant Field Values
-
COMPATIBLE_PROVIDERS
public static final String[] COMPATIBLE_PROVIDERS
-
PROVIDER_ID
public static final String PROVIDER_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
supportsSyncMode
public boolean supportsSyncMode(org.keycloak.models.IdentityProviderSyncMode syncMode)
-
getConfigProperties
public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()
-
getId
public String getId()
-
getCompatibleProviders
public String[] getCompatibleProviders()
-
getDisplayCategory
public String getDisplayCategory()
-
getDisplayType
public String getDisplayType()
-
getHelpText
public String getHelpText()
-
applies
protected boolean applies(org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.broker.provider.BrokeredIdentityContext context)
Description copied from class:AbstractClaimToGroupMapper
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.- Specified by:
applies
in classAbstractClaimToGroupMapper
- Parameters:
mapperModel
- a reference to theIdentityProviderMapperModel
.context
- a reference to theBrokeredIdentityContext
.- Returns:
true
if the mapping can be applied orfalse
otherwise.*
-
-