org.keycloak.broker.provider

Class AbstractIdentityProviderMapper

java.lang.Object

org.keycloak.broker.provider.AbstractIdentityProviderMapper

All Implemented Interfaces:

IdentityProviderMapper, ConfiguredProvider, Provider, ProviderFactory<IdentityProviderMapper>

Direct Known Subclasses:

HardcodedRoleMapper

public abstract class AbstractIdentityProviderMapper
extends Object
implements IdentityProviderMapper

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

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

ANY_PROVIDER

Constructor Summary

Constructors

Constructor and Description
AbstractIdentityProviderMapper()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
IdentityProviderMapper	create(KeycloakSession session)
void	init(Config.Scope config)
void	postInit(KeycloakSessionFactory factory)
void	preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) Called to determine what keycloak username and email to use to process the login request from the external IDP Usually used to map BrokeredIdentityContet.username or email.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getCompatibleProviders, getDisplayCategory, getDisplayType, importNewUser, updateBrokeredUser

Methods inherited from interface org.keycloak.provider.ProviderFactory

getId

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfigProperties, getHelpText

Constructor Detail

AbstractIdentityProviderMapper

public AbstractIdentityProviderMapper()

Method Detail

close

public void close()

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<IdentityProviderMapper>

create

public IdentityProviderMapper create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<IdentityProviderMapper>

init

public void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<IdentityProviderMapper>

postInit

public void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<IdentityProviderMapper>

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 Usually used to map BrokeredIdentityContet.username or email.

Specified by:

preprocessFederatedIdentity in interface IdentityProviderMapper