org.keycloak.provider

Interface ProviderFactory<T extends Provider>

All Known Subinterfaces:

ComponentFactory<CreatedType,ProviderType>, HostnameProviderFactory, SubComponentFactory<CreatedType,ProviderType>, ThemeResourceProviderFactory, ThemeSelectorProviderFactory, UserFederatedStorageProviderFactory, UserStorageProviderFactory<T>

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

Modifier and Type	Method and Description
void	close() This is called when the server shuts down.
T	create(KeycloakSession session)
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()