Package org.keycloak.storage.client

Interface ClientStorageProviderFactory<T extends ClientStorageProvider>

All Superinterfaces:

ComponentFactory<T,ClientStorageProvider>, ConfiguredProvider, ProviderFactory<ClientStorageProvider>

public interface ClientStorageProviderFactory<T extends ClientStorageProvider>
extends ComponentFactory<T,ClientStorageProvider>

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method	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 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()
default void	init(Config.Scope config)
default void	onCreate(KeycloakSession session, RealmModel realm, ComponentModel model)	Called when ClientStorageProviderModel 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 Detail

create

T create(KeycloakSession session,
         ComponentModel model)

called per Keycloak transaction.

Specified by:

create in interface ComponentFactory<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 interface ProviderFactory<T extends ClientStorageProvider>

Returns:

init

default void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<T extends ClientStorageProvider>

postInit

default void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<T extends ClientStorageProvider>

close

default void close()

Specified by:

close in interface ProviderFactory<T extends ClientStorageProvider>

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 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 interface ComponentFactory<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 interface ComponentFactory<T extends ClientStorageProvider,ClientStorageProvider>

Returns:

getTypeMetadata

default Map<String,Object> getTypeMetadata()

Specified by:

getTypeMetadata in interface ComponentFactory<T extends ClientStorageProvider,ClientStorageProvider>