Package org.keycloak.spi.infinispan.impl.remote

Class DisabledCacheRemoteConfigProviderFactory

java.lang.Object

org.keycloak.spi.infinispan.impl.remote.DisabledCacheRemoteConfigProviderFactory

All Implemented Interfaces:

EnvironmentDependentProviderFactory, Provider, ProviderFactory<CacheRemoteConfigProvider>, CacheRemoteConfigProvider, CacheRemoteConfigProviderFactory

public class DisabledCacheRemoteConfigProviderFactory
extends Object
implements CacheRemoteConfigProviderFactory, CacheRemoteConfigProvider, EnvironmentDependentProviderFactory

Implementation used when an external Infinispan cluster is not configured.

Constructor Summary

Constructors

Constructor	Description
DisabledCacheRemoteConfigProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
Optional<org.infinispan.client.hotrod.configuration.Configuration>	configuration()	Creates the Configuration for the Hot Rod client.
CacheRemoteConfigProvider	create(KeycloakSession session)
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
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

DisabledCacheRemoteConfigProviderFactory

public DisabledCacheRemoteConfigProviderFactory()

Method Details

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

create

public CacheRemoteConfigProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<CacheRemoteConfigProvider>

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

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

configuration

public Optional<org.infinispan.client.hotrod.configuration.Configuration> configuration()

Description copied from interface: CacheRemoteConfigProvider

Creates the Configuration for the Hot Rod client.

The optional signal if a Hot Rod client should be instantiated and started. If present, it assumes an external Infinispan cluster is ready and online, otherwise Keycloak fails to start.

Specified by:

configuration in interface CacheRemoteConfigProvider

Returns:

The Configuration for the Hot Rod client.

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface CacheRemoteConfigProvider

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<CacheRemoteConfigProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<CacheRemoteConfigProvider>