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 final String	ATTRIBUTE_FRIENDLY_NAME
static final String	ATTRIBUTE_NAME
static final String	ATTRIBUTE_VALUE
static final String[]	COMPATIBLE_PROVIDERS
static final 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

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 return true if their mapping can be applied (i.e. user has the SAML attribute that should be mapped) or false otherwise.
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, dependsOn, 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 Details

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

Constructor Details

AttributeToRoleMapper

public AttributeToRoleMapper()

Method Details

supportsSyncMode

public boolean supportsSyncMode(org.keycloak.models.IdentityProviderSyncMode syncMode)

Specified by:

supportsSyncMode in interface org.keycloak.broker.provider.IdentityProviderMapper

getConfigProperties

public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface org.keycloak.provider.ConfiguredProvider

getId

public String getId()

Specified by:

getId in interface org.keycloak.provider.ProviderFactory<org.keycloak.broker.provider.IdentityProviderMapper>

getCompatibleProviders

public String[] getCompatibleProviders()

Specified by:

getCompatibleProviders in interface org.keycloak.broker.provider.IdentityProviderMapper

getDisplayCategory

public String getDisplayCategory()

Specified by:

getDisplayCategory in interface org.keycloak.broker.provider.IdentityProviderMapper

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface org.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 return true if their mapping can be applied (i.e. user has the SAML attribute that should be mapped) or false otherwise.

Specified by:

applies in class AbstractAttributeToRoleMapper

Parameters:

mapperModel - a reference to the IdentityProviderMapperModel.

context - a reference to the BrokeredIdentityContext.

Returns:

true if the mapping can be applied or false otherwise.

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface org.keycloak.provider.ConfiguredProvider

updateMetadata

public void updateMetadata(org.keycloak.models.IdentityProviderMapperModel mapperModel,
 org.keycloak.dom.saml.v2.metadata.EntityDescriptorType entityDescriptor)

Specified by:

updateMetadata in interface SamlMetadataDescriptorUpdater