2.3. Using the Batching API
2.3.1. Enable the Batching API (Remote Client-Server Mode)
Red Hat JBoss Data Grid's Batching API uses the JBoss Enterprise Application Platform syntax to enable invocation batching in your cache configuration.
Example 2.2. Enable Invocation Batching
<distributed-cache name="default" batching="true" statistics="true"> <!-- Additional configuration information here --> </distributed-cache>
In JBoss Data Grid, invocation batching is disabled by default and batching can be used without a defined Transaction Manager.
2.3.2. Configure the Batching API
To use the Batching API, enable invocation batching in the cache configuration.
XML Configuration
To configure the Batching API in the XML file, the transactionMode must be TRANSACTIONAL to enable invocationBatching:
<transaction transactionMode="TRANSACTIONAL"> <invocationBatching enabled="true" />
Programmatic Configuration
To configure the Batching API programmatically use:
Configuration c = new ConfigurationBuilder().invocationBatching().enable().build();
In Red Hat JBoss Data Grid, invocation batching is disabled by default and batching can be used without a defined Transaction Manager.
Note
Programmatic configurations can only be used with JBoss Data Grid's Library mode.
2.3.3. Use the Batching API
After the cache is configured to use batching, call
startBatch() and endBatch() on the cache as follows to use batching:
Cache cache = cacheManager.getCache();
Example 2.3. Without Using Batch
cache.put("key", "value");
When the
cache.put(key, value); line executes, the values are replaced immediately.
Example 2.4. Using Batch
cache.startBatch();
cache.put("k1", "value");
cache.put("k2", "value");
cache.put("k3", "value");
cache.endBatch(true);
cache.startBatch();
cache.put("k1", "value");
cache.put("k2", "value");
cache.put("k3", "value");
cache.endBatch(false);
When the line
cache.endBatch(true); executes, all modifications made since the batch started are replicated.
When the line
cache.endBatch(false); executes, changes made in the batch are discarded.
2.3.4. Batching API Usage Example
A simple use case that illustrates the Batching API usage is one that involves transferring money between two bank accounts.
Example 2.5. Batching API Usage Example
Red Hat JBoss Data Grid is used for a transaction that involves transferring money from one bank account to another. If both the source and destination bank accounts are located within JBoss Data Grid, a Batching API is used for this transaction. However, if one account is located within JBoss Data Grid and the other in a database, distributed transactions are required for the transaction.
