Class DefaultCacheManagerAdmin

java.lang.Object

org.infinispan.manager.DefaultCacheManagerAdmin

All Implemented Interfaces:

CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>, EmbeddedCacheManagerAdmin

public class DefaultCacheManagerAdmin
extends Object
implements EmbeddedCacheManagerAdmin

The default implementation of EmbeddedCacheManagerAdmin

Since:

9.2

Author:

Tristan Tarrant

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.commons.api.CacheContainerAdmin

CacheContainerAdmin.AdminFlag

Method Summary

Modifier and Type	Method	Description
void	assignAlias(String aliasName, String cacheName)	Assign an alias to a cache.
<K,V> Cache<K,V>	createCache(String cacheName, String template)	Creates a cache on the container using the specified template.
<K,V> Cache<K,V>	createCache(String cacheName, Configuration configuration)	Creates a cache across the cluster.
void	createTemplate(String name, Configuration configuration)	Creates a template that is replicated across the cluster using the specified configuration.
<K,V> Cache<K,V>	getOrCreateCache(String cacheName, String template)	Retrieves an existing cache or creates one using the specified template if it doesn't exist
<K,V> Cache<K,V>	getOrCreateCache(String cacheName, Configuration configuration)	Retrieves an existing cache or creates one across the cluster using the specified configuration.
Configuration	getOrCreateTemplate(String name, Configuration configuration)	Retrieves an existing template or creates one across the cluster using the specified configuration.
void	removeCache(String cacheName)	Removes a cache from the cache container.
void	removeTemplate(String name)	Removes a template from the cache container.
void	updateConfigurationAttribute(String cacheName, String attributeName, String attributeValue)	Updates a mutable configuration attribute for the given cache.
EmbeddedCacheManagerAdmin	withFlags(EnumSet<CacheContainerAdmin.AdminFlag> flags)	Sets any additional CacheContainerAdmin.AdminFlags to be used when performing administrative operations.
EmbeddedCacheManagerAdmin	withFlags(CacheContainerAdmin.AdminFlag... flags)	Sets any additional CacheContainerAdmin.AdminFlags to be used when performing administrative operations.
EmbeddedCacheManagerAdmin	withSubject(Subject subject)	Performs any cache manager operations using the specified Subject.

Methods inherited from class java.lang.Object

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

Method Details

createCache

public <K,V> Cache<K,V> createCache(String cacheName,
 Configuration configuration)

Description copied from interface: EmbeddedCacheManagerAdmin

Creates a cache across the cluster. The cache will survive topology changes, e.g. when a new node joins the cluster, it will automatically be created there. This method will wait for the cache to be created on all nodes before returning.

Specified by:

createCache in interface CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>

Specified by:

createCache in interface EmbeddedCacheManagerAdmin

Type Parameters:

K - the generic type of the key

V - the generic type of the value

Parameters:

cacheName - the name of the cache

configuration - the configuration to use. It must be a clustered configuration (e.g. distributed)

Returns:

the cache

getOrCreateCache

public <K,V> Cache<K,V> getOrCreateCache(String cacheName,
 Configuration configuration)

Description copied from interface: EmbeddedCacheManagerAdmin

Retrieves an existing cache or creates one across the cluster using the specified configuration. The cache will survive topology changes, e.g. when a new node joins the cluster, it will automatically be created there. This method will wait for the cache to be created on all nodes before returning.

Specified by:

getOrCreateCache in interface CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>

Specified by:

getOrCreateCache in interface EmbeddedCacheManagerAdmin

Type Parameters:

K - the generic type of the key

V - the generic type of the value

Parameters:

cacheName - the name of the cache

configuration - the configuration to use. It must be a clustered configuration (e.g. distributed)

Returns:

the cache

createCache

public <K,V> Cache<K,V> createCache(String cacheName,
 String template)

Description copied from interface: EmbeddedCacheManagerAdmin

Creates a cache on the container using the specified template.

Specified by:

createCache in interface CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>

Specified by:

createCache in interface EmbeddedCacheManagerAdmin

Parameters:

cacheName - the name of the cache to create

template - the template to use for the cache. If null, the configuration marked as default on the container will be used

Returns:

the cache

getOrCreateCache

public <K,V> Cache<K,V> getOrCreateCache(String cacheName,
 String template)

Description copied from interface: EmbeddedCacheManagerAdmin

Retrieves an existing cache or creates one using the specified template if it doesn't exist

Specified by:

getOrCreateCache in interface CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>

Specified by:

