Package org.infinispan.client.hotrod
Interface RemoteCacheManagerAdmin
-
- All Superinterfaces:
CacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>
public interface RemoteCacheManagerAdmin extends CacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>
Remote Administration operations- Since:
- 9.1
- Author:
- Tristan Tarrant
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.infinispan.commons.api.CacheContainerAdmin
CacheContainerAdmin.AdminFlag
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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<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.-
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 name.- Specified by:
createCache
in interfaceCacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>
- Parameters:
name
- the name of the cache to createtemplate
- 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, DefaultTemplate template) throws HotRodClientException
Creates a cache on the remote server cluster using the specified default configuration template present in the server.- Parameters:
name
- the name of the cache to createtemplate
-DefaultTemplate
enum- Returns:
- the cache
- Throws:
HotRodClientException
-
createCache
<K,V> RemoteCache<K,V> createCache(String name, BasicConfiguration configuration) throws HotRodClientException
Creates a cache on the remote server cluster using the specified configuration- Specified by:
createCache
in interfaceCacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>
- Parameters:
name
- the name of the cache to createconfiguration
- 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 name.- Specified by:
getOrCreateCache
in interfaceCacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>
- Parameters:
name
- the name of the cache to createtemplate
- 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, DefaultTemplate template) throws HotRodClientException
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.- Parameters:
name
- the name of the cache to createtemplate
-DefaultTemplate
enum- Returns:
- the cache
- Throws:
HotRodClientException
-
getOrCreateCache
<K,V> RemoteCache<K,V> getOrCreateCache(String name, 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 interfaceCacheContainerAdmin<RemoteCacheManagerAdmin,BasicConfiguration>
- Parameters:
name
- the name of the cache to createconfiguration
- 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
-
removeCache
void removeCache(String name) throws HotRodClientException
Removes a cache from the remote server cluster.- Specified by:
removeCache
in interfaceCacheContainerAdmin<RemoteCacheManagerAdmin,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
-
-