Package org.keycloak.broker.saml.mappers

Class AdvancedAttributeToGroupMapper

java.lang.Object

org.keycloak.broker.provider.AbstractIdentityProviderMapper

org.keycloak.broker.saml.mappers.AbstractAttributeToGroupMapper

org.keycloak.broker.saml.mappers.AdvancedAttributeToGroupMapper

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 AdvancedAttributeToGroupMapper
extends AbstractAttributeToGroupMapper

Author:

Denis Bernard

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARE_ATTRIBUTE_VALUES_REGEX_PROPERTY_NAME
static final String	ATTRIBUTE_PROPERTY_NAME
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
AdvancedAttributeToGroupMapper()

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)

Methods inherited from class org.keycloak.broker.saml.mappers.AbstractAttributeToGroupMapper

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

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

ATTRIBUTE_PROPERTY_NAME

public static final String ATTRIBUTE_PROPERTY_NAME

See Also:

• Constant Field Values

ARE_ATTRIBUTE_VALUES_REGEX_PROPERTY_NAME

public static final String ARE_ATTRIBUTE_VALUES_REGEX_PROPERTY_NAME

See Also:

• Constant Field Values

COMPATIBLE_PROVIDERS

public static final String[] COMPATIBLE_PROVIDERS

Constructor Details

AdvancedAttributeToGroupMapper

public AdvancedAttributeToGroupMapper()

Method Details

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: AbstractAttributeToGroupMapper

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 AbstractAttributeToGroupMapper

Parameters:

mapperModel - a reference to the IdentityProviderMapperModel.

context - a reference to the BrokeredIdentityContext.

Returns:

true if the mapping can be applied or false otherwise.