Package org.keycloak.spi.infinispan.impl.embedded

Class DefaultCacheEmbeddedConfigProviderFactory

java.lang.Object

org.keycloak.spi.infinispan.impl.embedded.DefaultCacheEmbeddedConfigProviderFactory

All Implemented Interfaces:

Provider, ProviderFactory<CacheEmbeddedConfigProvider>, CacheEmbeddedConfigProvider, CacheEmbeddedConfigProviderFactory

public class DefaultCacheEmbeddedConfigProviderFactory
extends Object
implements CacheEmbeddedConfigProviderFactory, CacheEmbeddedConfigProvider

The default implementation of CacheEmbeddedConfigProviderFactory.

It builds a ConfigurationBuilderHolder based on the Keycloak configuration.

Advanced users may extend this class and overwrite the method createConfiguration(KeycloakSessionFactory). They have access to the ConfigurationBuilderHolder, and they can modify it as needed for their custom providers.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG
static final String	NODE_NAME
static final String	PROVIDER_ID
static final String	SITE_NAME
static final String	STACK

Constructor Summary

Constructors

Constructor	Description
DefaultCacheEmbeddedConfigProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
org.infinispan.configuration.parsing.ConfigurationBuilderHolder	configuration()	The ConfigurationBuilderHolder whit the EmbeddedCacheManager configuration.
CacheEmbeddedConfigProvider	create(KeycloakSession session)
protected org.infinispan.configuration.parsing.ConfigurationBuilderHolder	createConfiguration(KeycloakSessionFactory factory)
Set<Class<? extends Provider>>	dependsOn()	Optional method used to declare that a ProviderFactory has a dependency on one or more Providers.
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.
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

order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

CONFIG

public static final String CONFIG

See Also:

• Constant Field Values

STACK

public static final String STACK

See Also:

• Constant Field Values

NODE_NAME

public static final String NODE_NAME

See Also:

• Constant Field Values

SITE_NAME

public static final String SITE_NAME

See Also:

• Constant Field Values

Constructor Details

DefaultCacheEmbeddedConfigProviderFactory

public DefaultCacheEmbeddedConfigProviderFactory()

Method Details

create

public CacheEmbeddedConfigProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<CacheEmbeddedConfigProvider>

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

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

configuration

public org.infinispan.configuration.parsing.ConfigurationBuilderHolder configuration()

Description copied from interface: CacheEmbeddedConfigProvider

The ConfigurationBuilderHolder whit the EmbeddedCacheManager configuration. It must not be null.

Specified by:

configuration in interface CacheEmbeddedConfigProvider

Returns:

The ConfigurationBuilderHolder whit the EmbeddedCacheManager configuration.

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface CacheEmbeddedConfigProvider

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<CacheEmbeddedConfigProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<CacheEmbeddedConfigProvider>

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

Returns:

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

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

createConfiguration

protected org.infinispan.configuration.parsing.ConfigurationBuilderHolder createConfiguration(KeycloakSessionFactory factory)
                                                                                       throws IOException

Throws:

IOException