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 Type	Method and Description
default void	close()
T	create(KeycloakSession session, ComponentModel model) called per Keycloak transaction.
default List<ProviderConfigProperty>	getCommonProviderConfigProperties() configuration properties that are common across all GroupStorageProvider implementations
default List<ProviderConfigProperty>	getConfigProperties()
default String	getHelpText()
String	getId() This is the name of the provider.
default Map<String,Object>	getTypeMetadata()
default void	init(Config.Scope config)
default void	onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) Called when GroupStorageProviderModel 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.ProviderFactory

order

Method Detail

create

T create(KeycloakSession session,
         ComponentModel model)

called per Keycloak transaction.

Specified by:

create in interface ComponentFactory<T extends GroupStorageProvider,GroupStorageProvider>

Parameters:

session -

model -

Returns:

getId

String getId()

This is the name of the provider.

Specified by:

getId in interface ProviderFactory<GroupStorageProvider>

Returns:

init

default void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<GroupStorageProvider>

postInit

default void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<GroupStorageProvider>

close

default void close()

Specified by:

close in interface ProviderFactory<GroupStorageProvider>

getHelpText

default String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

getConfigProperties

default List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

validateConfiguration

default void validateConfiguration(KeycloakSession session,
                                   RealmModel realm,
                                   ComponentModel config)
                            throws ComponentValidationException

Specified by:

validateConfiguration in interface ComponentFactory<T extends GroupStorageProvider,GroupStorageProvider>

Throws:

ComponentValidationException

onCreate

default void onCreate(KeycloakSession session,
                      RealmModel realm,
                      ComponentModel model)

Called when GroupStorageProviderModel is created. This allows you to do initialization of any additional configuration you need to add.

Specified by:

onCreate in interface ComponentFactory<T extends GroupStorageProvider,GroupStorageProvider>

Parameters:

session -

realm -

model -

getCommonProviderConfigProperties

default List<ProviderConfigProperty> getCommonProviderConfigProperties()

configuration properties that are common across all GroupStorageProvider implementations

Specified by:

getCommonProviderConfigProperties in interface ComponentFactory<T extends GroupStorageProvider,GroupStorageProvider>

Returns:

getTypeMetadata

default Map<String,Object> getTypeMetadata()

Specified by:

getTypeMetadata in interface ComponentFactory<T extends GroupStorageProvider,GroupStorageProvider>