Package org.keycloak.broker.saml.mappers

Class UsernameTemplateMapper

java.lang.Object

org.keycloak.broker.provider.AbstractIdentityProviderMapper

org.keycloak.broker.saml.mappers.UsernameTemplateMapper

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 UsernameTemplateMapper
extends org.keycloak.broker.provider.AbstractIdentityProviderMapper

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UsernameTemplateMapper.Target

Field Summary

Fields

Modifier and Type	Field	Description
static String[]	COMPATIBLE_PROVIDERS
static String	PROVIDER_ID
static String	TARGET
static List<String>	TARGETS
static String	TEMPLATE
static Map<String,UnaryOperator<String>>	TRANSFORMERS

Fields inherited from interface org.keycloak.broker.provider.IdentityProviderMapper

ANY_PROVIDER, DEFAULT_IDENTITY_PROVIDER_MAPPER_SYNC_MODES

Constructor Summary

Constructors

Constructor	Description
UsernameTemplateMapper()

Method Summary

Modifier and Type	Method	Description
String[]	getCompatibleProviders()
List<org.keycloak.provider.ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
static String	getEmailLocalPart(String email)
String	getHelpText()
String	getId()
static UsernameTemplateMapper.Target	getTarget(String value)
void	preprocessFederatedIdentity(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.broker.provider.BrokeredIdentityContext context)
boolean	supportsSyncMode(org.keycloak.models.IdentityProviderSyncMode syncMode)
void	updateBrokeredUser(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.broker.provider.BrokeredIdentityContext context)
void	updateBrokeredUserLegacy(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.IdentityProviderMapperModel mapperModel, org.keycloak.broker.provider.BrokeredIdentityContext context)

Methods inherited from class org.keycloak.broker.provider.AbstractIdentityProviderMapper

close, create, importNewUser, init, postInit

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

TEMPLATE

public static final String TEMPLATE

See Also:

Constant Field Values

TARGET

public static final String TARGET

See Also:

Constant Field Values

TARGETS

public static final List<String> TARGETS

TRANSFORMERS

public static final Map<String,UnaryOperator<String>> TRANSFORMERS

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

Constant Field Values

Constructor Detail

UsernameTemplateMapper

public UsernameTemplateMapper()

Method Detail

getEmailLocalPart

public static String getEmailLocalPart(String email)

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()

updateBrokeredUserLegacy

public void updateBrokeredUserLegacy(org.keycloak.models.KeycloakSession session,
                                     org.keycloak.models.RealmModel realm,
                                     org.keycloak.models.UserModel user,
                                     org.keycloak.models.IdentityProviderMapperModel mapperModel,
                                     org.keycloak.broker.provider.BrokeredIdentityContext context)

Specified by:

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

Overrides:

updateBrokeredUserLegacy in class org.keycloak.broker.provider.AbstractIdentityProviderMapper

updateBrokeredUser

public void updateBrokeredUser(org.keycloak.models.KeycloakSession session,
                               org.keycloak.models.RealmModel realm,
                               org.keycloak.models.UserModel user,
                               org.keycloak.models.IdentityProviderMapperModel mapperModel,
                               org.keycloak.broker.provider.BrokeredIdentityContext context)

Specified by:

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

Overrides:

updateBrokeredUser in class org.keycloak.broker.provider.AbstractIdentityProviderMapper

preprocessFederatedIdentity

public void preprocessFederatedIdentity(org.keycloak.models.KeycloakSession session,
                                        org.keycloak.models.RealmModel realm,
                                        org.keycloak.models.IdentityProviderMapperModel mapperModel,
                                        org.keycloak.broker.provider.BrokeredIdentityContext context)

Specified by:

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

Overrides:

preprocessFederatedIdentity in class org.keycloak.broker.provider.AbstractIdentityProviderMapper

getHelpText

public String getHelpText()

getTarget

public static UsernameTemplateMapper.Target getTarget(String value)