Package org.keycloak.credential
Interface CredentialProviderFactory<T extends CredentialProvider>
- All Superinterfaces:
ProviderFactory<CredentialProvider>
- All Known Implementing Classes:
OTPCredentialProviderFactory
,PasswordCredentialProviderFactory
,RecoveryAuthnCodesCredentialProviderFactory
,WebAuthnCredentialProviderFactory
,WebAuthnPasswordlessCredentialProviderFactory
public interface CredentialProviderFactory<T extends CredentialProvider>
extends ProviderFactory<CredentialProvider>
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
close()
This is called when the server shuts down.getId()
This is the name of the provider and will be showed in the admin console as an option.default void
init
(Config.Scope config) Only called once when the factory is first created.default void
postInit
(KeycloakSessionFactory factory) Called after all provider factories have been initializedMethods inherited from interface org.keycloak.provider.ProviderFactory
create, dependsOn, getConfigMetadata, order
-
Method Details
-
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 interfaceProviderFactory<T extends CredentialProvider>
- Returns:
-
init
Description copied from interface:ProviderFactory
Only called once when the factory is first created. This config is pulled from keycloak_server.json- Specified by:
init
in interfaceProviderFactory<T extends CredentialProvider>
-
postInit
Description copied from interface:ProviderFactory
Called after all provider factories have been initialized- Specified by:
postInit
in interfaceProviderFactory<T extends CredentialProvider>
-
close
default void close()Description copied from interface:ProviderFactory
This is called when the server shuts down.- Specified by:
close
in interfaceProviderFactory<T extends CredentialProvider>
-