Interface GlobalConfigurationManager

All Known Implementing Classes:

GlobalConfigurationManagerImpl

public interface GlobalConfigurationManager

The GlobalConfigurationManager is the main interface for sharing runtime configuration state across a cluster. It uses an internal cache 'org.infinispan.CONFIG'. The cache is keyed with ScopedState. Each scope owner is responsible for its own keys.

Since:

9.2

Author:

Tristan Tarrant

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_STATE_CACHE_NAME	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
CompletionStage<Configuration>	createCache(String cacheName, String template, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Defines a cluster-wide cache configuration using the supplied template
CompletionStage<Configuration>	createCache(String cacheName, Configuration configuration, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Defines a cluster-wide cache configuration
CompletionStage<Void>	createTemplate(String name, Configuration configuration, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Defines a cluster-wide configuration template
CompletionStage<Configuration>	getOrCreateCache(String cacheName, String template, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Defines a cluster-wide cache configuration using the supplied template or retrieves an existing one
CompletionStage<Configuration>	getOrCreateCache(String cacheName, Configuration configuration, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Defines a cluster-wide cache configuration or retrieves an existing one
CompletionStage<Configuration>	getOrCreateTemplate(String name, Configuration configuration, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Defines a cluster-wide configuration template
<V> Cache<ScopedState, V>	getStateCache()	Returns the global state cache
default void	postStart()
CompletionStage<Void>	removeCache(String cacheName, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Removes a cluster-wide cache and its configuration
CompletionStage<Void>	removeTemplate(String name, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Removes a cluster-wide template

Field Details

CONFIG_STATE_CACHE_NAME

@Deprecated(forRemoval=true,
            since="15.0")
static final String CONFIG_STATE_CACHE_NAME

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

See Also:

• Constant Field Values

Method Details

postStart

default void postStart()

getStateCache

<V> Cache<ScopedState, V> getStateCache()

Returns the global state cache

createTemplate

CompletionStage<Void> createTemplate(String name,
 Configuration configuration,
 EnumSet<CacheContainerAdmin.AdminFlag> flags)

Defines a cluster-wide configuration template

Parameters:

name - the name of the template

configuration - the configuration object

flags - the flags to apply

getOrCreateTemplate

CompletionStage<Configuration> getOrCreateTemplate(String name,
 Configuration configuration,
 EnumSet<CacheContainerAdmin.AdminFlag> flags)

Defines a cluster-wide configuration template

Parameters:

name - the name of the template

configuration - the configuration object

flags - the flags to apply

createCache

CompletionStage<Configuration> createCache(String cacheName,
 Configuration configuration,
 EnumSet<CacheContainerAdmin.AdminFlag> flags)

Defines a cluster-wide cache configuration

Parameters:

cacheName - the name of the configuration

configuration - the configuration object

flags - the flags to apply

getOrCreateCache

CompletionStage<Configuration> getOrCreateCache(String cacheName,
 Configuration configuration,
 EnumSet<CacheContainerAdmin.AdminFlag> flags)

Defines a cluster-wide cache configuration or retrieves an existing one

Parameters:

cacheName - the name of the configuration

configuration - the configuration object

flags - the flags to apply

createCache

CompletionStage<Configuration> createCache(String cacheName,
 String template,
 EnumSet<CacheContainerAdmin.AdminFlag> flags)

Defines a cluster-wide cache configuration using the supplied template

Parameters:

cacheName - the name of the configuration

template - the template name to use

flags - the flags to apply

getOrCreateCache

CompletionStage<Configuration> getOrCreateCache(String cacheName,
 String template,
 EnumSet<CacheContainerAdmin.AdminFlag> flags)

Defines a cluster-wide cache configuration using the supplied template or retrieves an existing one

Parameters:

cacheName - the name of the configuration

template - the template name to use

flags - the flags to apply

removeCache

CompletionStage<Void> removeCache(String cacheName,
 EnumSet<CacheContainerAdmin.AdminFlag> flags)

Removes a cluster-wide cache and its configuration

Parameters:

cacheName - the name of the cache

flags -

removeTemplate

CompletionStage<Void> removeTemplate(String name,
 EnumSet<CacheContainerAdmin.AdminFlag> flags)

Removes a cluster-wide template

Parameters:

name - the name of the template

flags -