Package org.keycloak.userprofile

Class AbstractUserProfileProvider<U extends UserProfileProvider>

java.lang.Object

org.keycloak.userprofile.AbstractUserProfileProvider<U>

All Implemented Interfaces:

Provider, ProviderFactory<U>, UserProfileProvider, UserProfileProviderFactory<U>

Direct Known Subclasses:

DeclarativeUserProfileProvider

public abstract class AbstractUserProfileProvider<U extends UserProfileProvider>
extends Object
implements UserProfileProvider, UserProfileProviderFactory<U>

A base class for UserProfileProvider implementations providing the main hooks for customizations.

Author:

Markus Till

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_ADMIN_READ_ONLY_ATTRIBUTES
static final String	CONFIG_READ_ONLY_ATTRIBUTES
protected final Map<UserProfileContext,UserProfileMetadata>	contextualMetadataRegistry
protected final KeycloakSession	session

Constructor Summary

Constructors

Constructor	Description
AbstractUserProfileProvider()
AbstractUserProfileProvider(KeycloakSession session, Map<UserProfileContext,UserProfileMetadata> contextualMetadataRegistry)

Method Summary

Modifier and Type	Method	Description
void	close()
protected UserProfileMetadata	configureUserProfile(UserProfileMetadata metadata)	Sub-types can override this method to customize how contextual profile metadata is configured at init time.
protected UserProfileMetadata	configureUserProfile(UserProfileMetadata metadata, KeycloakSession session)	Sub-types can override this method to customize how contextual profile metadata is configured at runtime.
U	create(KeycloakSession session)
protected abstract U	create(KeycloakSession session, Map<UserProfileContext,UserProfileMetadata> metadataRegistry)	Subclasses can override this method to create their instances of UserProfileProvider.
UserProfile	create(UserProfileContext context, Map<String,?> attributes)
UserProfile	create(UserProfileContext context, Map<String,?> attributes, UserModel user)
UserProfile	create(UserProfileContext context, UserModel user)
protected Attributes	createAttributes(UserProfileContext context, Map<String,?> attributes, UserModel user, UserProfileMetadata metadata)
List<ProviderConfigProperty>	getConfigMetadata()
String	getConfiguration()
static Pattern	getRegexPatternString(String[] builtinReadOnlyAttributes)
void	init(Config.Scope config)
void	postInit(KeycloakSessionFactory factory)
void	setConfiguration(String configuration)

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.ProviderFactory

getId, order

Field Details

CONFIG_ADMIN_READ_ONLY_ATTRIBUTES

public static final String CONFIG_ADMIN_READ_ONLY_ATTRIBUTES

See Also:

• Constant Field Values

CONFIG_READ_ONLY_ATTRIBUTES

public static final String CONFIG_READ_ONLY_ATTRIBUTES

See Also:

• Constant Field Values

contextualMetadataRegistry

protected final Map<UserProfileContext,UserProfileMetadata> contextualMetadataRegistry

session

protected final KeycloakSession session

Constructor Details

AbstractUserProfileProvider

public AbstractUserProfileProvider()

AbstractUserProfileProvider

public AbstractUserProfileProvider(KeycloakSession session,
 Map<UserProfileContext,UserProfileMetadata> contextualMetadataRegistry)

Method Details

getRegexPatternString

public static Pattern getRegexPatternString(String[] builtinReadOnlyAttributes)

create

public UserProfile create(UserProfileContext context,
 UserModel user)

Specified by:

create in interface UserProfileProvider

create

public UserProfile create(UserProfileContext context,
 Map<String,?> attributes,
 UserModel user)

Specified by:

create in interface UserProfileProvider

create

public UserProfile create(UserProfileContext context,
 Map<String,?> attributes)

Specified by:

create in interface UserProfileProvider

create

public U create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<U extends UserProfileProvider>

init

public void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<U extends UserProfileProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<U extends UserProfileProvider>

close

public void close()

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<U extends UserProfileProvider>

getConfiguration

public String getConfiguration()

Specified by:

getConfiguration in interface UserProfileProvider

setConfiguration

public void setConfiguration(String configuration)

Specified by:

setConfiguration in interface UserProfileProvider

create

protected abstract U create(KeycloakSession session,
 Map<UserProfileContext,UserProfileMetadata> metadataRegistry)

Subclasses can override this method to create their instances of UserProfileProvider.

Parameters:

session - the session

metadataRegistry - the profile metadata

Returns:

the profile provider instance

configureUserProfile

protected UserProfileMetadata configureUserProfile(UserProfileMetadata metadata)

Sub-types can override this method to customize how contextual profile metadata is configured at init time.

Parameters:

metadata - the profile metadata

Returns:

the metadata

configureUserProfile

protected UserProfileMetadata configureUserProfile(UserProfileMetadata metadata,
 KeycloakSession session)

Sub-types can override this method to customize how contextual profile metadata is configured at runtime.

Parameters:

metadata - the profile metadata

session - the current session

Returns:

the metadata

createAttributes

protected Attributes createAttributes(UserProfileContext context,
 Map<String,?> attributes,
 UserModel user,
 UserProfileMetadata metadata)

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Specified by:

getConfigMetadata in interface ProviderFactory<U extends UserProfileProvider>