Package org.keycloak.storage.client
Interface ClientStorageProviderFactory<T extends ClientStorageProvider>
-
- All Superinterfaces:
ComponentFactory<T,ClientStorageProvider>
,ConfiguredProvider
,ProviderFactory<ClientStorageProvider>
- All Known Implementing Classes:
OpenshiftClientStorageProviderFactory
public interface ClientStorageProviderFactory<T extends ClientStorageProvider> extends ComponentFactory<T,ClientStorageProvider>
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
close()
This is called when the server shuts down.T
create(KeycloakSession session, ComponentModel model)
called per Keycloak transaction.default List<ProviderConfigProperty>
getCommonProviderConfigProperties()
configuration properties that are common across all UserStorageProvider implementationsdefault List<ProviderConfigProperty>
getConfigProperties()
default String
getHelpText()
String
getId()
This is the name of the provider and will be showed in the admin console as an option.default Map<String,Object>
getTypeMetadata()
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 ClientStorageProviderModel 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 Detail
-
create
T create(KeycloakSession session, ComponentModel model)
called per Keycloak transaction.- Specified by:
create
in interfaceComponentFactory<T extends ClientStorageProvider,ClientStorageProvider>
- Parameters:
session
-model
-- Returns:
-
getId
String getId()
This is the name of the provider and will be showed in the admin console as an option.- Specified by:
getId
in interfaceProviderFactory<T extends ClientStorageProvider>
- Returns:
-
init
default 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 interfaceProviderFactory<T extends ClientStorageProvider>
-
postInit
default void postInit(KeycloakSessionFactory factory)
Description copied from interface:ProviderFactory
Called after all provider factories have been initialized- Specified by:
postInit
in interfaceProviderFactory<T extends ClientStorageProvider>
-
close
default void close()
Description copied from interface:ProviderFactory
This is called when the server shuts down.- Specified by:
close
in interfaceProviderFactory<T extends ClientStorageProvider>
-
getHelpText
default String getHelpText()
- Specified by:
getHelpText
in interfaceConfiguredProvider
-
getConfigProperties
default List<ProviderConfigProperty> 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 ClientStorageProvider,ClientStorageProvider>
- Throws:
ComponentValidationException
-
onCreate
default void onCreate(KeycloakSession session, RealmModel realm, ComponentModel model)
Called when ClientStorageProviderModel is created. This allows you to do initialization of any additional configuration you need to add.- Specified by:
onCreate
in interfaceComponentFactory<T extends ClientStorageProvider,ClientStorageProvider>
- Parameters:
session
-realm
-model
-
-
getCommonProviderConfigProperties
default List<ProviderConfigProperty> getCommonProviderConfigProperties()
configuration properties that are common across all UserStorageProvider implementations- Specified by:
getCommonProviderConfigProperties
in interfaceComponentFactory<T extends ClientStorageProvider,ClientStorageProvider>
- Returns:
-
getTypeMetadata
default Map<String,Object> 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 ClientStorageProvider,ClientStorageProvider>
- Returns:
-
-