Interface RemoteCacheContainer

    • Method Detail

      • 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

        <K,​V> RemoteCache<K,​V> getCache​(java.lang.String cacheName,
                                                    TransactionMode transactionMode,
                                                    javax.transaction.TransactionManager transactionManager)
        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

        <K,​V> RemoteCache<K,​V> getCache​(java.lang.String cacheName,
                                                    boolean forceReturnValue,
                                                    TransactionMode transactionMode,
                                                    javax.transaction.TransactionManager transactionManager)
        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​(java.lang.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