Package org.keycloak.connections.infinispan

Class DefaultInfinispanConnectionProviderFactory

java.lang.Object

org.keycloak.connections.infinispan.DefaultInfinispanConnectionProviderFactory

All Implemented Interfaces:

InfinispanConnectionProviderFactory, ProviderEventListener, ProviderFactory<InfinispanConnectionProvider>, ServerInfoAwareProviderFactory

public class DefaultInfinispanConnectionProviderFactory
extends Object
implements InfinispanConnectionProviderFactory, ProviderEventListener, ServerInfoAwareProviderFactory

Author:

Stian Thorgersen

Constructor Summary

Constructors

Constructor	Description
DefaultInfinispanConnectionProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
InfinispanConnectionProvider	create(KeycloakSession session)
protected org.infinispan.manager.EmbeddedCacheManager	createEmbeddedCacheManager(KeycloakSession session)
protected org.infinispan.client.hotrod.RemoteCacheManager	createRemoteCacheManager(KeycloakSession session)
Set<Class<? extends Provider>>	dependsOn()	Optional method used to declare that a ProviderFactory has a dependency on one or more Providers.
protected org.infinispan.configuration.cache.Configuration	getCrlCacheConfig()	Deprecated, for removal: This API element is subject to removal in a future version. Use CacheConfigurator.getCrlCacheConfig()
String	getId()
protected org.infinispan.configuration.cache.Configuration	getKeysCacheConfig()	Deprecated, for removal: This API element is subject to removal in a future version. not used anymore
Map<String,String>	getOperationalInfo()	Return actual info about the provider.
void	init(Config.Scope config)	Only called once when the factory is first created.
protected org.infinispan.manager.EmbeddedCacheManager	initContainerManaged(org.infinispan.manager.EmbeddedCacheManager cacheManager)	Deprecated, for removal: This API element is subject to removal in a future version. not invoked anymore.
protected org.infinispan.manager.EmbeddedCacheManager	initEmbedded()	Deprecated, for removal: This API element is subject to removal in a future version. not used anymore.
boolean	isClusterHealthSupported()	Checks if the cluster health check is supported.
boolean	isClusterHealthy()	Detects network split in the cluster.
protected InfinispanConnectionProvider	lazyInit(KeycloakSession keycloakSession)
void	onEvent(ProviderEvent event)
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
static void	runWithReadLockOnCacheManager(Runnable task)
static void	runWithWriteLockOnCacheManager(Runnable task)

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

Constructor Details

DefaultInfinispanConnectionProviderFactory

public DefaultInfinispanConnectionProviderFactory()

Method Details

create

public InfinispanConnectionProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<InfinispanConnectionProvider>

runWithReadLockOnCacheManager

public static void runWithReadLockOnCacheManager(Runnable task)

runWithWriteLockOnCacheManager

public static void runWithWriteLockOnCacheManager(Runnable task)

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<InfinispanConnectionProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<InfinispanConnectionProvider>

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

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

lazyInit

protected InfinispanConnectionProvider lazyInit(KeycloakSession keycloakSession)

createEmbeddedCacheManager

protected org.infinispan.manager.EmbeddedCacheManager createEmbeddedCacheManager(KeycloakSession session)

createRemoteCacheManager

protected org.infinispan.client.hotrod.RemoteCacheManager createRemoteCacheManager(KeycloakSession session)

initContainerManaged

@Deprecated(since="26.0",
            forRemoval=true)
protected org.infinispan.manager.EmbeddedCacheManager initContainerManaged(org.infinispan.manager.EmbeddedCacheManager cacheManager)

Deprecated, for removal: This API element is subject to removal in a future version.

not invoked anymore. Overwrite createEmbeddedCacheManager(KeycloakSession).

initEmbedded

@Deprecated(since="26.3",
            forRemoval=true)
protected org.infinispan.manager.EmbeddedCacheManager initEmbedded()

Deprecated, for removal: This API element is subject to removal in a future version.

not used anymore. Overwrite createEmbeddedCacheManager(KeycloakSession) if you want to create a custom EmbeddedCacheManager.

getKeysCacheConfig

@Deprecated(since="26.3",
            forRemoval=true)
protected org.infinispan.configuration.cache.Configuration getKeysCacheConfig()

Deprecated, for removal: This API element is subject to removal in a future version.

not used anymore

getCrlCacheConfig

@Deprecated(since="26.3",
            forRemoval=true)
protected org.infinispan.configuration.cache.Configuration getCrlCacheConfig()

Deprecated, for removal: This API element is subject to removal in a future version.

Use CacheConfigurator.getCrlCacheConfig()

dependsOn

public Set<Class<? extends Provider>> dependsOn()

Description copied from interface: ProviderFactory

Optional method used to declare that a ProviderFactory has a dependency on one or more Providers. If a Provider is declared here, it is guaranteed that the dependencies ProviderFactory.postInit(org.keycloak.models.KeycloakSessionFactory) method will be executed before this ProviderFactory's ProviderFactory.postInit(org.keycloak.models.KeycloakSessionFactory). Similarly, it's guaranteed that ProviderFactory.close() will be called on this ProviderFactory before ProviderFactory.close() is called on any of the dependent ProviderFactory implementations.

Specified by:

dependsOn in interface ProviderFactory<InfinispanConnectionProvider>

onEvent

public void onEvent(ProviderEvent event)

Specified by:

onEvent in interface ProviderEventListener

getOperationalInfo

public Map<String,String> getOperationalInfo()

Description copied from interface: ServerInfoAwareProviderFactory

Return actual info about the provider. This info contains information about provider's configuration and operational conditions (eg. errors in connection to remote systems etc) which is shown on "Server Info" page then.

Specified by:

getOperationalInfo in interface ServerInfoAwareProviderFactory

Returns:

Map with keys describing value and relevant values itself

isClusterHealthy

public boolean isClusterHealthy()

Description copied from interface: InfinispanConnectionProviderFactory

Detects network split in the cluster.

If a possible network split is detected and this node does not belong to the winning partition, this method will return false, and should not continue handling requests, to keep data safety.

Specified by:

isClusterHealthy in interface InfinispanConnectionProviderFactory

Returns:

true if the cluster is healthy and this node can continue processing requests. When false, this node must reject any work.

isClusterHealthSupported

public boolean isClusterHealthSupported()

Description copied from interface: InfinispanConnectionProviderFactory

Checks if the cluster health check is supported.

Not all JGroups configurations support discovering network splits and this method signals if the current in use configuration can detect those.

Specified by:

isClusterHealthSupported in interface InfinispanConnectionProviderFactory

Returns:

true if the cluster health check is supported.