Package org.keycloak.broker.provider
Interface IdentityProviderFactory<T extends IdentityProvider>
- All Superinterfaces:
ConfiguredProvider
,ProviderFactory<T>
- All Known Subinterfaces:
SocialIdentityProviderFactory<I>
- All Known Implementing Classes:
AbstractIdentityProviderFactory
,BitbucketIdentityProviderFactory
,FacebookIdentityProviderFactory
,GitHubIdentityProviderFactory
,GitLabIdentityProviderFactory
,GoogleIdentityProviderFactory
,InstagramIdentityProviderFactory
,KeycloakOIDCIdentityProviderFactory
,LinkedInOIDCIdentityProviderFactory
,MicrosoftIdentityProviderFactory
,OIDCIdentityProviderFactory
,OpenshiftV3IdentityProviderFactory
,OpenshiftV4IdentityProviderFactory
,PayPalIdentityProviderFactory
,SAMLIdentityProviderFactory
,StackoverflowIdentityProviderFactory
,TwitterIdentityProviderFactory
public interface IdentityProviderFactory<T extends IdentityProvider>
extends ProviderFactory<T>, ConfiguredProvider
- Author:
- Pedro Igor
-
Method Summary
Modifier and TypeMethodDescriptioncreate
(KeycloakSession session, IdentityProviderModel model) Creates anIdentityProvider
based on the configuration contained inmodel
.Creates a provider specificIdentityProviderModel
instance.default List<ProviderConfigProperty>
default String
getName()
A friendly name for this factory.parseConfig
(KeycloakSession session, String config) Creates anIdentityProvider
based on the configuration frominputStream
.Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig
Methods inherited from interface org.keycloak.provider.ProviderFactory
close, create, getConfigMetadata, getId, init, order, postInit
-
Method Details
-
getName
String getName()A friendly name for this factory.
- Returns:
-
create
Creates an
IdentityProvider
based on the configuration contained inmodel
.- Parameters:
session
-model
- The configuration to be used to create the identity provider.- Returns:
-
parseConfig
Creates an
IdentityProvider
based on the configuration frominputStream
.- Parameters:
session
-config
- The configuration for the provider- Returns:
-
createConfig
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
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
getHelpText
- Specified by:
getHelpText
in interfaceConfiguredProvider
-