RemoteCacheManager (Infinispan JavaDoc All 9.2.5.Final API)

java.lang.Object
- org.infinispan.client.hotrod.RemoteCacheManager

All Implemented Interfaces:

Closeable, AutoCloseable, RemoteCacheContainer, BasicCacheContainer, Lifecycle
```
public class RemoteCacheManager
extends Object
implements RemoteCacheContainer, Closeable
```
Factory for RemoteCaches.

Lifecycle:
In order to be able to use an RemoteCache, the RemoteCacheManager must be started first: beside other things, this instantiates connections to Hot Rod server(s). Starting the RemoteCacheManager can be done either at creation by passing start==true to constructor or by using a constructor that does that for you (see C-tor documentation); or after construction by calling start().
This is an "expensive" object, as it manages a set of persistent TCP connections to the Hot Rod servers. It is recommended to only have one instance of this per JVM, and to cache it between calls to the server (i.e. remoteCache operations).
stop() needs to be called explicitly in order to release all the resources (e.g. threads, TCP connections).

Since:

4.1

Author:

Mircea.Markus@jboss.com

Field Summary

Fields
Modifier and Type	Field and Description
`protected ChannelFactory`	`channelFactory`
`static String`	`DEFAULT_CACHE_NAME`
`static String`	`HOTROD_CLIENT_PROPERTIES`
`static String`	`JSON_STRING_ARRAY_ELEMENT_REGEX`
`protected ClientListenerNotifier`	`listenerNotifier`

Constructor Summary

Constructors
Constructor and Description
`RemoteCacheManager()` Same as `RemoteCacheManager(boolean)` and it also starts the cache.
`RemoteCacheManager(boolean start)` Same as `RemoteCacheManager(java.util.Properties)`, but it will try to lookup the config properties in the classpath, in a file named `hotrod-client.properties`.
`RemoteCacheManager(Configuration configuration)` Create a new RemoteCacheManager using the supplied `Configuration`.
`RemoteCacheManager(Configuration configuration, boolean start)` Create a new RemoteCacheManager using the supplied `Configuration`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RemoteCacheManagerAdmin`	`administration()`
`static byte[]`	`cacheNameBytes()`
`static byte[]`	`cacheNameBytes(String cacheName)`
`void`	`close()`
`protected <K,V> NearCacheService<K,V>`	`createNearCacheService(NearCacheConfiguration cfg)`
`<K,V> RemoteCache<K,V>`	`getCache()` Retrieves the default cache from the remote server.
`<K,V> RemoteCache<K,V>`	`getCache(boolean forceReturnValue)`
`<K,V> RemoteCache<K,V>`	`getCache(String cacheName)` Retrieves a named cache from the remote server if the cache has been defined, otherwise if the cache name is undefined, it will return null.
`<K,V> RemoteCache<K,V>`	`getCache(String cacheName, boolean forceReturnValue)`
`Set<String>`	`getCacheNames()` This method returns a collection of caches names which contains the caches that have been defined via XML or programmatically, and the caches that have been created at runtime via this cache manager instance.
`ChannelFactory`	`getChannelFactory()` This method is not a part of the public API.
`Codec`	`getCodec()` This method is not a part of the public API.
`Configuration`	`getConfiguration()` Retrieves the configuration currently in use.
`Marshaller`	`getMarshaller()`
`boolean`	`isStarted()`
`void`	`start()` Invoked on component start
`CompletableFuture<Void>`	`startAsync()`
`void`	`stop()` Stop the remote cache manager, disconnecting all existing connections.
`CompletableFuture<Void>`	`stopAsync()`
`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_CACHE_NAME
```
public static final String DEFAULT_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - HOTROD_CLIENT_PROPERTIES
```
public static final String HOTROD_CLIENT_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - JSON_STRING_ARRAY_ELEMENT_REGEX
```
public static final String JSON_STRING_ARRAY_ELEMENT_REGEX
```
    See Also:
    
    Constant Field Values
  - channelFactory
```
protected ChannelFactory channelFactory
```
  - listenerNotifier
```
protected ClientListenerNotifier listenerNotifier
```
- Constructor Detail
  - RemoteCacheManager
```
public RemoteCacheManager(Configuration configuration)
```
    Create a new RemoteCacheManager using the supplied Configuration. The RemoteCacheManager will be started automatically
    
    Parameters:
    
    configuration - the configuration to use for this RemoteCacheManager
    
    Since:
    
    5.3
  - RemoteCacheManager
```
public RemoteCacheManager(Configuration configuration,
                          boolean start)
```
    Create a new RemoteCacheManager using the supplied Configuration. The RemoteCacheManager will be started automatically only if the start parameter is true
    
    Parameters:
    
    configuration - the configuration to use for this RemoteCacheManager
    
    start - whether or not to start the manager on return from the constructor.
    
    Since:
    
    5.3
  - RemoteCacheManager
