Chapter 5. The ConfigurationBuilder API

Procedure 5.1. Steps for Programmatic Configuration in JBoss Data Grid

1. Create a CacheManager as a starting point in an XML file. If required, this CacheManager can be programmed in runtime to the specification that meets the requirements of the use case. The following is an example of how to create a CacheManager:

   EmbeddedCacheManager manager = new DefaultCacheManager("my-config-file.xml");
   Cache defaultCache = manager.getCache();
   

2. Create a new synchronously replicated cache programmatically.
   1. Create a new configuration object instance using the ConfigurationBuilder helper object:

      Configuration c = new ConfigurationBuilder().clustering().cacheMode(CacheMode.REPL_SYNC)
      .build();
      

      In the first line of the configuration, a new cache configuration object (named c) is created using the ConfigurationBuilder. Configuration c is assigned the default values for all cache configuration options except the cache mode, which is overridden and set to synchronous replication (REPL_SYNC).
   2. Set the cache mode to synchronous replication:

      String newCacheName = "repl";
      

      In the second line of the configuration, a new variable (of type String) is created and assigned the value repl.
   3. Define or register the configuration with a manager:

      manager.defineConfiguration(newCacheName, c);
      

      In the third line of the configuration, the cache manager is used to define a named cache configuration for itself. This named cache configuration is called repl and its configuration is based on the configuration provided for cache configuration c in the first line.

   4. Cache<String, String> cache = manager.getCache(newCacheName);
      

      In the fourth line of the configuration, the cache manager is used to obtain a reference to the unique instance of the repl that is held by the cache manager. This cache instance is now ready to be used to perform operations to store and retrieve data.

Procedure 5.2. Customize the Default Cache

1. Read an instance of a default Configuration object to get the default configuration:

   EmbeddedCacheManager manager = new DefaultCacheManager("infinispan-config-file.xml");
   Configuration dcc = cacheManager.getDefaultCacheConfiguration();
   

2. Use the ConfigurationBuilder to construct and modify the cache mode and L1 cache lifespan on a new configuration object:

   Configuration c = new ConfigurationBuilder().read(dcc).clustering()
   .cacheMode(CacheMode.DIST_SYNC).l1().lifespan(60000L).enable()
   .build();
   

3. Register/define your cache configuration with a cache manager, where cacheName is name of cache specified in infinispan-config-file.xml:

   manager.defineConfiguration(newCacheName, c);
   

4. Get default cache with custom configuration changes:

   Cache<String, String> cache = manager.getCache(newCacheName);
   

Procedure 5.3. Create a Customized Cache Using a Non-Default Named Cache

1. Read the replicatedCache to get the default configuration:

   EmbeddedCacheManager manager = new DefaultCacheManager("infinispan-config-file.xml");
   Configuration rc = cacheManager.getCacheConfiguration("replicatedCache");
   

2. Use the ConfigurationBuilder to construct and modify the desired configuration on a new configuration object:

   Configuration c = new ConfigurationBuilder().read(rc).clustering()
   .cacheMode(CacheMode.DIST_SYNC).l1().lifespan(60000L).enable()
   .build();
   

3. Register/define your cache configuration with a cache manager where newCacheName is the name of cache specified in infinispan-config-file.xml

   manager.defineConfiguration(newCacheName, c);
   

4. Get a default cache with custom configuration changes:

   Cache<String, String> cache = manager.getCache(newCacheName);