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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
close()
This is called when the server shuts down.String
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 initialized-
Methods inherited from interface org.keycloak.provider.ProviderFactory
create, getConfigMetadata, order
-
-
-
-
Method Detail
-
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
default void init(Config.Scope config)
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
default void postInit(KeycloakSessionFactory factory)
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>
-
-