Package org.infinispan.globalstate.impl

Class OverlayLocalConfigurationStorage

java.lang.Object

org.infinispan.globalstate.impl.VolatileLocalConfigurationStorage

org.infinispan.globalstate.impl.OverlayLocalConfigurationStorage

All Implemented Interfaces:

LocalConfigurationStorage

public class OverlayLocalConfigurationStorage
extends VolatileLocalConfigurationStorage

An implementation of LocalConfigurationStorage which stores non-CacheContainerAdmin.AdminFlag.VOLATILE

This component persists cache configurations to the GlobalStateConfiguration.persistentLocation() in a

caches.xml

file which is read on startup.

Since:

9.2

Author:

Tristan Tarrant

Field Summary

Fields inherited from class org.infinispan.globalstate.impl.VolatileLocalConfigurationStorage

blockingManager, cacheManager, configurationManager, log, parserRegistry

Constructor Summary

Constructors

Constructor	Description
OverlayLocalConfigurationStorage()

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	createCache(String name, String template, Configuration configuration, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Creates the cache using the supplied template, configuration and flags.
CompletionStage<Void>	createTemplate(String name, Configuration configuration, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Creates the template using the supplied configuration and flags.
Map<String,Configuration>	loadAllCaches()	Loads all persisted cache configurations
Map<String,Configuration>	loadAllTemplates()	Loads all persisted templates
CompletionStage<Void>	removeCache(String name, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Removes the specified cache.
CompletionStage<Void>	removeTemplate(String name, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Removes the specified template.
CompletionStage<Void>	updateConfiguration(String name, Configuration configuration, EnumSet<CacheContainerAdmin.AdminFlag> flags)	Updates an existing configuration.
void	validateFlags(EnumSet<CacheContainerAdmin.AdminFlag> flags)	Checks whether this LocalConfigurationStorage supports the supplied flags.

Methods inherited from class org.infinispan.globalstate.impl.VolatileLocalConfigurationStorage

initialize, removeCacheSync, removeTemplateSync, validateConfigurationUpdate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.infinispan.globalstate.LocalConfigurationStorage

loadAll

Constructor Detail

OverlayLocalConfigurationStorage

public OverlayLocalConfigurationStorage()

Method Detail

validateFlags

public void validateFlags(EnumSet<CacheContainerAdmin.AdminFlag> flags)

Description copied from interface: LocalConfigurationStorage

Checks whether this LocalConfigurationStorage supports the supplied flags. A CacheConfigurationException will be thrown in case this cannot be done.

Specified by:

validateFlags in interface LocalConfigurationStorage

Overrides:

validateFlags in class VolatileLocalConfigurationStorage

createTemplate

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

Description copied from interface: LocalConfigurationStorage

Creates the template using the supplied configuration and flags.

Specified by:

createTemplate in interface LocalConfigurationStorage

Overrides:

createTemplate in class VolatileLocalConfigurationStorage

Parameters:

name - the name of the template to create

configuration - the Configuration to use

flags - the desired CacheContainerAdmin.AdminFlags

removeTemplate

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

Description copied from interface: LocalConfigurationStorage

Removes the specified template.

Specified by:

removeTemplate in interface LocalConfigurationStorage

Overrides:

removeTemplate in class VolatileLocalConfigurationStorage

Parameters:

name - the name of the template to remove

flags - the desired CacheContainerAdmin.AdminFlags

createCache

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

Description copied from interface: LocalConfigurationStorage

Creates the cache using the supplied template, configuration and flags. This method may be invoked either with or without a template. In both cases a concrete configuration will also be available. If a template name is present, the LocalConfigurationStorage should use it, e.g. when persisting the configuration.

Specified by:

createCache in interface LocalConfigurationStorage

Overrides:

createCache in class VolatileLocalConfigurationStorage

Parameters:

name - the name of the cache to create

template - the template that should be used to configure the cache. Can be null.

configuration - the Configuration to use

flags - the desired CacheContainerAdmin.AdminFlags

updateConfiguration

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

Description copied from interface: LocalConfigurationStorage

Updates an existing configuration. Only the attributes that are mutable and that have been modified in the supplied configuration will be applied.

Specified by:

updateConfiguration in interface LocalConfigurationStorage

Overrides:

updateConfiguration in class VolatileLocalConfigurationStorage

Parameters:

name - the name of the configuration (cache/template)

configuration - the configuration changes to apply

flags - the desired CacheContainerAdmin.AdminFlags

removeCache

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

Description copied from interface: LocalConfigurationStorage

Removes the specified cache.

Specified by:

removeCache in interface LocalConfigurationStorage

Overrides:

removeCache in class VolatileLocalConfigurationStorage

Parameters:

name - the name of the cache to remove

flags - the desired CacheContainerAdmin.AdminFlags

loadAllCaches

public Map<String,Configuration> loadAllCaches()

Description copied from interface: LocalConfigurationStorage

Loads all persisted cache configurations

Specified by:

loadAllCaches in interface LocalConfigurationStorage

Overrides:

loadAllCaches in class VolatileLocalConfigurationStorage

loadAllTemplates

public Map<String,Configuration> loadAllTemplates()

Description copied from interface: LocalConfigurationStorage

Loads all persisted templates

Specified by:

loadAllTemplates in interface LocalConfigurationStorage

Overrides:

loadAllTemplates in class VolatileLocalConfigurationStorage