Package org.keycloak.services

Class DefaultKeycloakSessionFactory

java.lang.Object

org.keycloak.services.DefaultKeycloakSessionFactory

All Implemented Interfaces:

KeycloakSessionFactory, InvalidationHandler, ProviderEventManager, ProviderManagerDeployer

public abstract class DefaultKeycloakSessionFactory
extends Object
implements KeycloakSessionFactory, ProviderManagerDeployer

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.provider.InvalidationHandler

InvalidationHandler.InvalidableObjectType, InvalidationHandler.ObjectType

Field Summary

Fields

Modifier and Type	Field	Description
protected ComponentFactoryProviderFactory	componentFactoryPF
protected Map<Class<? extends Provider>,Map<String,ProviderFactory>>	factoriesMap
protected CopyOnWriteArrayList<ProviderEventListener>	listeners
protected Map<Class<? extends Provider>,String>	provider
protected long	serverStartupTimestamp
protected Set<Spi>	spis

Constructor Summary

Constructors

Constructor	Description
DefaultKeycloakSessionFactory()

Method Summary

Modifier and Type	Method	Description
protected void	checkProvider()
void	close()
void	deploy(ProviderManager pm)
protected Map<Class<? extends Provider>,Map<String,ProviderFactory>>	getFactoriesCopy()
Stream<ProviderFactory>	getProviderFactoriesStream(Class<? extends Provider> clazz)	Returns stream of provider factories for the given provider.
<T extends Provider> ProviderFactory<T>	getProviderFactory(Class<T> clazz)
<T extends Provider> ProviderFactory<T>	getProviderFactory(Class<T> clazz, String id)
<T extends Provider> ProviderFactory<T>	getProviderFactory(Class<T> clazz, String realmId, String componentId, Function<KeycloakSessionFactory,ComponentModel> modelGetter)
long	getServerStartupTimestamp()
Spi	getSpi(Class<? extends Provider> providerClass)
Set<Spi>	getSpis()
void	init()
protected void	initProviderFactories()
protected void	initProviderFactories(boolean updateComponentFactory, Map<Class<? extends Provider>,Map<String,ProviderFactory>> factories)
void	invalidate(KeycloakSession session, InvalidationHandler.InvalidableObjectType type, Object... ids)	Invalidates intermediate states of the given objects
protected boolean	isEnabled(ProviderFactory factory, Config.Scope scope)
static boolean	isInternal(ProviderFactory<?> factory)
protected Map<Class<? extends Provider>,Map<String,ProviderFactory>>	loadFactories(ProviderManager pm)
void	publish(ProviderEvent event)
void	register(ProviderEventListener listener)
static String	resolveDefaultProvider(Map<String,ProviderFactory> factories, Spi spi)
void	undeploy(ProviderManager pm)
void	unregister(ProviderEventListener listener)
protected void	updateComponentFactoryProviderFactory()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.KeycloakSessionFactory

create

Field Details

spis

protected Set<Spi> spis

provider

protected Map<Class<? extends Provider>,String> provider

factoriesMap

protected volatile Map<Class<? extends Provider>,Map<String,ProviderFactory>> factoriesMap

listeners

protected CopyOnWriteArrayList<ProviderEventListener> listeners

serverStartupTimestamp

protected long serverStartupTimestamp

componentFactoryPF

protected ComponentFactoryProviderFactory componentFactoryPF

Constructor Details

DefaultKeycloakSessionFactory

public DefaultKeycloakSessionFactory()

Method Details

register

public void register(ProviderEventListener listener)

Specified by:

register in interface ProviderEventManager

unregister

public void unregister(ProviderEventListener listener)

Specified by:

unregister in interface ProviderEventManager

publish

public void publish(ProviderEvent event)

Specified by:

publish in interface ProviderEventManager

init

public void init()

initProviderFactories

protected void initProviderFactories()

initProviderFactories

protected void initProviderFactories(boolean updateComponentFactory,
 Map<Class<? extends Provider>,Map<String,ProviderFactory>> factories)

getFactoriesCopy

protected Map<Class<? extends Provider>,Map<String,ProviderFactory>> getFactoriesCopy()

deploy

public void deploy(ProviderManager pm)

Specified by:

deploy in interface ProviderManagerDeployer

undeploy

public void undeploy(ProviderManager pm)

Specified by:

undeploy in interface ProviderManagerDeployer

checkProvider

protected void checkProvider()

resolveDefaultProvider

public static String resolveDefaultProvider(Map<String,ProviderFactory> factories,
 Spi spi)

loadFactories

protected Map<Class<? extends Provider>,Map<String,ProviderFactory>> loadFactories(ProviderManager pm)

isEnabled

protected boolean isEnabled(ProviderFactory factory,
 Config.Scope scope)

getSpis

public Set<Spi> getSpis()

Specified by:

getSpis in interface KeycloakSessionFactory

getSpi

public Spi getSpi(Class<? extends Provider> providerClass)

Specified by:

getSpi in interface KeycloakSessionFactory

getProviderFactory

public <T extends Provider> ProviderFactory<T> getProviderFactory(Class<T> clazz)

Specified by:

getProviderFactory in interface KeycloakSessionFactory

getProviderFactory

public <T extends Provider> ProviderFactory<T> getProviderFactory(Class<T> clazz,
 String id)

Specified by:

getProviderFactory in interface KeycloakSessionFactory

getProviderFactory

public <T extends Provider> ProviderFactory<T> getProviderFactory(Class<T> clazz,
 String realmId,
 String componentId,
 Function<KeycloakSessionFactory,ComponentModel> modelGetter)

Specified by:

getProviderFactory in interface KeycloakSessionFactory

invalidate

public void invalidate(KeycloakSession session,
 InvalidationHandler.InvalidableObjectType type,
 Object... ids)

Description copied from interface: InvalidationHandler

Invalidates intermediate states of the given objects

Specified by:

invalidate in interface InvalidationHandler

Parameters:

session - KeycloakSession

type - Type of the objects to invalidate

ids - Parameters used for the invalidation

getProviderFactoriesStream

public Stream<ProviderFactory> getProviderFactoriesStream(Class<? extends Provider> clazz)

Description copied from interface: KeycloakSessionFactory

Returns stream of provider factories for the given provider.

Specified by:

getProviderFactoriesStream in interface KeycloakSessionFactory

Parameters:

clazz - Class<? extends Provider>

Returns:

Stream<ProviderFactory> Stream of provider factories. Never returns null.

close

public void close()

Specified by:

close in interface KeycloakSessionFactory

isInternal

public static boolean isInternal(ProviderFactory<?> factory)

getServerStartupTimestamp

public long getServerStartupTimestamp()

Specified by:

getServerStartupTimestamp in interface KeycloakSessionFactory

Returns:

timestamp of Keycloak server startup

updateComponentFactoryProviderFactory

protected void updateComponentFactoryProviderFactory()