Package org.keycloak.userprofile

Class DeclarativeUserProfileProvider

java.lang.Object

org.keycloak.userprofile.DeclarativeUserProfileProvider

All Implemented Interfaces:

Provider, UserProfileProvider

public class DeclarativeUserProfileProvider
extends Object
implements UserProfileProvider

UserProfileProvider loading configuration from the changeable JSON file stored in component config. Parsed configuration is cached.

Author:

Pedro Igor, Vlastimil Elias <velias@redhat.com>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	PARSED_CONFIG_COMPONENT_KEY
protected static final String	PARSED_UP_CONFIG_COMPONENT_KEY
protected final UPConfig	parsedDefaultRawConfig
static final String	UP_COMPONENT_CONFIG_KEY

Constructor Summary

Constructors

Constructor	Description
DeclarativeUserProfileProvider(KeycloakSession session, DeclarativeUserProfileProviderFactory factory)

Method Summary

Modifier and Type	Method	Description
void	close()
protected UserProfileMetadata	configureUserProfile(UserProfileMetadata metadata, KeycloakSession session)	Specifies how contextual profile metadata is configured at runtime.
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)
protected ComponentModel	createComponentModel()	Create the component model to store configuration
protected AttributeValidatorMetadata	createConfiguredValidator(String validator, Map<String,Object> validatorConfig)	Create validator for validation configured in the user profile config.
protected UserProfileMetadata	decorateUserProfileForCache(UserProfileMetadata decoratedMetadata, UPConfig parsedConfig)	Decorate basic metadata based on 'per realm' configuration.
UPConfig	getConfiguration()
protected UPConfig	parseConfigOrDefault(ComponentModel component)	Get parsed config file configured in model.
void	setConfiguration(UPConfig configuration)

Methods inherited from class java.lang.Object

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

Field Details

UP_COMPONENT_CONFIG_KEY

public static final String UP_COMPONENT_CONFIG_KEY

See Also:

• Constant Field Values

PARSED_CONFIG_COMPONENT_KEY

protected static final String PARSED_CONFIG_COMPONENT_KEY

See Also:

• Constant Field Values

PARSED_UP_CONFIG_COMPONENT_KEY

protected static final String PARSED_UP_CONFIG_COMPONENT_KEY

See Also:

• Constant Field Values

parsedDefaultRawConfig

protected final UPConfig parsedDefaultRawConfig

Constructor Details

DeclarativeUserProfileProvider

public DeclarativeUserProfileProvider(KeycloakSession session,
 DeclarativeUserProfileProviderFactory factory)

Method Details

createAttributes

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

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

configureUserProfile

protected UserProfileMetadata configureUserProfile(UserProfileMetadata metadata,
 KeycloakSession session)

Specifies how contextual profile metadata is configured at runtime.

Parameters:

metadata - the profile metadata

Returns:

the metadata

getConfiguration

public UPConfig getConfiguration()

Specified by:

getConfiguration in interface UserProfileProvider

setConfiguration

public void setConfiguration(UPConfig configuration)

Specified by:

setConfiguration in interface UserProfileProvider

decorateUserProfileForCache

protected UserProfileMetadata decorateUserProfileForCache(UserProfileMetadata decoratedMetadata,
 UPConfig parsedConfig)

Decorate basic metadata based on 'per realm' configuration. This method is called for each UserProfileContext in each realm, and metadata are cached then and this method is called again only if configuration changes.

parseConfigOrDefault

protected UPConfig parseConfigOrDefault(ComponentModel component)

Get parsed config file configured in model. Default one used if not configured.

createComponentModel

protected ComponentModel createComponentModel()

Create the component model to store configuration

Returns:

component model

createConfiguredValidator

protected AttributeValidatorMetadata createConfiguredValidator(String validator,
 Map<String,Object> validatorConfig)

Create validator for validation configured in the user profile config.

Parameters:

validator - id to create validator for

validatorConfig - of the validator

Returns:

validator metadata to run given validation

close

public void close()

Specified by:

close in interface Provider