Package org.keycloak.storage.group
Interface GroupStorageProviderFactory<T extends GroupStorageProvider>
- All Superinterfaces:
ComponentFactory<T,
,GroupStorageProvider> ConfiguredProvider
,ProviderFactory<GroupStorageProvider>
public interface GroupStorageProviderFactory<T extends GroupStorageProvider>
extends ComponentFactory<T,GroupStorageProvider>
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
close()
This is called when the server shuts down.create
(KeycloakSession session, ComponentModel model) called per Keycloak transaction.default List<ProviderConfigProperty>
configuration properties that are common across all GroupStorageProvider implementationsdefault List<ProviderConfigProperty>
default String
getId()
This is the name of the provider.This is metadata about this component type.default void
init
(Config.Scope config) Only called once when the factory is first created.default void
onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) Called when GroupStorageProviderModel is created.default void
postInit
(KeycloakSessionFactory factory) Called after all provider factories have been initializeddefault void
validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) Called before a component is created or updated.Methods inherited from interface org.keycloak.component.ComponentFactory
create, onUpdate, preRemove
Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig
Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, order
-
Method Details
-
create
called per Keycloak transaction.- Specified by:
create
in interfaceComponentFactory<T extends GroupStorageProvider,
GroupStorageProvider> - Parameters:
session
-model
-- Returns:
-
getId
String getId()This is the name of the provider.- Specified by:
getId
in interfaceProviderFactory<T extends GroupStorageProvider>
- Returns:
-
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<T extends GroupStorageProvider>
-
postInit
Description copied from interface:ProviderFactory
Called after all provider factories have been initialized- Specified by:
postInit
in interfaceProviderFactory<T extends GroupStorageProvider>
-
close
default void close()Description copied from interface:ProviderFactory
This is called when the server shuts down.- Specified by:
close
in interfaceProviderFactory<T extends GroupStorageProvider>
-
getHelpText
- Specified by:
getHelpText
in interfaceConfiguredProvider
-
getConfigProperties
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
validateConfiguration
default void validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) 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<T extends GroupStorageProvider,
GroupStorageProvider> - Throws:
ComponentValidationException
-
onCreate
Called when GroupStorageProviderModel is created. This allows you to do initialization of any additional configuration you need to add.- Specified by:
onCreate
in interfaceComponentFactory<T extends GroupStorageProvider,
GroupStorageProvider> - Parameters:
session
-realm
-model
-
-
getCommonProviderConfigProperties
configuration properties that are common across all GroupStorageProvider implementations- Specified by:
getCommonProviderConfigProperties
in interfaceComponentFactory<T extends GroupStorageProvider,
GroupStorageProvider> - Returns:
-
getTypeMetadata
Description copied from interface:ComponentFactory
This is metadata about this component type. Its really configuration information about the component type and not an individual instance- Specified by:
getTypeMetadata
in interfaceComponentFactory<T extends GroupStorageProvider,
GroupStorageProvider> - Returns:
-