public interface UserStorageProviderFactory<T extends UserStorageProvider> extends ComponentFactory<T,UserStorageProvider>
Modifier and Type | Method and 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 implementations
|
default 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 UserStorageProviderModel is created.
|
default void |
postInit(KeycloakSessionFactory factory)
Called after all provider factories have been initialized
|
default void |
validateConfiguration(KeycloakSession session,
RealmModel realm,
ComponentModel config)
Called before a component is created or updated.
|
create, onUpdate, preRemove
order
T create(KeycloakSession session, ComponentModel model)
create
in interface ComponentFactory<T extends UserStorageProvider,UserStorageProvider>
session
- model
- String getId()
getId
in interface ProviderFactory<UserStorageProvider>
default void init(Config.Scope config)
ProviderFactory
init
in interface ProviderFactory<UserStorageProvider>
default void postInit(KeycloakSessionFactory factory)
ProviderFactory
postInit
in interface ProviderFactory<UserStorageProvider>
default void close()
ProviderFactory
close
in interface ProviderFactory<UserStorageProvider>
default String getHelpText()
getHelpText
in interface ConfiguredProvider
default List<ProviderConfigProperty> getConfigProperties()
getConfigProperties
in interface ConfiguredProvider
default void validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config) throws ComponentValidationException
ComponentFactory
validateConfiguration
in interface ComponentFactory<T extends UserStorageProvider,UserStorageProvider>
ComponentValidationException
default void onCreate(KeycloakSession session, RealmModel realm, ComponentModel model)
onCreate
in interface ComponentFactory<T extends UserStorageProvider,UserStorageProvider>
session
- realm
- model
- default List<ProviderConfigProperty> getCommonProviderConfigProperties()
getCommonProviderConfigProperties
in interface ComponentFactory<T extends UserStorageProvider,UserStorageProvider>
default Map<String,Object> getTypeMetadata()
ComponentFactory
getTypeMetadata
in interface ComponentFactory<T extends UserStorageProvider,UserStorageProvider>
Copyright © 2018 JBoss by Red Hat. All rights reserved.