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:
org.keycloak.broker.provider.IdentityProviderMapper
,SamlMetadataDescriptorUpdater
,org.keycloak.provider.ConfiguredProvider
,org.keycloak.provider.Provider
,org.keycloak.provider.ProviderFactory<org.keycloak.broker.provider.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
-
Constructor Summary
Constructors Constructor Description AttributeToRoleMapper()
-
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)
void
updateMetadata(org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.dom.saml.v2.metadata.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
-
-
-
-
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(org.keycloak.models.IdentityProviderSyncMode syncMode)
- Specified by:
supportsSyncMode
in interfaceorg.keycloak.broker.provider.IdentityProviderMapper
-
getConfigProperties
public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()
- Specified by:
getConfigProperties
in interfaceorg.keycloak.provider.ConfiguredProvider
-
getId
public String getId()
- Specified by:
getId
in interfaceorg.keycloak.provider.ProviderFactory<org.keycloak.broker.provider.IdentityProviderMapper>
-
getCompatibleProviders
public String[] getCompatibleProviders()
- Specified by:
getCompatibleProviders
in interfaceorg.keycloak.broker.provider.IdentityProviderMapper
-
getDisplayCategory
public String getDisplayCategory()
- Specified by:
getDisplayCategory
in interfaceorg.keycloak.broker.provider.IdentityProviderMapper
-
getDisplayType
public String getDisplayType()
- Specified by:
getDisplayType
in interfaceorg.keycloak.broker.provider.IdentityProviderMapper
-
applies
protected boolean applies(org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.broker.provider.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 interfaceorg.keycloak.provider.ConfiguredProvider
-
updateMetadata
public void updateMetadata(org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.dom.saml.v2.metadata.EntityDescriptorType entityDescriptor)
- Specified by:
updateMetadata
in interfaceSamlMetadataDescriptorUpdater
-
-