Package org.keycloak.userprofile

Class DeclarativeUserProfileProviderFactory

java.lang.Object

org.keycloak.userprofile.DeclarativeUserProfileProviderFactory

All Implemented Interfaces:

AmphibianProviderFactory<UserProfileProvider>, ComponentFactory<UserProfileProvider,UserProfileProvider>, ConfiguredProvider, ProviderFactory<UserProfileProvider>, UserProfileProviderFactory

public class DeclarativeUserProfileProviderFactory
extends Object
implements UserProfileProviderFactory, AmphibianProviderFactory<UserProfileProvider>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_ADMIN_READ_ONLY_ATTRIBUTES
static final String	CONFIG_READ_ONLY_ATTRIBUTES
static final String	ID
static final String	MAX_EMAIL_LOCAL_PART_LENGTH
static final int	PROVIDER_PRIORITY

Constructor Summary

Constructors

Constructor	Description
DeclarativeUserProfileProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
protected UserProfileMetadata	configureUserProfile(UserProfileMetadata metadata)	Specifies how contextual profile metadata is configured at init time.
DeclarativeUserProfileProvider	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
List<ProviderConfigProperty>	getConfigProperties()
protected Map<UserProfileContext,UserProfileMetadata>	getContextualMetadataRegistry()
String	getHelpText()
String	getId()
protected UPConfig	getParsedDefaultRawConfig()
static Pattern	getRegexPatternString(String[] builtinReadOnlyAttributes)
void	init(Config.Scope config)	Only called once when the factory is first created.
int	order()
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
static void	setDefaultConfig(UPConfig defaultConfig)
void	validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model)	Called before a component is created or updated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.component.AmphibianProviderFactory

create, onUpdate, preRemove

Methods inherited from interface org.keycloak.component.ComponentFactory

getCommonProviderConfigProperties, getTypeMetadata, onCreate

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

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

MAX_EMAIL_LOCAL_PART_LENGTH

public static final String MAX_EMAIL_LOCAL_PART_LENGTH

See Also:

• Constant Field Values

ID

public static final String ID

See Also:

• Constant Field Values

PROVIDER_PRIORITY

public static final int PROVIDER_PRIORITY

See Also:

• Constant Field Values

Constructor Details

DeclarativeUserProfileProviderFactory

public DeclarativeUserProfileProviderFactory()

Method Details

setDefaultConfig

public static void setDefaultConfig(UPConfig defaultConfig)

getRegexPatternString

public static Pattern getRegexPatternString(String[] builtinReadOnlyAttributes)

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created. This config is pulled from keycloak_server.json

Specified by:

init in interface ProviderFactory<UserProfileProvider>

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Description copied from interface: ProviderFactory

Returns the metadata for each configuration property supported by this factory.

Specified by:

getConfigMetadata in interface ProviderFactory<UserProfileProvider>

Returns:

a list with the metadata for each configuration property supported by this factory

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface AmphibianProviderFactory<UserProfileProvider>

Specified by:

getConfigProperties in interface ConfiguredProvider

validateConfiguration

public void validateConfiguration(KeycloakSession session,
 RealmModel realm,
 ComponentModel model)
                           throws ComponentValidationException

Description copied from interface: ComponentFactory

Called before a component is created or updated. Allows you to validate the configuration

Specified by:

validateConfiguration in interface ComponentFactory<UserProfileProvider,UserProfileProvider>

Throws:

ComponentValidationException

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<UserProfileProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<UserProfileProvider>

order

public int order()

Specified by:

order in interface ProviderFactory<UserProfileProvider>

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface AmphibianProviderFactory<UserProfileProvider>

Specified by:

close in interface ProviderFactory<UserProfileProvider>

create

public DeclarativeUserProfileProvider create(KeycloakSession session)

Specified by:

create in interface AmphibianProviderFactory<UserProfileProvider>

Specified by:

create in interface ComponentFactory<UserProfileProvider,UserProfileProvider>

Specified by:

create in interface ProviderFactory<UserProfileProvider>

configureUserProfile

protected UserProfileMetadata configureUserProfile(UserProfileMetadata metadata)

Specifies how contextual profile metadata is configured at init time.

Parameters:

metadata - the profile metadata

Returns:

the metadata

getParsedDefaultRawConfig

protected UPConfig getParsedDefaultRawConfig()

getContextualMetadataRegistry

protected Map<UserProfileContext,UserProfileMetadata> getContextualMetadataRegistry()