Package org.infinispan.client.hotrod.impl

Class RemoteCacheManagerAdminImpl

java.lang.Object

org.infinispan.client.hotrod.impl.RemoteCacheManagerAdminImpl

All Implemented Interfaces:

RemoteCacheManagerAdmin, CacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>

public class RemoteCacheManagerAdminImpl
extends Object
implements RemoteCacheManagerAdmin

Since:

9.1

Author:

Tristan Tarrant

Nested Class Summary

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

CacheContainerAdmin.AdminFlag

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE
static final String	CACHE_CONFIGURATION
static final String	CACHE_NAME
static final String	CACHE_TEMPLATE
static final String	FLAGS
static final String	VALUE

Constructor Summary

Constructors

Constructor	Description
RemoteCacheManagerAdminImpl(RemoteCacheManager cacheManager, org.infinispan.client.hotrod.impl.operations.OperationsFactory operationsFactory, EnumSet<CacheContainerAdmin.AdminFlag> flags, Consumer<String> remover)

Method Summary

Modifier and Type	Method	Description
<K, V> RemoteCache<K,V>	createCache(String name, String template)	Creates a cache on the remote server cluster using the specified template name.
<K, V> RemoteCache<K,V>	createCache(String name, DefaultTemplate template)	Creates a cache on the remote server cluster using the specified default configuration template present in the server.
<K, V> RemoteCache<K,V>	createCache(String name, BasicConfiguration configuration)	Creates a cache on the remote server cluster using the specified configuration
void	createTemplate(String name, BasicConfiguration configuration)	Creates a template on the container using the provided configuration.
<K, V> RemoteCache<K,V>	getOrCreateCache(String name, String template)	Retrieves an existing cache on the remote server cluster.
<K, V> RemoteCache<K,V>	getOrCreateCache(String name, DefaultTemplate template)	Retrieves an existing cache on the remote server cluster.
<K, V> RemoteCache<K,V>	getOrCreateCache(String name, BasicConfiguration configuration)	Retrieves an existing cache on the remote server cluster.
void	reindexCache(String name)	Performs a mass reindexing of the specified cache.
void	removeCache(String name)	Removes a cache from the remote server cluster.
void	removeTemplate(String name)	Removes a template from the cache container.
void	updateConfigurationAttribute(String name, String attribute, String value)	Updates a mutable configuration attribute for the given cache.
void	updateIndexSchema(String name)	Updates the index schema state for the given cache, the cache engine is hot restarted so that index persisted or not persisted state will be preserved.
RemoteCacheManagerAdmin	withFlags(EnumSet<CacheContainerAdmin.AdminFlag> flags)	Sets any additional CacheContainerAdmin.AdminFlags to be used when performing administrative operations.
RemoteCacheManagerAdmin	withFlags(CacheContainerAdmin.AdminFlag... flags)	Sets any additional CacheContainerAdmin.AdminFlags to be used when performing administrative operations.

Methods inherited from class java.lang.Object

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

Field Details

CACHE_NAME

public static final String CACHE_NAME

See Also:

• Constant Field Values

CACHE_TEMPLATE

public static final String CACHE_TEMPLATE

See Also:

• Constant Field Values

CACHE_CONFIGURATION

public static final String CACHE_CONFIGURATION

See Also:

• Constant Field Values

ATTRIBUTE

public static final String ATTRIBUTE

See Also:

• Constant Field Values

VALUE

public static final String VALUE

See Also:

• Constant Field Values

FLAGS

public static final String FLAGS

See Also:

• Constant Field Values

Constructor Details

RemoteCacheManagerAdminImpl

public RemoteCacheManagerAdminImpl(RemoteCacheManager cacheManager,
 org.infinispan.client.hotrod.impl.operations.OperationsFactory operationsFactory,
 EnumSet<CacheContainerAdmin.AdminFlag> flags,
 Consumer<String> remover)

Method Details

createCache

public <K,
V> RemoteCache<K,V> createCache(String name,
 String template)
                                   throws HotRodClientException

Description copied from interface: RemoteCacheManagerAdmin

Creates a cache on the remote server cluster using the specified template name.

Specified by:

createCache in interface CacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>

Specified by:

createCache in interface RemoteCacheManagerAdmin

Parameters:

name - the name of the cache to create

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

Returns:

the cache

Throws:

HotRodClientException

createCache

public <K,
V> RemoteCache<K,V> createCache(String name,
 DefaultTemplate template)
                                   throws HotRodClientException

Description copied from interface: RemoteCacheManagerAdmin

Creates a cache on the remote server cluster using the specified default configuration template present in the server.

Specified by:

createCache in interface RemoteCacheManagerAdmin

Parameters:

name - the name of the cache to create

template - DefaultTemplate enum

Returns:

the cache

Throws:

HotRodClientException

createCache

