Package org.keycloak.models.map.storage.hotRod.locking

Class HotRodGlobalLockProviderFactory

java.lang.Object

org.keycloak.models.map.storage.hotRod.locking.HotRodGlobalLockProviderFactory

All Implemented Interfaces:

GlobalLockProviderFactory, EnvironmentDependentProviderFactory, ProviderFactory<GlobalLockProvider>

public class HotRodGlobalLockProviderFactory
extends Object
implements GlobalLockProviderFactory, EnvironmentDependentProviderFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	HOT_ROD_LOCKS_CACHE
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
HotRodGlobalLockProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
GlobalLockProvider	create(KeycloakSession session)
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported()
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.EnvironmentDependentProviderFactory

isSupported

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

HOT_ROD_LOCKS_CACHE

protected static final String HOT_ROD_LOCKS_CACHE

See Also:

• Constant Field Values

Constructor Details

HotRodGlobalLockProviderFactory

public HotRodGlobalLockProviderFactory()

Method Details

create

public GlobalLockProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<GlobalLockProvider>

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

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

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<GlobalLockProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<GlobalLockProvider>

isSupported

public boolean isSupported()

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Returns:

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