Package org.keycloak.broker.saml.mappers
Class AttributeToRoleMapper
- java.lang.Object
-
- org.keycloak.broker.provider.AbstractIdentityProviderMapper
-
- org.keycloak.broker.saml.mappers.AbstractAttributeToRoleMapper
-
- org.keycloak.broker.saml.mappers.AttributeToRoleMapper
-
- All Implemented Interfaces:
IdentityProviderMapper
,SamlMetadataDescriptorUpdater
,ConfiguredProvider
,Provider
,ProviderFactory<IdentityProviderMapper>
public class AttributeToRoleMapper extends AbstractAttributeToRoleMapper implements SamlMetadataDescriptorUpdater
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Field Summary
Fields Modifier and Type Field Description static String
ATTRIBUTE_FRIENDLY_NAME
static String
ATTRIBUTE_NAME
static String
ATTRIBUTE_VALUE
static String[]
COMPATIBLE_PROVIDERS
static String
PROVIDER_ID
-
Fields inherited from interface org.keycloak.broker.provider.IdentityProviderMapper
ANY_PROVIDER, DEFAULT_IDENTITY_PROVIDER_MAPPER_SYNC_MODES
-
-
Constructor Summary
Constructors Constructor Description AttributeToRoleMapper()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected 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.String[]
getCompatibleProviders()
List<ProviderConfigProperty>
getConfigProperties()
String
getDisplayCategory()
String
getDisplayType()
String
getHelpText()
String
getId()
boolean
supportsSyncMode(IdentityProviderSyncMode syncMode)
void
updateMetadata(IdentityProviderMapperModel mapperModel, EntityDescriptorType entityDescriptor)
-
Methods inherited from class org.keycloak.broker.saml.mappers.AbstractAttributeToRoleMapper
importNewUser, updateBrokeredUser
-
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
-
Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, order
-
-
-
-
Field Detail
-
COMPATIBLE_PROVIDERS
public static final String[] COMPATIBLE_PROVIDERS
-
ATTRIBUTE_NAME
public static final String ATTRIBUTE_NAME
- See Also:
- Constant Field Values
-
ATTRIBUTE_FRIENDLY_NAME
public static final String ATTRIBUTE_FRIENDLY_NAME
- See Also:
- Constant Field Values
-
ATTRIBUTE_VALUE
public static final String ATTRIBUTE_VALUE
- See Also:
- Constant Field Values
-
PROVIDER_ID
public static final String PROVIDER_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
supportsSyncMode
public boolean supportsSyncMode(IdentityProviderSyncMode syncMode)
- Specified by:
supportsSyncMode
in interfaceIdentityProviderMapper
-
getConfigProperties
public List<ProviderConfigProperty> getConfigProperties()
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
getId
public String getId()
- Specified by:
getId
in interfaceProviderFactory<IdentityProviderMapper>
-
getCompatibleProviders
public String[] getCompatibleProviders()
- Specified by:
getCompatibleProviders
in interfaceIdentityProviderMapper
-
getDisplayCategory
public String getDisplayCategory()
- Specified by:
getDisplayCategory
in interfaceIdentityProviderMapper
-
getDisplayType
public String getDisplayType()
- Specified by:
getDisplayType
in interfaceIdentityProviderMapper
-
applies
protected boolean applies(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
Description copied from class:AbstractAttributeToRoleMapper
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.- Specified by:
applies
in classAbstractAttributeToRoleMapper
- Parameters:
mapperModel
- a reference to theIdentityProviderMapperModel
.context
- a reference to theBrokeredIdentityContext
.- Returns:
true
if the mapping can be applied orfalse
otherwise.
-
getHelpText
public String getHelpText()
- Specified by:
getHelpText
in interfaceConfiguredProvider
-
updateMetadata
public void updateMetadata(IdentityProviderMapperModel mapperModel, EntityDescriptorType entityDescriptor)
- Specified by:
updateMetadata
in interfaceSamlMetadataDescriptorUpdater
-
-