Package org.keycloak.broker.provider

Interface IdentityProviderFactory<T extends IdentityProvider>

All Superinterfaces:
org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.ProviderFactory<T>
All Known Subinterfaces:
SocialIdentityProviderFactory<I>
All Known Implementing Classes:
AbstractIdentityProviderFactory
public interface IdentityProviderFactory<T extends IdentityProvider> extends org.keycloak.provider.ProviderFactory<T>, org.keycloak.provider.ConfiguredProvider
Author:
Pedro Igor

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    create(org.keycloak.models.KeycloakSession session, org.keycloak.models.IdentityProviderModel model)
    Creates an IdentityProvider based on the configuration contained in model.
    org.keycloak.models.IdentityProviderModel
    createConfig()
    Creates a provider specific IdentityProviderModel instance.
    default List<org.keycloak.provider.ProviderConfigProperty>
    getConfigProperties()
     
    default String
    getHelpText()
     
    String
    getName()
    A friendly name for this factory.
    Map<String,String>
    parseConfig(org.keycloak.models.KeycloakSession session, String config)
    Creates an IdentityProvider based on the configuration from inputStream.

    Methods inherited from interface org.keycloak.provider.ConfiguredProvider

    getConfig

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    close, create, dependsOn, getConfigMetadata, getId, init, order, postInit

  • Method Details

    • getName

      String getName()

      A friendly name for this factory.

      Returns:

    • create

      T create(org.keycloak.models.KeycloakSession session, org.keycloak.models.IdentityProviderModel model)

      Creates an IdentityProvider based on the configuration contained in model.

      Parameters:
      session -
      model - The configuration to be used to create the identity provider.
      Returns:

    • parseConfig

      Map<String,String> parseConfig(org.keycloak.models.KeycloakSession session, String config)

      Creates an IdentityProvider based on the configuration from inputStream.

      Parameters:
      session -
      config - The configuration for the provider
      Returns:

    • createConfig

      org.keycloak.models.IdentityProviderModel createConfig()

      Creates a provider specific IdentityProviderModel instance.

      Providers may want to implement their own IdentityProviderModel type so that validations can be performed when managing the provider configuration

      Returns:
      the provider specific instance

    • getConfigProperties

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

    • getHelpText

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