Package org.infinispan.client.hotrod

Interface RemoteCacheContainer

All Superinterfaces:

BasicCacheContainer, Lifecycle

All Known Implementing Classes:

RemoteCacheManager

public interface RemoteCacheContainer
extends BasicCacheContainer

Method Summary

Modifier and Type	Method	Description
<K, V> RemoteCache<K,V>	getCache()	Retrieves the default cache associated with this cache container.
default <K, V> RemoteCache<K,V>	getCache(boolean forceReturnValue)	Deprecated, for removal: This API element is subject to removal in a future version. since 11.0.
<K, V> RemoteCache<K,V>	getCache(String cacheName)	Retrieves a cache by name.
default <K, V> RemoteCache<K,V>	getCache(String cacheName, boolean forceReturnValue)	Deprecated, for removal: This API element is subject to removal in a future version. since 11.0.
default <K, V> RemoteCache<K,V>	getCache(String cacheName, boolean forceReturnValue, javax.transaction.TransactionManager transactionManager)	Deprecated, for removal: This API element is subject to removal in a future version. since 11.0.
default <K, V> RemoteCache<K,V>	getCache(String cacheName, boolean forceReturnValue, TransactionMode transactionMode)	Deprecated, for removal: This API element is subject to removal in a future version. since 11.0.
<K, V> RemoteCache<K,V>	getCache(String cacheName, boolean forceReturnValue, TransactionMode transactionMode, javax.transaction.TransactionManager transactionManager)	Deprecated, for removal: This API element is subject to removal in a future version. since 11.0.
default <K, V> RemoteCache<K,V>	getCache(String cacheName, javax.transaction.TransactionManager transactionManager)	Deprecated, for removal: This API element is subject to removal in a future version. since 11.0.
default <K, V> RemoteCache<K,V>	getCache(String cacheName, TransactionMode transactionMode)	Deprecated, for removal: This API element is subject to removal in a future version. since 11.0.
<K, V> RemoteCache<K,V>	getCache(String cacheName, TransactionMode transactionMode, javax.transaction.TransactionManager transactionManager)	Deprecated, for removal: This API element is subject to removal in a future version. since 11.0.
Configuration	getConfiguration()	Retrieves the configuration currently in use.
String	getCurrentClusterName()	Returns the name of the currently active cluster.
Marshaller	getMarshaller()
boolean	isStarted()
boolean	isTransactional(String cacheName)
boolean	switchToCluster(String clusterName)	Switch remote cache manager to a different cluster, previously declared via configuration.
boolean	switchToDefaultCluster()	Switch remote cache manager to a the default cluster, previously declared via configuration.

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

getCacheNames

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

start, stop

Method Details

getCache

<K,
V> RemoteCache<K,V> getCache()

Description copied from interface: BasicCacheContainer

Retrieves the default cache associated with this cache container.

Specified by:

getCache in interface BasicCacheContainer

Returns:

the default cache.

See Also:

• BasicCacheContainer.getCache()

getCache

<K,
V> RemoteCache<K,V> getCache(String cacheName)

Description copied from interface: BasicCacheContainer

Retrieves a cache by name.

If the cache has been previously created with the same name, the running cache instance is returned. Otherwise, this method attempts to create the cache first.

Specified by:

getCache in interface BasicCacheContainer

Parameters:

cacheName - name of cache to retrieve

Returns:

a cache instance identified by cacheName

See Also:

• BasicCacheContainer.getCache(String)

getConfiguration

Configuration getConfiguration()

Retrieves the configuration currently in use. The configuration object is immutable. If you wish to change configuration, you should use the following pattern:

 ConfigurationBuilder builder = new ConfigurationBuilder();
 builder.read(remoteCacheManager.getConfiguration());
 // modify builder
 remoteCacheManager.stop();
 remoteCacheManager = new RemoteCacheManager(builder.build());
 

Returns:

The configuration of this RemoteCacheManager

getCache

@Deprecated(forRemoval=true)
default <K,
V> RemoteCache<K,V> getCache(String cacheName,
 boolean forceReturnValue)

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.0. Use ConfigurationBuilder.remoteCache(String) to configure the cache and then getCache(String) to obtain it.

Same as getCache(cacheName, forceReturnValue, null, null)

See Also:

