Package org.keycloak.storage.datastore

Class DefaultDatastoreProviderFactory

java.lang.Object

org.keycloak.storage.datastore.DefaultDatastoreProviderFactory

All Implemented Interfaces:

ProviderEventListener, ProviderFactory<DatastoreProvider>, DatastoreProviderFactory

public class DefaultDatastoreProviderFactory
extends Object
implements DatastoreProviderFactory, ProviderEventListener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_MIGRATE_EXISTING_DB_TO_SNAPSHOT_OPTION

Constructor Summary

Constructors

Constructor	Description
DefaultDatastoreProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
DatastoreProvider	create(KeycloakSession session)
long	getClientStorageProviderTimeout()
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
String	getId()
long	getRoleStorageProviderTimeout()
static long	getScheduledInterval()
protected static List<ScheduledTask>	getScheduledTasks()
void	init(Config.Scope config)	Only called once when the factory is first created.
void	onEvent(ProviderEvent event)
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
protected static void	scheduleTask(TimerProvider timer, KeycloakSessionFactory sessionFactory, ScheduledTask task, long interval)
protected static void	scheduleTasks(KeycloakSessionFactory sessionFactory, TimerProvider timer, long interval)
static void	setupClearExpiredRevokedTokensScheduledTask(KeycloakSessionFactory sessionFactory)
static void	setupScheduledTasks(KeycloakSessionFactory sessionFactory)

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, order

Field Details

ALLOW_MIGRATE_EXISTING_DB_TO_SNAPSHOT_OPTION

public static final String ALLOW_MIGRATE_EXISTING_DB_TO_SNAPSHOT_OPTION

See Also:

• Constant Field Values

Constructor Details

DefaultDatastoreProviderFactory

public DefaultDatastoreProviderFactory()

Method Details

create

public DatastoreProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<DatastoreProvider>

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

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

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<DatastoreProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<DatastoreProvider>

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Description copied from interface: ProviderFactory

Returns the metadata for each configuration property supported by this factory.

Specified by:

getConfigMetadata in interface ProviderFactory<DatastoreProvider>

Returns:

a list with the metadata for each configuration property supported by this factory

getClientStorageProviderTimeout

public long getClientStorageProviderTimeout()

getRoleStorageProviderTimeout

public long getRoleStorageProviderTimeout()

onEvent

public void onEvent(ProviderEvent event)

Specified by:

onEvent in interface ProviderEventListener

setupScheduledTasks

public static void setupScheduledTasks(KeycloakSessionFactory sessionFactory)

scheduleTasks

protected static void scheduleTasks(KeycloakSessionFactory sessionFactory,
 TimerProvider timer,
 long interval)

getScheduledTasks

protected static List<ScheduledTask> getScheduledTasks()

scheduleTask

protected static void scheduleTask(TimerProvider timer,
 KeycloakSessionFactory sessionFactory,
 ScheduledTask task,
 long interval)

setupClearExpiredRevokedTokensScheduledTask

public static void setupClearExpiredRevokedTokensScheduledTask(KeycloakSessionFactory sessionFactory)

getScheduledInterval

public static long getScheduledInterval()