Package org.keycloak.broker.provider
Class HardcodedUserSessionAttributeMapper
- java.lang.Object
-
- org.keycloak.broker.provider.AbstractIdentityProviderMapper
-
- org.keycloak.broker.provider.HardcodedUserSessionAttributeMapper
-
- All Implemented Interfaces:
IdentityProviderMapper
,ConfiguredProvider
,Provider
,ProviderFactory<IdentityProviderMapper>
public class HardcodedUserSessionAttributeMapper extends AbstractIdentityProviderMapper
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Field Summary
Fields Modifier and Type Field Description static String
ATTRIBUTE
static String
ATTRIBUTE_VALUE
static String[]
COMPATIBLE_PROVIDERS
protected static List<ProviderConfigProperty>
configProperties
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 HardcodedUserSessionAttributeMapper()
-
Method Summary
-
Methods inherited from class org.keycloak.broker.provider.AbstractIdentityProviderMapper
close, create, init, postInit, 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
-
ATTRIBUTE
public static final String ATTRIBUTE
- See Also:
- Constant Field Values
-
ATTRIBUTE_VALUE
public static final String ATTRIBUTE_VALUE
- See Also:
- Constant Field Values
-
configProperties
protected static final List<ProviderConfigProperty> configProperties
-
COMPATIBLE_PROVIDERS
public static final String[] COMPATIBLE_PROVIDERS
-
PROVIDER_ID
public static final String PROVIDER_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
supportsSyncMode
public boolean supportsSyncMode(IdentityProviderSyncMode syncMode)
-
getConfigProperties
public List<ProviderConfigProperty> getConfigProperties()
-
getDisplayCategory
public String getDisplayCategory()
-
getDisplayType
public String getDisplayType()
-
getId
public String getId()
-
getCompatibleProviders
public String[] getCompatibleProviders()
-
preprocessFederatedIdentity
public void preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
Description copied from interface:IdentityProviderMapper
Called to determine what keycloak username and email to use to process the login request from the external IDP. It's called before "FirstBrokerLogin" flow, so can be used to map attributes to BrokeredIdentityContext ( BrokeredIdentityContext.setUserAttribute ), which will be available on "Review Profile" page and in authenticators during FirstBrokerLogin flow- Specified by:
preprocessFederatedIdentity
in interfaceIdentityProviderMapper
- Overrides:
preprocessFederatedIdentity
in classAbstractIdentityProviderMapper
-
updateBrokeredUser
public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
Description copied from interface:IdentityProviderMapper
Called when this user has logged in before and has already been imported.- Specified by:
updateBrokeredUser
in interfaceIdentityProviderMapper
- Overrides:
updateBrokeredUser
in classAbstractIdentityProviderMapper
-
importNewUser
public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
Description copied from interface:IdentityProviderMapper
Called after UserModel is created for first time for this user. Called after "FirstBrokerLogin" flow- Specified by:
importNewUser
in interfaceIdentityProviderMapper
- Overrides:
importNewUser
in classAbstractIdentityProviderMapper
-
getHelpText
public String getHelpText()
-
-