Package org.keycloak.models.cache.infinispan.authorization

Class InfinispanCacheStoreFactoryProviderFactory

java.lang.Object

org.keycloak.models.cache.infinispan.authorization.InfinispanCacheStoreFactoryProviderFactory

All Implemented Interfaces:

CachedStoreProviderFactory, ProviderFactory<CachedStoreFactoryProvider>

public class InfinispanCacheStoreFactoryProviderFactory
extends Object
implements CachedStoreProviderFactory

Author:

Bill Burke, Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHORIZATION_CLEAR_CACHE_EVENTS
static final String	AUTHORIZATION_INVALIDATION_EVENTS
static final RealmModel	NULL_REALM	Legacy store doesn't store realm id for any entity and no method there is using new introduced RealmModel parameter.
protected StoreFactoryCacheManager	storeCache

Constructor Summary

Constructors

Constructor	Description
InfinispanCacheStoreFactoryProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
CachedStoreFactoryProvider	create(KeycloakSession session)
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, order

Field Details

AUTHORIZATION_CLEAR_CACHE_EVENTS

public static final String AUTHORIZATION_CLEAR_CACHE_EVENTS

See Also:

• Constant Field Values

AUTHORIZATION_INVALIDATION_EVENTS

public static final String AUTHORIZATION_INVALIDATION_EVENTS

See Also:

• Constant Field Values

storeCache

protected volatile StoreFactoryCacheManager storeCache

NULL_REALM

public static final RealmModel NULL_REALM

Legacy store doesn't store realm id for any entity and no method there is using new introduced RealmModel parameter. The parameter was introduced for usage only in the new storage. Therefore, in some cases we may break our rule specified in JavaDoc and use null value as parameter that otherwise cannot be null. We need to be careful and place such value only to a method call that cannot end up in the new store because it would end with NullPointerException. To mark all places where we do this, we use this variable so it is easily searchable.

Constructor Details

InfinispanCacheStoreFactoryProviderFactory

public InfinispanCacheStoreFactoryProviderFactory()

Method Details

create

public CachedStoreFactoryProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<CachedStoreFactoryProvider>

init

public 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 interface ProviderFactory<CachedStoreFactoryProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<CachedStoreFactoryProvider>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<CachedStoreFactoryProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<CachedStoreFactoryProvider>