Package org.keycloak.provider

Interface ProviderFactory<T extends Provider>

All Known Subinterfaces:
AccountResourceProviderFactory, ActionTokenHandlerFactory<T>, AdminRealmResourceProviderFactory, AmphibianProviderFactory<ProviderType>, ArtifactResolverFactory, AuthenticationChannelProviderFactory, AuthenticationFlowCallbackFactory, AuthenticationSessionProviderFactory<T>, AuthenticatorFactory, AuthorizationProviderFactory, AuthorizationRequestParserProviderFactory, AuthorizationStoreFactory, BruteForceProtectorFactory, CachedStoreProviderFactory, CachePublicKeyProviderFactory, CacheRealmProviderFactory, CekManagementProviderFactory, CIBALoginUserResolverFactory, ClientAuthenticatorFactory, ClientDescriptionConverterFactory, ClientInstallationProvider, ClientPolicyConditionProviderFactory, ClientPolicyExecutorProviderFactory, ClientPolicyManagerFactory, ClientProviderFactory<T>, ClientRegistrationPolicyFactory, ClientRegistrationProviderFactory, ClientScopeProviderFactory<T>, ClientScopeStorageProviderFactory<T>, ClientSignatureVerifierProviderFactory, ClientStorageProviderFactory<T>, ClientValidationProviderFactory, ClusterProviderFactory, ComponentFactory<CreatedType,ProviderType>, ComponentFactoryProviderFactory, ConditionalAuthenticatorFactory, ContentEncryptionProviderFactory, CredentialProviderFactory<T>, DatastoreProviderFactory, DBLockProviderFactory, DeployedConfigurationsProviderFactory, DeploymentStateProviderFactory, DeviceRepresentationProviderFactory, EmailSenderProviderFactory, EmailTemplateProviderFactory, EventListenerProviderFactory, EventStoreProviderFactory, ExceptionConverter, ExecutorsProviderFactory, ExportProviderFactory, FormActionFactory, FormAuthenticatorFactory, FreeMarkerProviderFactory, GlobalLockProviderFactory, GroupProviderFactory<T>, GroupStorageProviderFactory<T>, HashProviderFactory, HostnameProviderFactory, HttpClientFactory, IdentityProviderFactory<T>, IdentityProviderMapper, ImportProviderFactory, InfinispanConnectionProviderFactory, JpaConnectionProviderFactory, JpaEntityProviderFactory, JpaUpdaterProviderFactory, JtaTransactionManagerLookup, KeyProviderFactory<T>, LDAPStorageMapperFactory<T>, LiquibaseConnectionProviderFactory, LoadBalancerCheckProviderFactory, LocaleSelectorProviderFactory, LocaleUpdaterProviderFactory, LoginFormsProviderFactory, LoginProtocolFactory, MigrationProviderFactory, OAuth2DeviceUserCodeProviderFactory, OIDCExtProviderFactory, OTPApplicationProviderFactory, PasswordHashProviderFactory, PasswordPolicyManagerProviderFactory, PasswordPolicyProviderFactory, PolicyProviderFactory<R>, ProtocolMapper, PublicKeyStorageProviderFactory<T>, RealmProviderFactory<T>, RealmResourceProviderFactory, RequiredActionFactory, ResourceEncodingProviderFactory, RoleProviderFactory<T>, RoleStorageProviderFactory<T>, SamlAuthenticationPreprocessor, ScriptingProviderFactory, SecurityHeadersProviderFactory, SignatureProviderFactory, SimpleValidator, SingleUseObjectProviderFactory<T>, SocialIdentityProviderFactory<I>, StickySessionEncoderProviderFactory, SubComponentFactory<CreatedType,ProviderType>, ThemeProviderFactory, ThemeResourceProviderFactory, ThemeSelectorProviderFactory, TimerProviderFactory, TokenExchangeProviderFactory, TokenIntrospectionProviderFactory, TruststoreProviderFactory, UserCacheProviderFactory, UserFederatedStorageProviderFactory, UserLoginFailureProviderFactory<T>, UserProfileProviderFactory<U>, UserProviderFactory<T>, UserSessionPersisterProviderFactory, UserSessionProviderFactory<T>, UserStorageProviderFactory<T>, ValidatorFactory, VaultProviderFactory, WellKnownProviderFactory, X509ClientCertificateLookupFactory
All Known Implementing Classes:
AbstractActionTokenHandler, AbstractAttributeToGroupMapper, AbstractAttributeToRoleMapper, AbstractClaimMapper, AbstractClaimToGroupMapper, AbstractClaimToRoleMapper, AbstractClientAuthenticator, AbstractClientCertificateFromHttpHeadersLookupFactory, AbstractClientPolicyConditionProviderFactory, AbstractClientRegistrationPolicyFactory, AbstractDirectGrantAuthenticator, AbstractEcdsaKeyProviderFactory, AbstractGeneratedRsaKeyProviderFactory, AbstractGeneratedSecretKeyProviderFactory, AbstractIdentityProviderFactory, AbstractIdentityProviderMapper, AbstractImportedRsaKeyProviderFactory, AbstractJsonUserAttributeMapper, AbstractLDAPStorageMapperFactory, AbstractLoginProtocolFactory, AbstractNumberValidator, AbstractOIDCProtocolMapper, AbstractPairwiseSubMapper, AbstractPbkdf2PasswordHashProviderFactory, AbstractRsaKeyProviderFactory, AbstractSAMLProtocolMapper, AbstractSetRequiredActionAuthenticator, AbstractSimpleValidator, AbstractStringValidator, AbstractUserProfileProvider, AbstractVaultProviderFactory, AbstractX509ClientCertificateAuthenticatorFactory, AccessTokenIntrospectionProviderFactory, AccountConsoleFactory, AcrProtocolMapper, AdapterInstallationClientRegistrationProviderFactory, AddressMapper, AdvancedAttributeToGroupMapper, AdvancedAttributeToRoleMapper, AdvancedClaimToGroupMapper, AdvancedClaimToRoleMapper, Aes128CbcHmacSha256ContentEncryptionProviderFactory, Aes128GcmContentEncryptionProviderFactory, Aes192CbcHmacSha384ContentEncryptionProviderFactory, Aes192GcmContentEncryptionProviderFactory, Aes256CbcHmacSha512ContentEncryptionProviderFactory, Aes256GcmContentEncryptionProviderFactory, AggregatePolicyProviderFactory, AllowAccessAuthenticatorFactory, AllowAllDockerProtocolMapper, AllowedWebOriginsProtocolMapper, AnyClientConditionFactory, ApacheProxySslClientCertificateLookupFactory, AttributeRequiredByMetadataValidator, AttributeToRoleMapper, AudienceProtocolMapper, AudienceResolveProtocolMapper, BasicTimerProviderFactory, BitbucketIdentityProviderFactory, BlacklistPasswordPolicyProviderFactory, BlankAttributeValidator, BrokeringFederatedUsernameHasValueValidator, CertificateLDAPStorageMapperFactory, CibaRootEndpoint, ClaimsParameterTokenMapper, ClaimsParameterWithValueIdTokenMapper, ClaimToRoleMapper, ClaimToUserSessionNoteMapper, ClasspathThemeProviderFactory, ClasspathThemeResourceProviderFactory, ClearKeysCacheRealmAdminProvider, ClearRealmCacheRealmAdminProvider, ClearUserCacheRealmAdminProvider, ClientAccessTypeConditionFactory, ClientDisabledClientRegistrationPolicyFactory, ClientIdAndSecretAuthenticator, ClientPolicyProviderFactory, ClientRolesConditionFactory, ClientScopeAuthorizationRequestParserProviderFactory, ClientScopePolicyProviderFactory, ClientScopesClientRegistrationPolicyFactory, ClientScopesConditionFactory, ClientSecretRotationExecutorFactory, ClientUpdaterContextConditionFactory, ClientUpdaterSourceGroupsConditionFactory, ClientUpdaterSourceHostsConditionFactory, ClientUpdaterSourceRolesConditionFactory, ConditionalLoaAuthenticatorFactory, ConditionalOtpFormAuthenticatorFactory, ConditionalRoleAuthenticatorFactory, ConditionalUserAttributeValueFactory, ConditionalUserConfiguredAuthenticatorFactory, ConfidentialClientAcceptExecutorFactory, ConsentRequiredClientRegistrationPolicyFactory, ConsentRequiredExecutorFactory, CookieAuthenticatorFactory, DBLockGlobalLockProviderFactory, DeclarativeUserProfileProvider, DefaultAuthorizationProviderFactory, DefaultBruteForceProtectorFactory, DefaultCIBALoginUserResolverFactory, DefaultClientCertificateLookupFactory, DefaultClientPolicyManagerFactory, DefaultClientRegistrationProviderFactory, DefaultClientValidationProviderFactory, DefaultComponentFactoryProviderFactory, DefaultDeployedConfigurationsProviderFactory, DefaultEmailSenderProviderFactory, DefaultExecutorsProviderFactory, DefaultFreeMarkerProviderFactory, DefaultHostnameProviderFactory, DefaultHttpClientFactory, DefaultInfinispanConnectionProviderFactory, DefaultJpaConnectionProviderFactory, DefaultLiquibaseConnectionProvider, DefaultLocaleSelectorProviderFactory, DefaultLocaleUpdaterProviderFactory, DefaultMigrationProviderFactory, DefaultOAuth2DeviceUserCodeProviderFactory, DefaultPasswordPolicyManagerProviderFactory, DefaultSamlArtifactResolverFactory, DefaultScriptingProviderFactory, DefaultSecurityHeadersProviderFactory, DefaultThemeSelectorProviderFactory, DefaultTokenExchangeProviderFactory, DeleteAccount, DenyAccessAuthenticatorFactory, DeployedScriptAuthenticatorFactory, DeployedScriptOIDCProtocolMapper, DeployedScriptPolicyFactory, DeployedScriptSAMLProtocolMapper, DeviceEndpointFactory, DeviceRepresentationProviderFactoryImpl, DigitsPasswordPolicyProviderFactory, DirExportProviderFactory, DirImportProviderFactory, DisabledStickySessionEncoderProvider, DisabledUserSessionPersisterProvider, DockerAuthenticatorFactory, DockerAuthV2ProtocolFactory, DockerAuthV2ProtocolMapper, DockerComposeYamlInstallationProvider, DockerRegistryConfigFileInstallationProvider, DockerVariableOverrideInstallationProvider, DoubleValidator, DuplicateEmailValidator, DuplicateUsernameValidator, EmailEventListenerProviderFactory, EmailExistsAsUsernameValidator, EmailValidator, EntityDescriptorClientRegistrationProviderFactory, EntityDescriptorDescriptionConverter, ES256ClientSignatureVerifierProviderFactory, ES256SignatureProviderFactory, ES384ClientSignatureVerifierProviderFactory, ES384SignatureProviderFactory, ES512ClientSignatureVerifierProviderFactory, ES512SignatureProviderFactory, ExecuteActionsActionTokenHandler, ExternalKeycloakRoleToRoleMapper, FacebookIdentityProviderFactory, FacebookUserAttributeMapper, FilesKeystoreVaultProviderFactory, FilesPlainTextVaultProviderFactory, FileTruststoreProviderFactory, FixedHostnameProviderFactory, FolderThemeProviderFactory, ForceExpiredPasswordPolicyProviderFactory, FreeMarkerEmailTemplateProviderFactory, FreeMarkerLoginFormsProviderFactory, FreeOTPProvider, FullNameLDAPStorageMapperFactory, FullNameMapper, FullScopeDisabledExecutorFactory, GeneratedAesKeyProviderFactory, GeneratedEcdsaKeyProviderFactory, GeneratedHmacKeyProviderFactory, GeneratedRsaEncKeyProviderFactory, GeneratedRsaKeyProviderFactory, GitHubIdentityProviderFactory, GitHubUserAttributeMapper, GitLabIdentityProviderFactory, GoogleAuthenticatorProvider, GoogleIdentityProviderFactory, GoogleUserAttributeMapper, GroupLDAPStorageMapperFactory, GroupMembershipMapper, GroupMembershipMapper, GroupPolicyProviderFactory, GzipResourceEncodingProviderFactory, HaProxySslClientCertificateLookupFactory, HardcodedAttributeMapper, HardcodedAttributeMapper, HardcodedAttributeMapperFactory, HardcodedClaim, HardcodedGroupMapper, HardcodedLDAPAttributeMapperFactory, HardcodedLDAPGroupStorageMapperFactory, HardcodedLDAPRoleStorageMapperFactory, HardcodedRole, HardcodedRole, HardcodedRoleMapper, HardcodedUserSessionAttributeMapper, HashAlgorithmPasswordPolicyProviderFactory, HashIterationsPasswordPolicyProviderFactory, HistoryPasswordPolicyProviderFactory, HolderOfKeyEnforcerExecutorFactory, HS256ClientSignatureVerifierProviderFactory, HS256SignatureProviderFactory, HS384ClientSignatureVerifierProviderFactory, HS384SignatureProviderFactory, HS512ClientSignatureVerifierProviderFactory, HS512SignatureProviderFactory, HttpAuthenticationChannelProviderFactory, HttpBasicAuthenticatorFactory, IdentityProviderAuthenticatorFactory, IdpAutoLinkAuthenticatorFactory, IdpConfirmLinkAuthenticatorFactory, IdpCreateUserIfUniqueAuthenticatorFactory, IdpDetectExistingBrokerUserAuthenticatorFactory, IdpEmailVerificationAuthenticatorFactory, IdpReviewProfileAuthenticatorFactory, IdpUsernamePasswordFormFactory, IdpVerifyAccountLinkActionTokenHandler, ImmutableAttributeValidator, ImportedRsaEncKeyProviderFactory, ImportedRsaKeyProviderFactory, InfinispanAuthenticationSessionProviderFactory, InfinispanCachePublicKeyProviderFactory, InfinispanCacheRealmProviderFactory, InfinispanCacheStoreFactoryProviderFactory, InfinispanClusterProviderFactory, InfinispanMultiSiteLoadBalancerCheckProviderFactory, InfinispanPublicKeyStorageProviderFactory, InfinispanSingleUseObjectProviderFactory, InfinispanStickySessionEncoderProviderFactory, InfinispanUserCacheProviderFactory, InfinispanUserLoginFailureProviderFactory, InfinispanUserSessionProviderFactory, InstagramIdentityProviderFactory, InstagramUserAttributeMapper, IntegerValidator, IntentClientBindCheckExecutorFactory, JarThemeProviderFactory, JavaKeystoreKeyProviderFactory, JBossJtaTransactionManagerLookup, JBossLoggingEventListenerProviderFactory, JPAAuthorizationStoreFactory, JpaClientProviderFactory, JpaClientScopeProviderFactory, JpaDeploymentStateProviderFactory, JpaEventStoreProviderFactory, JpaExceptionConverter, JpaGroupProviderFactory, JpaRealmProviderFactory, JpaRoleProviderFactory, JpaUserCredentialStoreFactory, JpaUserFederatedStorageProviderFactory, JpaUserProviderFactory, JpaUserSessionPersisterProviderFactory, JSPolicyProviderFactory, JWTClientAuthenticator, JWTClientSecretAuthenticator, KerberosFederationProviderFactory, KeycloakClientDescriptionConverter, KeycloakOIDCClientInstallation, KeycloakOIDCIdentityProviderFactory, KeycloakOIDCJbossSubsystemClientCliInstallation, KeycloakOIDCJbossSubsystemClientInstallation, KeycloakSamlClientInstallation, KeycloakSamlSubsystemCliInstallation, KeycloakSamlSubsystemInstallation, LdapServerCapabilitiesRealmAdminProvider, LDAPStorageProviderFactory, LegacyDatastoreProviderFactory, LengthPasswordPolicyProviderFactory, LengthValidator, LinkedInIdentityProviderFactory, LinkedInOIDCIdentityProviderFactory, LinkedInUserAttributeMapper, LiquibaseDBLockProviderFactory, LiquibaseJpaUpdaterProviderFactory, LocalDateValidator, LowerCasePasswordPolicyProviderFactory, MaxAuthAgePasswordPolicyProviderFactory, MaxClientsClientRegistrationPolicyFactory, MaximumLengthPasswordPolicyProviderFactory, MicrosoftAuthenticatorOTPProvider, MicrosoftIdentityProviderFactory, MicrosoftUserAttributeMapper, ModAuthMellonClientInstallation, MSADLDSUserAccountControlStorageMapperFactory, MSADUserAccountControlStorageMapperFactory, NginxProxySslClientCertificateLookupFactory, NoneGlobalLockProviderFactory, NotBlankValidator, NotEmailPasswordPolicyProviderFactory, NotEmptyValidator, NotUsernamePasswordPolicyProviderFactory, OIDCClientDescriptionConverterFactory, OIDCClientRegistrationProviderFactory, OIDCIdentityProviderFactory, OIDCLoginProtocolFactory, OIDCWellKnownProviderFactory, OpenshiftV3IdentityProviderFactory, OpenshiftV4AttributeMapper, OpenshiftV4IdentityProviderFactory, OptionsValidator, OTPCredentialProviderFactory, OTPFormAuthenticatorFactory, ParRootEndpoint, PasswordCredentialProviderFactory, PasswordFormFactory, PatternValidator, PayPalIdentityProviderFactory, PayPalUserAttributeMapper, Pbkdf2PasswordHashProviderFactory, Pbkdf2Sha256PasswordHashProviderFactory, Pbkdf2Sha512PasswordHashProviderFactory, PersonNameProhibitedCharactersValidator, PKCEEnforcerExecutorFactory, ProtocolMappersClientRegistrationPolicyFactory, PS256ClientSignatureVerifierProviderFactory, PS256SignatureProviderFactory, PS384ClientSignatureVerifierProviderFactory, PS384SignatureProviderFactory, PS512ClientSignatureVerifierProviderFactory, PS512SignatureProviderFactory, ReadOnlyAttributeUnchangedValidator, RealmManagerProviderFactory, RecoveryAuthnCodesAction, RecoveryAuthnCodesCredentialProviderFactory, RecoveryAuthnCodesFormAuthenticatorFactory, RecoveryCodesWarningThresholdPasswordPolicyProviderFactory, RefreshTokenIntrospectionProviderFactory, RegexPatternsPasswordPolicyProviderFactory, RegexPolicyProviderFactory, RegistrationAccessTokenRotationDisabledExecutorFactory, RegistrationEmailAsUsernameEmailValueValidator, RegistrationEmailAsUsernameUsernameValueValidator, RegistrationPage, RegistrationPassword, RegistrationRecaptcha, RegistrationTermsAndConditions, RegistrationUserCreation, RegistrationUsernameExistsValidator, RejectImplicitGrantExecutorFactory, RejectRequestExecutorFactory, RejectResourceOwnerPasswordCredentialsGrantExecutorFactory, RequestHostnameProviderFactory, ResetCredentialChooseUser, ResetCredentialEmail, ResetCredentialsActionTokenHandler, ResetOTP, ResetPassword, ResourcePolicyProviderFactory, RoleLDAPStorageMapperFactory, RoleListMapper, RoleNameMapper, RoleNameMapper, RolePolicyProviderFactory, RPTIntrospectionProviderFactory, RS256ClientSignatureVerifierProviderFactory, RS256SignatureProviderFactory, RS384ClientSignatureVerifierProviderFactory, RS384SignatureProviderFactory, RS512ClientSignatureVerifierProviderFactory, RS512SignatureProviderFactory, RsaesOaep256CekManagementProviderFactory, RsaesOaepCekManagementProviderFactory, RsaesPkcs1CekManagementProviderFactory, SAMLAudienceProtocolMapper, SAMLAudienceResolveProtocolMapper, SAMLIdentityProviderFactory, SamlProtocolFactory, SamlSPDescriptorClientInstallation, ScopeClientRegistrationPolicyFactory, ScopePolicyProviderFactory, ScriptBasedAuthenticatorFactory, ScriptBasedMapper, ScriptBasedOIDCProtocolMapper, SecureCibaAuthenticationRequestSigningAlgorithmExecutorFactory, SecureCibaSessionEnforceExecutorFactory, SecureCibaSignedAuthenticationRequestExecutorFactory, SecureClientAuthenticatorExecutorFactory, SecureClientUrisExecutorFactory, SecureLogoutExecutorFactory, SecureParContentsExecutorFactory, SecureRequestObjectExecutorFactory, SecureResponseTypeExecutorFactory, SecureSessionEnforceExecutorFactory, SecureSigningAlgorithmExecutorFactory, SecureSigningAlgorithmForSignedJwtExecutorFactory, SHA256HashProviderFactory, SHA256PairwiseSubMapper, SHA384HashProviderFactory, SHA512HashProviderFactory, SingleFileExportProviderFactory, SingleFileImportProviderFactory, SpecialCharsPasswordPolicyProviderFactory, SpnegoAuthenticatorFactory, SSSDFederationProviderFactory, StackoverflowIdentityProviderFactory, StackoverflowUserAttributeMapper, SuppressRefreshTokenRotationExecutorFactory, TermsAndConditions, TestLdapConnectionRealmAdminProvider, TimePolicyProviderFactory, TrustedHostClientRegistrationPolicyFactory, TwitterIdentityProviderFactory, UMAPolicyProviderFactory, UmaWellKnownProviderFactory, UpdateEmail, UpdateEmailActionTokenHandler, UpdatePassword, UpdateProfile, UpdateTotp, UpdateUserLocaleAction, UpperCasePasswordPolicyProviderFactory, UriValidator, UserAttributeLDAPStorageMapperFactory, UserAttributeMapper, UserAttributeMapper, UserAttributeMapper, UserAttributeNameIdMapper, UserAttributeStatementMapper, UserClientRoleMappingMapper, UsernameFormFactory, UsernameHasValueValidator, UsernameIDNHomographValidator, UsernameMutationValidator, UsernamePasswordFormFactory, UsernameProhibitedCharactersValidator, UsernameTemplateMapper, UsernameTemplateMapper, UserPolicyProviderFactory, UserPropertyAttributeStatementMapper, UserPropertyMapper, UserRealmRoleMappingMapper, UserSessionLimitsAuthenticatorFactory, UserSessionNoteMapper, UserSessionNoteStatementMapper, UserStorageProviderRealmAdminProvider, ValidateOTP, ValidatePassword, ValidateUsername, ValidateX509CertificateUsernameFactory, ValidatorConfigValidator, VerifyEmail, VerifyEmailActionTokenHandler, VerifyUserProfile, WebAuthnAuthenticatorFactory, WebAuthnCredentialProviderFactory, WebAuthnPasswordlessAuthenticatorFactory, WebAuthnPasswordlessCredentialProviderFactory, WebAuthnPasswordlessRegisterFactory, WebAuthnRegisterFactory, X509ClientAuthenticator, X509ClientCertificateAuthenticatorFactory, XPathAttributeMapper
public interface ProviderFactory<T extends Provider>
At boot time, keycloak discovers all factories. For each discovered factory, the init() method is called. After all factories have been initialized, the postInit() method is called. close() is called when the server shuts down. Only one instance of a factory exists per server.
Author:
Stian Thorgersen

  • Method Details

    • create

      T create(KeycloakSession session)

    • init

      void init(Config.Scope config)
      Only called once when the factory is first created. This config is pulled from keycloak_server.json
      Parameters:
      config -

    • postInit

      void postInit(KeycloakSessionFactory factory)
      Called after all provider factories have been initialized

    • close

      void close()
      This is called when the server shuts down.

    • getId

      String getId()

    • order

      default int order()

    • getConfigMetadata

      default List<ProviderConfigProperty> getConfigMetadata()
      Returns the metadata for each configuration property supported by this factory.
      Returns:
      a list with the metadata for each configuration property supported by this factory