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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
This is called when the server shuts down.protected UserProfileMetadata
configureUserProfile
(UserProfileMetadata metadata) Specifies how contextual profile metadata is configured at init time.create
(KeycloakSession session) Returns the metadata for each configuration property supported by this factory.protected Map<UserProfileContext,
UserProfileMetadata> getId()
protected UPConfig
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 initializedstatic 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
- See Also:
-
CONFIG_READ_ONLY_ATTRIBUTES
- See Also:
-
MAX_EMAIL_LOCAL_PART_LENGTH
- See Also:
-
ID
- See Also:
-
PROVIDER_PRIORITY
public static final int PROVIDER_PRIORITY- See Also:
-
-
Constructor Details
-
DeclarativeUserProfileProviderFactory
public DeclarativeUserProfileProviderFactory()
-
-
Method Details
-
setDefaultConfig
-
getRegexPatternString
-
init
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 interfaceProviderFactory<UserProfileProvider>
-
getConfigMetadata
Description copied from interface:ProviderFactory
Returns the metadata for each configuration property supported by this factory.- Specified by:
getConfigMetadata
in interfaceProviderFactory<UserProfileProvider>
- Returns:
- a list with the metadata for each configuration property supported by this factory
-
getConfigProperties
- Specified by:
getConfigProperties
in interfaceAmphibianProviderFactory<UserProfileProvider>
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
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 interfaceComponentFactory<UserProfileProvider,
UserProfileProvider> - Throws:
ComponentValidationException
-
postInit
Description copied from interface:ProviderFactory
Called after all provider factories have been initialized- Specified by:
postInit
in interfaceProviderFactory<UserProfileProvider>
-
getId
- Specified by:
getId
in interfaceProviderFactory<UserProfileProvider>
-
order
public int order()- Specified by:
order
in interfaceProviderFactory<UserProfileProvider>
-
getHelpText
- Specified by:
getHelpText
in interfaceConfiguredProvider
-
close
public void close()Description copied from interface:ProviderFactory
This is called when the server shuts down.- Specified by:
close
in interfaceAmphibianProviderFactory<UserProfileProvider>
- Specified by:
close
in interfaceProviderFactory<UserProfileProvider>
-
create
- Specified by:
create
in interfaceAmphibianProviderFactory<UserProfileProvider>
- Specified by:
create
in interfaceComponentFactory<UserProfileProvider,
UserProfileProvider> - Specified by:
create
in interfaceProviderFactory<UserProfileProvider>
-
configureUserProfile
Specifies how contextual profile metadata is configured at init time.- Parameters:
metadata
- the profile metadata- Returns:
- the metadata
-
getParsedDefaultRawConfig
-
getContextualMetadataRegistry
-