Package org.keycloak.cache

Class DefaultLocalCacheProviderFactory

java.lang.Object

org.keycloak.cache.DefaultLocalCacheProviderFactory

All Implemented Interfaces:

LocalCacheProvider, LocalCacheProviderFactory, Provider, ProviderFactory<LocalCacheProvider>

public class DefaultLocalCacheProviderFactory
extends Object
implements LocalCacheProvider, LocalCacheProviderFactory

The default implementation for LocalCacheProvider and LocalCacheProviderFactory.

Constructor Summary

Constructors

Constructor	Description
DefaultLocalCacheProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
<K, V> LocalCache<K,V>	create(LocalCacheConfiguration<K,V> configuration)	Creates a new LocalCache instance for local caching.
LocalCacheProvider	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

dependsOn, getConfigMetadata, order

Constructor Details

DefaultLocalCacheProviderFactory

public DefaultLocalCacheProviderFactory()

Method Details

create

public LocalCacheProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<LocalCacheProvider>

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created.

Specified by:

init in interface ProviderFactory<LocalCacheProvider>

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<LocalCacheProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<LocalCacheProvider>

create

public <K,
V> LocalCache<K,V> create(LocalCacheConfiguration<K,V> configuration)

Description copied from interface: LocalCacheProvider

Creates a new LocalCache instance for local caching. LocalCacheProvider implementations are not responsible for managing the lifecycle of created LocalCache instances. It is the responsibility of LocalCache consumers to ensure that LocalCache.close() is called when the cache is no longer required.

Specified by:

create in interface LocalCacheProvider

Type Parameters:

K - the type of the cache Keys used for lookup

V - the type of the cache Values to be stored

Parameters:

configuration - the desired cache configuration

Returns:

LocalCache a newly created cache

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<LocalCacheProvider>