public <K,
V> RemoteCache<K,V> createCache(String name,
 BasicConfiguration configuration)
                                   throws HotRodClientException

Description copied from interface: RemoteCacheManagerAdmin

Creates a cache on the remote server cluster using the specified configuration

Specified by:

createCache in interface CacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>

Specified by:

createCache in interface RemoteCacheManagerAdmin

Parameters:

name - the name of the cache to create

configuration - a concrete cache configuration that will be sent to the server in one of the supported formats: XML, JSON, and YAML. The server detects the format automatically. The configuration must conform to the Infinispan embedded configuration schema version that is supported by the server.

Returns:

the cache

Throws:

HotRodClientException

getOrCreateCache

public <K,
V> RemoteCache<K,V> getOrCreateCache(String name,
 String template)
                                        throws HotRodClientException

Description copied from interface: RemoteCacheManagerAdmin

Retrieves an existing cache on the remote server cluster. If it doesn't exist, it will be created using the specified template name.

Specified by:

getOrCreateCache in interface CacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>

Specified by:

getOrCreateCache in interface RemoteCacheManagerAdmin

Parameters:

name - the name of the cache to create

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

Returns:

the cache

Throws:

HotRodClientException

getOrCreateCache

public <K,
V> RemoteCache<K,V> getOrCreateCache(String name,
 DefaultTemplate template)
                                        throws HotRodClientException

Description copied from interface: RemoteCacheManagerAdmin

Retrieves an existing cache on the remote server cluster. If it doesn't exist, it will be created using the specified default template that is present in the server.

Specified by:

getOrCreateCache in interface RemoteCacheManagerAdmin

Parameters:

name - the name of the cache to create

template - DefaultTemplate enum

Returns:

the cache

Throws:

HotRodClientException

getOrCreateCache

public <K,
V> RemoteCache<K,V> getOrCreateCache(String name,
 BasicConfiguration configuration)
                                        throws HotRodClientException

Description copied from interface: RemoteCacheManagerAdmin

Retrieves an existing cache on the remote server cluster. If it doesn't exist, it will be created using the specified configuration.

Specified by:

getOrCreateCache in interface CacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>

Specified by:

getOrCreateCache in interface RemoteCacheManagerAdmin

Parameters:

name - the name of the cache to create

configuration - a concrete cache configuration of that will be sent to the server in one of the supported formats: XML, JSON and YAML. The format will be detected automatically. The configuration must use the Infinispan embedded configuration schema in a version supported by the server.

Returns:

the cache

Throws:

HotRodClientException

removeCache

public void removeCache(String name)

Description copied from interface: RemoteCacheManagerAdmin

Removes a cache from the remote server cluster.

Specified by:

removeCache in interface CacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>

Specified by:

removeCache in interface RemoteCacheManagerAdmin

Parameters:

name - the name of the cache to remove

withFlags

public RemoteCacheManagerAdmin 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<RemoteCacheManagerAdmin,BasicConfiguration>

Returns:

withFlags

public RemoteCacheManagerAdmin 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<RemoteCacheManagerAdmin,BasicConfiguration>

Returns:

reindexCache

public void reindexCache(String name)
                  throws HotRodClientException

Description copied from interface: RemoteCacheManagerAdmin

Performs a mass reindexing of the specified cache. The command will return immediately and the reindexing will be performed asynchronously

Specified by:

reindexCache in interface RemoteCacheManagerAdmin

Parameters:

name - the name of the cache to reindex

Throws:

HotRodClientException

updateIndexSchema

public void updateIndexSchema(String name)
                       throws HotRodClientException

Description copied from interface: RemoteCacheManagerAdmin

Updates the index schema state for the given cache, the cache engine is hot restarted so that index persisted or not persisted state will be preserved.

Specified by:

updateIndexSchema in interface RemoteCacheManagerAdmin

Parameters:

name - the name of the cache on which the index schema will be updated

Throws:

HotRodClientException

updateConfigurationAttribute

public void updateConfigurationAttribute(String name,
 String attribute,
 String value)
                                  throws HotRodClientException

Description copied from interface: RemoteCacheManagerAdmin

Updates a mutable configuration attribute for the given cache.

Specified by:

updateConfigurationAttribute in interface RemoteCacheManagerAdmin

Parameters:

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

attribute - the path of the attribute we want to change

value - the new value to apply to the attribute

Throws:

HotRodClientException

createTemplate

public void createTemplate(String name,
 BasicConfiguration configuration)

Description copied from interface: CacheContainerAdmin

Creates a template on the container using the provided configuration.

Specified by:

createTemplate in interface CacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>

Parameters:

name - the name of the template

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

removeTemplate

public void removeTemplate(String name)

Description copied from interface: CacheContainerAdmin

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

Specified by:

removeTemplate in interface CacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>

Parameters:

name - the name of the template to remove