```
public RemoteCacheManager(boolean start)
```
    Same as RemoteCacheManager(java.util.Properties), but it will try to lookup the config properties in the classpath, in a file named hotrod-client.properties. If no properties can be found in the classpath, the server tries to connect to "127.0.0.1:11222" in start.
    
    Parameters:
    
    start - whether or not to start the RemoteCacheManager
    
    Throws:
    
    HotRodClientException - if such a file cannot be found in the classpath
  - RemoteCacheManager
```
public RemoteCacheManager()
```
    Same as RemoteCacheManager(boolean) and it also starts the cache.
- Method Detail
  - getConfiguration
```
public Configuration getConfiguration()
```
    Description copied from interface: RemoteCacheContainer
    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());
 
```
    Specified by:
    
    getConfiguration in interface RemoteCacheContainer
    
    Returns:
    
    The configuration of this RemoteCacheManager
    
    Since:
    
    5.3
  - getCache
```
public <K,V> RemoteCache<K,V> getCache(String cacheName)
```
    Retrieves a named cache from the remote server if the cache has been defined, otherwise if the cache name is undefined, it will return null.
    
    Specified by:
    
    getCache in interface BasicCacheContainer
    
    Parameters:
    
    cacheName - name of cache to retrieve
    
    Returns:
    
    a cache instance identified by cacheName or null if the cache name has not been defined
  - getCacheNames
```
public Set<String> getCacheNames()
```
    Description copied from interface: BasicCacheContainer
    
    This method returns a collection of caches names which contains the caches that have been defined via XML or programmatically, and the caches that have been created at runtime via this cache manager instance. If no named caches are registered or no caches have been created, this method returns an empty set. The list of caches does not include internal-only caches InternalCacheRegistry
    
    Specified by:
    
    getCacheNames in interface BasicCacheContainer
    
    Returns:
    
    an immutable set of caches registered or created with this cache manager.
  - getCache
```
public <K,V> RemoteCache<K,V> getCache(String cacheName,
                                       boolean forceReturnValue)
```
    Specified by:
    
    getCache in interface RemoteCacheContainer
  - getCache
```
public <K,V> RemoteCache<K,V> getCache()
```
    Retrieves the default cache from the remote server.
    
    Specified by:
    
    getCache in interface BasicCacheContainer
    
    Returns:
    
    a remote cache instance that can be used to send requests to the default cache in the server
  - getCache
```
public <K,V> RemoteCache<K,V> getCache(boolean forceReturnValue)
```
    Specified by:
    
    getCache in interface RemoteCacheContainer
  - startAsync
```
public CompletableFuture<Void> startAsync()
```
  - stopAsync
```
public CompletableFuture<Void> stopAsync()
```
  - start
```
public void start()
```
    Description copied from interface: Lifecycle
    
    Invoked on component start
    
    Specified by:
    
    start in interface Lifecycle
  - stop
```
public void stop()
```
    Stop the remote cache manager, disconnecting all existing connections. As part of the disconnection, all registered client cache listeners will be removed since client no longer can receive callbacks.
    
    Specified by:
    
    stop in interface Lifecycle
  - isStarted
```
public boolean isStarted()
```
    Specified by:
    
    isStarted in interface RemoteCacheContainer
  - switchToCluster
```
public boolean switchToCluster(String clusterName)
```
    Description copied from interface: RemoteCacheContainer
    
    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.
    
    Specified by:
    
    switchToCluster in interface RemoteCacheContainer
    
    Parameters:
    
    clusterName - name of the cluster to which to switch to
    
    Returns:
    
    true if the cluster was switched, false otherwise
  - switchToDefaultCluster
```
public boolean switchToDefaultCluster()
```
    Description copied from interface: RemoteCacheContainer
    
    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.
    
    Specified by:
    
    switchToDefaultCluster in interface RemoteCacheContainer
    
    Returns:
    
    true if the cluster was switched, false otherwise
  - createNearCacheService
```
protected <K,V> NearCacheService<K,V> createNearCacheService(NearCacheConfiguration cfg)
```
  - getMarshaller
```
public Marshaller getMarshaller()
```
    Specified by:
    
    getMarshaller in interface RemoteCacheContainer
  - cacheNameBytes
```
public static byte[] cacheNameBytes(String cacheName)
```
  - cacheNameBytes
```
public static byte[] cacheNameBytes()
```
  - administration
```
public RemoteCacheManagerAdmin administration()
```
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - getCodec
```
public Codec getCodec()
```
    This method is not a part of the public API. It is exposed for internal purposes only.
  - getChannelFactory
```
public ChannelFactory getChannelFactory()
```
    This method is not a part of the public API. It is exposed for internal purposes only.

Class RemoteCacheManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CACHE_NAME

HOTROD_CLIENT_PROPERTIES

JSON_STRING_ARRAY_ELEMENT_REGEX

channelFactory

listenerNotifier

Constructor Detail

RemoteCacheManager

RemoteCacheManager

RemoteCacheManager

RemoteCacheManager

Method Detail

getConfiguration

getCache

getCacheNames

getCache

getCache

getCache

startAsync

stopAsync

start

stop

isStarted

switchToCluster

switchToDefaultCluster

createNearCacheService

getMarshaller

cacheNameBytes

cacheNameBytes

administration

close

getCodec

getChannelFactory