Package org.keycloak.connections.jpa.updater.liquibase.lock

Class LiquibaseDBLockProviderFactory

java.lang.Object

org.keycloak.connections.jpa.updater.liquibase.lock.LiquibaseDBLockProviderFactory

All Implemented Interfaces:

DBLockProviderFactory, EnvironmentDependentProviderFactory, ProviderFactory<DBLockProvider>

public class LiquibaseDBLockProviderFactory
extends Object
implements DBLockProviderFactory, EnvironmentDependentProviderFactory

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
static int	PROVIDER_PRIORITY

Constructor Summary

Constructors

Constructor	Description
LiquibaseDBLockProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
LiquibaseDBLockProvider	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
String	getId()
protected long	getLockWaitTimeoutMillis()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported()
int	order()
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
void	setTimeouts(long lockRecheckTimeMillis, long lockWaitTimeoutMillis)	Useful for testing to override provided configuration

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.EnvironmentDependentProviderFactory

isSupported

Field Detail

PROVIDER_PRIORITY

public static final int PROVIDER_PRIORITY

See Also:

Constant Field Values

Constructor Detail

LiquibaseDBLockProviderFactory

public LiquibaseDBLockProviderFactory()

Method Detail

getLockWaitTimeoutMillis

protected long getLockWaitTimeoutMillis()

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

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

create

public LiquibaseDBLockProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<DBLockProvider>

setTimeouts

public void setTimeouts(long lockRecheckTimeMillis,
                        long lockWaitTimeoutMillis)

Description copied from interface: DBLockProviderFactory

Useful for testing to override provided configuration

Specified by:

setTimeouts in interface DBLockProviderFactory

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<DBLockProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<DBLockProvider>

order

public int order()

Specified by:

order in interface ProviderFactory<DBLockProvider>

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

Returns:

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

isSupported

public boolean isSupported()

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Returns:

true if the provider is supported and should be available, false otherwise