Class RemoteCacheManager

    • Field Detail

      • channelFactory

        protected org.infinispan.client.hotrod.impl.transport.netty.ChannelFactory channelFactory
    • 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​(String uri)
        Create a new RemoteCacheManager using the supplied URI. The RemoteCacheManager will be started automatically
        Parameters:
        uri - the URI to use for this RemoteCacheManager
        Since:
        11.0
      • RemoteCacheManager

        public RemoteCacheManager​(URI uri)
        Create a new RemoteCacheManager using the supplied URI. The RemoteCacheManager will be started automatically
        Parameters:
        uri - the URI to use for this RemoteCacheManager
        Since:
        11.0
      • 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)

        Similar to RemoteCacheManager(Configuration, boolean), 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, defaults will be used, attempting to connect to 127.0.0.1:11222

        Refer to ConfigurationBuilder for a detailed list of available properties.

        Parameters:
        start - whether or not to start the RemoteCacheManager
        Throws:
        HotRodClientException - if such a file cannot be found in the classpath
    • 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
      • getCacheNames

        public Set<String> getCacheNames()
        Description copied from interface: BasicCacheContainer
        This method returns a collection of all cache names.

        The configurations may have been defined via XML, in the programmatic configuration, or at runtime.

        Internal-only caches are not included.

        Specified by:
        getCacheNames in interface BasicCacheContainer
        Returns:
        an immutable set of cache names registered in this cache manager.
      • getCache

        public <K,​V> RemoteCache<K,​V> getCache​(String cacheName,
                                                           TransactionMode transactionMode,
                                                           javax.transaction.TransactionManager transactionManager)
        Specified by:
        getCache in interface RemoteCacheContainer
        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

        public <K,​V> RemoteCache<K,​V> getCache​(String cacheName,
                                                           boolean forceReturnValue,
                                                           TransactionMode transactionMode,
                                                           javax.transaction.TransactionManager transactionManager)
        Specified by:
        getCache in interface RemoteCacheContainer
        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.
      • start

        public void start()
        Description copied from interface: Lifecycle
        Invoked on component start
        Specified by:
        start in interface Lifecycle
      • createChannelFactory

        public org.infinispan.client.hotrod.impl.transport.netty.ChannelFactory createChannelFactory()
      • isTransactional

        public boolean isTransactional​(String cacheName)
        Specified by:
        isTransactional in interface RemoteCacheContainer
        Returns:
        true if the cache with name cacheName can participate in transactions.
      • 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
      • 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
        Specified by:
        switchToCluster in interface RemoteCacheManagerMXBean
        Parameters:
        clusterName - name of the cluster to which to switch to
        Returns:
        true if the cluster was switched, false otherwise
      • cacheNameBytes

        public static byte[] cacheNameBytes​(String cacheName)
      • cacheNameBytes

        public static byte[] cacheNameBytes()
      • administration

        public RemoteCacheManagerAdmin administration()
        Access to administration operations (cache creation, removal, etc)
        Returns:
        an instance of RemoteCacheManagerAdmin which can perform administrative operations on the server.
      • getCodec

        public org.infinispan.client.hotrod.impl.protocol.Codec getCodec()
        This method is not a part of the public API. It is exposed for internal purposes only.
      • getChannelFactory

        public org.infinispan.client.hotrod.impl.transport.netty.ChannelFactory getChannelFactory()
        This method is not a part of the public API. It is exposed for internal purposes only.
      • getXaResource

        public XAResource getXaResource()
        Returns the XAResource which can be used to do transactional recovery.
        Returns:
        An instance of XAResource
      • getAsyncExecutorService

        public ExecutorService getAsyncExecutorService()