Package org.keycloak.storage

Interface UserStorageProviderFactory<T extends UserStorageProvider>

All Superinterfaces:
org.keycloak.component.ComponentFactory<T,UserStorageProvider>, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.ProviderFactory<UserStorageProvider>
public interface UserStorageProviderFactory<T extends UserStorageProvider> extends org.keycloak.component.ComponentFactory<T,UserStorageProvider>
Version:
$Revision: 1 $
Author:
Bill Burke

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    close()
     
    T
    create(org.keycloak.models.KeycloakSession session, org.keycloak.component.ComponentModel model)
    called per Keycloak transaction.
    default List<org.keycloak.provider.ProviderConfigProperty>
    getCommonProviderConfigProperties()
    configuration properties that are common across all UserStorageProvider implementations
    default List<org.keycloak.provider.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(org.keycloak.Config.Scope config)
     
    default void
    onCreate(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.component.ComponentModel model)
    Called when UserStorageProviderModel is created.
    default void
    postInit(org.keycloak.models.KeycloakSessionFactory factory)
     
    default void
    validateConfiguration(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.component.ComponentModel config)
     

    Methods inherited from interface org.keycloak.component.ComponentFactory

    create, isInternal, onUpdate, preRemove

    Methods inherited from interface org.keycloak.provider.ConfiguredProvider

    getConfig

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    dependsOn, getConfigMetadata, order

  • Method Details

    • create

      T create(org.keycloak.models.KeycloakSession session, org.keycloak.component.ComponentModel model)
      called per Keycloak transaction.
      Specified by:
      create in interface org.keycloak.component.ComponentFactory<T extends UserStorageProvider,UserStorageProvider>
      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 org.keycloak.provider.ProviderFactory<T extends UserStorageProvider>
      Returns:

    • init

      default void init(org.keycloak.Config.Scope config)
      Specified by:
      init in interface org.keycloak.provider.ProviderFactory<T extends UserStorageProvider>

    • postInit

      default void postInit(org.keycloak.models.KeycloakSessionFactory factory)
      Specified by:
      postInit in interface org.keycloak.provider.ProviderFactory<T extends UserStorageProvider>

    • close

      default void close()
      Specified by:
      close in interface org.keycloak.provider.ProviderFactory<T extends UserStorageProvider>

    • getHelpText

      default String getHelpText()
      Specified by:
      getHelpText in interface org.keycloak.provider.ConfiguredProvider

    • getConfigProperties

      default List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()
      Specified by:
      getConfigProperties in interface org.keycloak.provider.ConfiguredProvider

    • validateConfiguration

      default void validateConfiguration(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.component.ComponentModel config) throws org.keycloak.component.ComponentValidationException
      Specified by:
      validateConfiguration in interface org.keycloak.component.ComponentFactory<T extends UserStorageProvider,UserStorageProvider>
      Throws:
      org.keycloak.component.ComponentValidationException

    • onCreate

      default void onCreate(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.component.ComponentModel model)
      Called when UserStorageProviderModel is created. This allows you to do initialization of any additional configuration you need to add. For example, you may be introspecting a database or ldap schema to automatically create mappings.
      Specified by:
      onCreate in interface org.keycloak.component.ComponentFactory<T extends UserStorageProvider,UserStorageProvider>
      Parameters:
      session -
      realm -
      model -

    • getCommonProviderConfigProperties

      default List<org.keycloak.provider.ProviderConfigProperty> getCommonProviderConfigProperties()
      configuration properties that are common across all UserStorageProvider implementations
      Specified by:
      getCommonProviderConfigProperties in interface org.keycloak.component.ComponentFactory<T extends UserStorageProvider,UserStorageProvider>
      Returns:

    • getTypeMetadata

      default Map<String,Object> getTypeMetadata()
      Specified by:
      getTypeMetadata in interface org.keycloak.component.ComponentFactory<T extends UserStorageProvider,UserStorageProvider>