Package org.keycloak.storage.role
Interface RoleStorageProviderFactory<T extends RoleStorageProvider>
- All Superinterfaces:
ComponentFactory<T,
,RoleStorageProvider> ConfiguredProvider
,ProviderFactory<RoleStorageProvider>
public interface RoleStorageProviderFactory<T extends RoleStorageProvider>
extends ComponentFactory<T,RoleStorageProvider>
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
close()
create
(KeycloakSession session, ComponentModel model) called per Keycloak transaction.default List<ProviderConfigProperty>
configuration properties that are common across all RoleStorageProvider implementationsdefault List<ProviderConfigProperty>
default String
getId()
This is the name of the provider.default void
init
(Config.Scope config) default void
onCreate
(KeycloakSession session, RealmModel realm, ComponentModel model) Called when RoleStorageProviderModel is created.default void
postInit
(KeycloakSessionFactory factory) default void
validateConfiguration
(KeycloakSession session, RealmModel realm, ComponentModel config) 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 RoleStorageProvider,
RoleStorageProvider> - Parameters:
session
-model
-- Returns:
-
getId
String getId()This is the name of the provider.- Specified by:
getId
in interfaceProviderFactory<T extends RoleStorageProvider>
- Returns:
-
init
- Specified by:
init
in interfaceProviderFactory<T extends RoleStorageProvider>
-
postInit
- Specified by:
postInit
in interfaceProviderFactory<T extends RoleStorageProvider>
-
close
default void close()- Specified by:
close
in interfaceProviderFactory<T extends RoleStorageProvider>
-
getHelpText
- Specified by:
getHelpText
in interfaceConfiguredProvider
-
getConfigProperties
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
validateConfiguration
default void validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) throws ComponentValidationException - Specified by:
validateConfiguration
in interfaceComponentFactory<T extends RoleStorageProvider,
RoleStorageProvider> - Throws:
ComponentValidationException
-
onCreate
Called when RoleStorageProviderModel is created. This allows you to do initialization of any additional configuration you need to add.- Specified by:
onCreate
in interfaceComponentFactory<T extends RoleStorageProvider,
RoleStorageProvider> - Parameters:
session
-realm
-model
-
-
getCommonProviderConfigProperties
configuration properties that are common across all RoleStorageProvider implementations- Specified by:
getCommonProviderConfigProperties
in interfaceComponentFactory<T extends RoleStorageProvider,
RoleStorageProvider> - Returns:
-
getTypeMetadata
- Specified by:
getTypeMetadata
in interfaceComponentFactory<T extends RoleStorageProvider,
RoleStorageProvider>
-