23.2. Configure Transactions

Procedure 23.1. Configure Transactions in Library Mode (XML Configuration)

1. Set the Transaction Mode

   See the table below this procedure for a list of available lookup classes.

   <namedCache ...>
   	<transaction transactionMode="{TRANSACTIONAL,NON_TRANSACTIONAL}">
           ...
   </namedCache>
   

2. Configure the Transaction Manager

   The transactionMode element configures whether or not the cache is transactional.

   <namedCache ...>
   	<transaction transactionMode="TRANSACTIONAL"
   		     transactionManagerLookupClass="{TransactionManagerLookupClass}">
   </namedCache>
   

3. Configure Locking Mode

   The lockingMode parameter determines if the optimistic or pessimistic locking method is used. If the cache is non-transactional, the locking mode is ignored. The default value for this parameter is OPTIMISTIC.

   <namedCache ...>
   	<transaction transactionMode="TRANSACTIONAL"
   		     transactionManagerLookupClass="{TransactionManagerLookupClass}"
   		     lockingMode="{OPTIMISTIC,PESSIMISTIC}">
   </namedCache>
   

4. Specify Synchronization

   The useSynchronization element configures the cache to register a synchronization with the transaction manager, or register itself as an XA resource. The default value for this element is true (use synchronization).

   <namedCache ...>
   	<transaction transactionMode="TRANSACTIONAL"
   		     transactionManagerLookupClass="{TransactionManagerLookupClass}"
   		     lockingMode="{OPTIMISTIC,PESSIMISTIC}"
   		     useSynchronization="{true,false}">
   </namedCache>
   

5. Configure Recovery

   The recovery element enables recovery for the cache when set to true.
   The recoveryInfoCacheName parameter sets the name of the cache where recovery information is held. The default name of the cache is __recoveryInfoCacheName__.

   <namedCache ...>
   	<transaction transactionMode="TRANSACTIONAL"
   		     transactionManagerLookupClass="{TransactionManagerLookupClass}"
   		     lockingMode="{OPTIMISTIC,PESSIMISTIC}"
   		     useSynchronization="{true,false}">
   		<recovery enabled="true" 
   			  recoveryInfoCacheName="{CacheName}" />
   </namedCache>
   

6. Configure the Write Skew Check

   The writeSkew check determines if a modification to the entry from a different transaction should roll back the transaction. Write skew set to true requires isolation_level set to REPEATABLE_READ. The default value for writeSkew and isolation_level are false and READ_COMMITTED respectively.

   <namedCache ...>   
   	<transaction ...>
   	<locking isolation_level="{READ_COMMITTED,REPEATABLE_READ}" 
   	 	 writeSkew="{true,false}" />
           ...
   </namedCache>
   

7. Configure Entry Versioning

   For clustered caches, enable write skew check by enabling entry versioning and setting its value to SIMPLE.

   <namedCache ...>
   	<transaction ...>
   	<locking ...>
   	<versioning enabled="{true,false}" 
   		    versioningScheme="{NONE|SIMPLE}"/>
           ...
   </namedCache>
   

Procedure 23.2. Configure Transactions in Library Mode (Programmatic Configuration)

1. Set the Transaction Mode

   Set the transaction mode as follows:

   Configuration config = new ConfigurationBuilder()/* ... */.transaction()
           .transactionMode(TransactionMode.TRANSACTIONAL);
   

2. Configure the Transaction Manager

   See the table below this procedure for a list of available lookup classes.

   Configuration config = new ConfigurationBuilder()/* ... */.transaction()
           .transactionMode(TransactionMode.TRANSACTIONAL)
           .transactionManagerLookup(new GenericTransactionManagerLookup());
   

3. Configure Locking Mode

   The lockingMode value determines whether optimistic or pessimistic locking is used. If the cache is non-transactional, the locking mode is ignored. The default value is OPTIMISTIC.

   Configuration config = new ConfigurationBuilder()/* ... */.transaction()
           .transactionMode(TransactionMode.TRANSACTIONAL)
           .transactionManagerLookup(new GenericTransactionManagerLookup());
           .lockingMode(LockingMode.OPTIMISTIC);
   

4. Specify Synchronization

   The useSynchronization value configures the cache to register a synchronization with the transaction manager, or register itself as an XA resource. The default value is true (use synchronization).

   Configuration config = new ConfigurationBuilder()/* ... */.transaction()
           .transactionMode(TransactionMode.TRANSACTIONAL)
           .transactionManagerLookup(new GenericTransactionManagerLookup());
           .lockingMode(LockingMode.OPTIMISTIC)
           .useSynchronization(true);
   

5. Configure Recovery

   The recovery parameter enables recovery for the cache when set to true.
   The recoveryInfoCacheName sets the name of the cache where recovery information is held. The default name of the cache is specified by RecoveryConfiguration.DEFAULT_RECOVERY_INFO_CACHE.

   Configuration config = new ConfigurationBuilder()/* ... */.transaction()
           .transactionMode(TransactionMode.TRANSACTIONAL)
           .transactionManagerLookup(new GenericTransactionManagerLookup());
           .lockingMode(LockingMode.OPTIMISTIC)
           .useSynchronization(true)
           .recovery()
               .recoveryInfoCacheName("anotherRecoveryCacheName");
   

6. Configure Write Skew Check

   The writeSkew check determines if a modification to the entry from a different transaction should roll back the transaction. Write skew set to true requires isolation_level set to REPEATABLE_READ. The default value for writeSkew and isolation_level are false and READ_COMMITTED respectively.

   Configuration config = new ConfigurationBuilder()/* ... */.locking()
           .isolationLevel(IsolationLevel.REPEATABLE_READ).writeSkewCheck(true);
   

7. Configure Entry Versioning

   For clustered caches, enable write skew check by enabling entry versioning and setting its value to SIMPLE.

   Configuration config = new ConfigurationBuilder()/* ... */.versioning()
           .enable()
           .scheme(VersioningScheme.SIMPLE);