getOrCreateCache in interface EmbeddedCacheManagerAdmin

Parameters:

cacheName - the name of the cache to create

template - the template to use for the cache. If null, the configuration marked as default on the container will be used

Returns:

the cache

createTemplate

public void createTemplate(String name,
 Configuration configuration)

Description copied from interface: EmbeddedCacheManagerAdmin

Creates a template that is replicated across the cluster using the specified configuration. The template will survive topology changes, e.g. when a new node joins the cluster, it will automatically be created there. This method will wait for the template to be created on all nodes before returning.

Specified by:

createTemplate in interface CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>

Specified by:

createTemplate in interface EmbeddedCacheManagerAdmin

Parameters:

name - the name of the template

configuration - the configuration to use. It must be a clustered configuration (e.g. distributed)

getOrCreateTemplate

public Configuration getOrCreateTemplate(String name,
 Configuration configuration)

Description copied from interface: EmbeddedCacheManagerAdmin

Retrieves an existing template or creates one across the cluster using the specified configuration. The template will survive topology changes, e.g. when a new node joins the cluster, it will automatically be created there. This method will wait for the template to be created on all nodes before returning.

Specified by:

getOrCreateTemplate in interface EmbeddedCacheManagerAdmin

Parameters:

name - the name of the template

configuration - the configuration to use. It must be a clustered configuration (e.g. distributed)

Returns:

the template configuration

removeTemplate

public void removeTemplate(String name)

Description copied from interface: EmbeddedCacheManagerAdmin

Removes a template from the cache container. Any persisted data will be cleared.

Specified by:

removeTemplate in interface CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>

Specified by:

removeTemplate in interface EmbeddedCacheManagerAdmin

Parameters:

name - the name of the template to remove

removeCache

public void removeCache(String cacheName)

Description copied from interface: CacheContainerAdmin

Removes a cache from the cache container. Any persisted data will be cleared.

Specified by:

removeCache in interface CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>

Parameters:

cacheName - the name of the cache to remove

withFlags

public EmbeddedCacheManagerAdmin withFlags(CacheContainerAdmin.AdminFlag... flags)

Description copied from interface: CacheContainerAdmin

Sets any additional CacheContainerAdmin.AdminFlags to be used when performing administrative operations. Note: whether an operation supports a certain flag or not is dependent on the configuration and environment. If a flag cannot be honored, the operation will fail with an exception.

Specified by:

withFlags in interface CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>

Parameters:

flags -

Returns:

withFlags

public EmbeddedCacheManagerAdmin withFlags(EnumSet<CacheContainerAdmin.AdminFlag> flags)

Description copied from interface: CacheContainerAdmin

Sets any additional CacheContainerAdmin.AdminFlags to be used when performing administrative operations. Note: whether an operation supports a certain flag or not is dependent on the configuration and environment. If a flag cannot be honored, the operation will fail with an exception.

Specified by:

withFlags in interface CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>

Parameters:

flags -

Returns:

withSubject

public EmbeddedCacheManagerAdmin withSubject(Subject subject)

Description copied from interface: EmbeddedCacheManagerAdmin

Performs any cache manager operations using the specified Subject. Only applies to cache managers with authorization enabled (see GlobalConfigurationBuilder.security()).

Specified by:

withSubject in interface EmbeddedCacheManagerAdmin

Parameters:

subject -

Returns:

an EmbeddedCacheManagerAdmin instance on which a real operation is to be invoked, using the specified subject

updateConfigurationAttribute

public void updateConfigurationAttribute(String cacheName,
 String attributeName,
 String attributeValue)

Description copied from interface: EmbeddedCacheManagerAdmin

Updates a mutable configuration attribute for the given cache.

Specified by:

updateConfigurationAttribute in interface CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>

Specified by:

updateConfigurationAttribute in interface EmbeddedCacheManagerAdmin

Parameters:

cacheName - the name of the cache on which the attribute will be updated

attributeName - the path of the attribute we want to change

attributeValue - the new value to apply to the attribute

assignAlias

public void assignAlias(String aliasName,
 String cacheName)

Description copied from interface: CacheContainerAdmin

Assign an alias to a cache. If the alias was already associated with another cache, the association will be reassigned to the specified cache. If the alias was not associated with any cache, it is created and associated to the specified cache. If the alias was already associated with the specified cache, this operation does nothing.

Specified by:

assignAlias in interface CacheContainerAdmin<EmbeddedCacheManagerAdmin, Configuration>

Parameters:

aliasName - the name of the alias

cacheName - the name of the cache to which the alias should be associated