Package org.keycloak.provider
Interface ProviderFactory<T extends Provider>
-
- All Known Subinterfaces:
ComponentFactory<CreatedType,ProviderType>
,HostnameProviderFactory
,LocaleSelectorProviderFactory
,LocaleUpdaterProviderFactory
,SubComponentFactory<CreatedType,ProviderType>
,ThemeResourceProviderFactory
,ThemeSelectorProviderFactory
,UserFederatedStorageProviderFactory
,VaultProviderFactory
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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
close()
This is called when the server shuts down.T
create(KeycloakSession session)
default List<ProviderConfigProperty>
getConfigMetadata()
Returns the metadata for each configuration property supported by this factory.String
getId()
void
init(Config.Scope config)
Only called once when the factory is first created.default int
order()
void
postInit(KeycloakSessionFactory factory)
Called after all provider factories have been initialized
-
-
-
Method Detail
-
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
-
-