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

Class DefaultCacheRemoteConfigProviderFactory

java.lang.Object

org.keycloak.spi.infinispan.impl.remote.DefaultCacheRemoteConfigProviderFactory

All Implemented Interfaces:

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

public class DefaultCacheRemoteConfigProviderFactory
extends Object
implements CacheRemoteConfigProviderFactory, CacheRemoteConfigProvider, EnvironmentDependentProviderFactory

The default implementation for CacheRemoteConfigProviderFactory and CacheRemoteConfigProvider.

It is used when an external Infinispan cluster is enabled.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HOSTNAME
static final String	PORT
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
DefaultCacheRemoteConfigProviderFactory()

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)
protected org.infinispan.client.hotrod.configuration.ConfigurationBuilder	createConfigurationBuilder()	Creates the ConfigurationBuilder.
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
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, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

HOSTNAME

public static final String HOSTNAME

See Also:

• Constant Field Values

PORT

public static final String PORT

See Also:

• Constant Field Values

Constructor Details

DefaultCacheRemoteConfigProviderFactory

public DefaultCacheRemoteConfigProviderFactory()

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>

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

Returns:

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

createConfigurationBuilder

protected org.infinispan.client.hotrod.configuration.ConfigurationBuilder createConfigurationBuilder()
                                                                                              throws IOException

Creates the ConfigurationBuilder.

This class is protected if power users need to extend this class for more advanced configuration. Using a properties file is the recommended way to configure the client in more detail. Check ConfigurationProperties for property keys.

Returns:

The ConfigurationBuilder. This instance can be modified.

Throws:

IOException - if an error occurred when reading from the properties file (if configured).

See Also:

• ConfigurationProperties