Package org.infinispan.client.hotrod

Interface RemoteCacheManagerAdmin

All Superinterfaces:

org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>

All Known Implementing Classes:

RemoteCacheManagerAdminImpl

public interface RemoteCacheManagerAdmin
extends org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>

Remote Administration operations

Since:

9.1

Author:

Tristan Tarrant

Nested Class Summary

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

org.infinispan.commons.api.CacheContainerAdmin.AdminFlag

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.
void	createCache(String name, String template, EnumSet<AdminFlag> flags)	Deprecated. use CacheContainerAdmin.withFlags(AdminFlag...) instead
<K,V> RemoteCache<K,V>	createCache(String name, org.infinispan.commons.configuration.BasicConfiguration configuration)	Creates a cache on the remote server cluster using the specified 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, org.infinispan.commons.configuration.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.

Methods inherited from interface org.infinispan.commons.api.CacheContainerAdmin

withFlags, withFlags

Method Detail

createCache

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

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

Specified by:

createCache in interface org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>

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

<K,V> RemoteCache<K,V> createCache(String name,
                                               org.infinispan.commons.configuration.BasicConfiguration configuration)
                                        throws HotRodClientException

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

Specified by:

createCache in interface org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>

Parameters:

name - the name of the cache to create

configuration - a concrete configuration that will be sent to the server. The XML representation of this configuration must use the Infinispan embedded configuration schema in a version supported by the server.

Returns:

the cache

Throws:

HotRodClientException

getOrCreateCache

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

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

Specified by:

getOrCreateCache in interface org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>

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

<K,V> RemoteCache<K,V> getOrCreateCache(String name,
                                                    org.infinispan.commons.configuration.BasicConfiguration configuration)
                                             throws HotRodClientException

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 org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>

Parameters:

name - the name of the cache to create

configuration - a concrete configuration that will be sent to the server. The XML representation of this configuration must use the Infinispan embedded configuration schema in a version supported by the server.

Returns:

the cache

Throws:

HotRodClientException

createCache

@Deprecated
void createCache(String name,
                 String template,
                 EnumSet<AdminFlag> flags)
          throws HotRodClientException

Deprecated.

use CacheContainerAdmin.withFlags(AdminFlag...) instead

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

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

flags - an EnumSet of flags to use when creating the cache. See CacheContainerAdmin.AdminFlag

Throws:

HotRodClientException

removeCache

void removeCache(String name)
          throws HotRodClientException

Removes a cache from the remote server cluster.

Specified by:

removeCache in interface org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>

Parameters:

name - the name of the cache to remove

Throws:

HotRodClientException

reindexCache

void reindexCache(String name)
           throws HotRodClientException

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

Parameters:

name - the name of the cache to reindex

Throws:

HotRodClientException