• getCache(String, boolean, TransactionMode, TransactionManager)

getCache

@Deprecated(forRemoval=true)
default <K,
V> RemoteCache<K,V> getCache(boolean forceReturnValue)

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.0. Use ConfigurationBuilder.remoteCache(String) to configure the cache and then getCache(String) to obtain it.

Same as getCache("", forceReturnValue, null, null)

See Also:

• getCache(String, boolean, TransactionMode, TransactionManager)

getCache

@Deprecated(forRemoval=true)
default <K,
V> RemoteCache<K,V> getCache(String cacheName,
 TransactionMode transactionMode)

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.0. Use ConfigurationBuilder.remoteCache(String) to configure the cache and then getCache(String) to obtain it.

Same as getCache(cacheName, transactionMode, null)

See Also:

• getCache(String, TransactionMode, TransactionManager)

getCache

@Deprecated(forRemoval=true)
default <K,
V> RemoteCache<K,V> getCache(String cacheName,
 boolean forceReturnValue,
 TransactionMode transactionMode)

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.0. Use ConfigurationBuilder.remoteCache(String) to configure the cache and then getCache(String) to obtain it.

Same as getCache(cacheName, forceReturnValue, transactionMode, null)

See Also:

• getCache(String, boolean, TransactionMode, TransactionManager)

getCache

@Deprecated(forRemoval=true)
default <K,
V> RemoteCache<K,V> getCache(String cacheName,
 javax.transaction.TransactionManager transactionManager)

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.0. Use ConfigurationBuilder.remoteCache(String) to configure the cache and then getCache(String) to obtain it.

Same as getCache(cacheName, null, transactionManager)

See Also:

• getCache(String, TransactionMode, TransactionManager)

getCache

@Deprecated(forRemoval=true)
default <K,
V> RemoteCache<K,V> getCache(String cacheName,
 boolean forceReturnValue,
 javax.transaction.TransactionManager transactionManager)

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.0. Use ConfigurationBuilder.remoteCache(String) to configure the cache and then getCache(String) to obtain it.

Same as getCache(cacheName, forceReturnValue, null, transactionManager)

See Also:

• getCache(String, boolean, TransactionMode, TransactionManager)

getCache

@Deprecated(forRemoval=true)
<K,
V> RemoteCache<K,V> getCache(String cacheName,
 TransactionMode transactionMode,
 javax.transaction.TransactionManager transactionManager)

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.0. Use ConfigurationBuilder.remoteCache(String) to configure the cache and then getCache(String) to obtain it.

Parameters:

cacheName - The cache's name.

transactionMode - The TransactionMode to override. If null, it uses the configured value.

transactionManager - The TransactionManager to override. If null, it uses the configured value.

Returns:

the RemoteCache implementation.

getCache

@Deprecated(forRemoval=true)
<K,
V> RemoteCache<K,V> getCache(String cacheName,
 boolean forceReturnValue,
 TransactionMode transactionMode,
 javax.transaction.TransactionManager transactionManager)

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.0. Use ConfigurationBuilder.remoteCache(String) to configure the cache and then getCache(String) to obtain it.

Parameters:

cacheName - The cache's name.

forceReturnValue - true to force a return value when it is not needed.

transactionMode - The TransactionMode to override. If null, it uses the configured value.

transactionManager - The TransactionManager to override. If null, it uses the configured value.

Returns:

the RemoteCache implementation.

isStarted

boolean isStarted()

switchToCluster

boolean switchToCluster(String clusterName)

Switch remote cache manager to a different cluster, previously declared via configuration. If the switch was completed successfully, this method returns true, otherwise it returns false.

Parameters:

clusterName - name of the cluster to which to switch to

Returns:

true if the cluster was switched, false otherwise

switchToDefaultCluster

boolean switchToDefaultCluster()

Switch remote cache manager to a the default cluster, previously declared via configuration. If the switch was completed successfully, this method returns true, otherwise it returns false.

Returns:

true if the cluster was switched, false otherwise

getCurrentClusterName

String getCurrentClusterName()

Returns the name of the currently active cluster.

Returns:

the name of the active cluster

getMarshaller

Marshaller getMarshaller()

isTransactional

boolean isTransactional(String cacheName)

Returns:

true if the cache with name cacheName can participate in transactions.