Package org.infinispan.configuration.cache

Class TransactionConfiguration

  • All Implemented Interfaces:
    org.infinispan.commons.configuration.attributes.Matchable<TransactionConfiguration>, org.infinispan.commons.configuration.attributes.Updatable<TransactionConfiguration>
    public class TransactionConfiguration
extends org.infinispan.commons.configuration.attributes.ConfigurationElement<TransactionConfiguration>
    Defines transactional (JTA) characteristics of the cache.
    Author:
    pmuir, Pedro Ruivo

    • Field Detail

      • AUTO_COMMIT

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean> AUTO_COMMIT

      • CACHE_STOP_TIMEOUT

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Long> CACHE_STOP_TIMEOUT

      • LOCKING_MODE

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<LockingMode> LOCKING_MODE

      • TRANSACTION_MANAGER_LOOKUP

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<org.infinispan.commons.tx.lookup.TransactionManagerLookup> TRANSACTION_MANAGER_LOOKUP

      • TRANSACTION_SYNCHRONIZATION_REGISTRY_LOOKUP

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<org.infinispan.transaction.lookup.TransactionSynchronizationRegistryLookup> TRANSACTION_SYNCHRONIZATION_REGISTRY_LOOKUP

      • TRANSACTION_MODE

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<TransactionMode> TRANSACTION_MODE

      • USE_SYNCHRONIZATION

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean> USE_SYNCHRONIZATION

      • USE_1_PC_FOR_AUTO_COMMIT_TRANSACTIONS

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean> USE_1_PC_FOR_AUTO_COMMIT_TRANSACTIONS

      • REAPER_WAKE_UP_INTERVAL

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Long> REAPER_WAKE_UP_INTERVAL

      • COMPLETED_TX_TIMEOUT

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Long> COMPLETED_TX_TIMEOUT

      • NOTIFICATIONS

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean> NOTIFICATIONS

    • Method Detail

      • autoCommit

        public boolean autoCommit()
        If the cache is transactional (i.e. transactionMode() == TransactionMode.TRANSACTIONAL) and transactionAutoCommit is enabled then for single operation transactions the user doesn't need to manually start a transaction, but a transactions is injected by the system. Defaults to true.

      • cacheStopTimeout

        public TransactionConfiguration cacheStopTimeout​(long l)
        If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout. It is recommended that this value does not exceed the transaction timeout because even if a new transaction was started just before the cache was stopped, this could only last as long as the transaction timeout allows it.

      • cacheStopTimeout

        public long cacheStopTimeout()
        If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout. It is recommended that this value does not exceed the transaction timeout because even if a new transaction was started just before the cache was stopped, this could only last as long as the transaction timeout allows it.

      • lockingMode

        public LockingMode lockingMode()
        Configures whether the cache uses optimistic or pessimistic locking. If the cache is not transactional then the locking mode is ignored.
        See Also:
        transactionMode()

      • transactionManagerLookup

        public org.infinispan.commons.tx.lookup.TransactionManagerLookup transactionManagerLookup()
        Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

      • transactionSynchronizationRegistryLookup

        public org.infinispan.transaction.lookup.TransactionSynchronizationRegistryLookup transactionSynchronizationRegistryLookup()
        Configure Transaction Synchronization Registry lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

      • useSynchronization

        public boolean useSynchronization()

      • use1PcForAutoCommitTransactions

        public boolean use1PcForAutoCommitTransactions()
        Before Infinispan 5.1 you could access the cache both transactionally and non-transactionally. Naturally the non-transactional access is faster and offers less consistency guarantees. From Infinispan 5.1 onwards, mixed access is no longer supported, so if you wanna speed up transactional caches and you're ready to trade some consistency guarantees, you can enable use1PcForAutoCommitTransactions.

        What this configuration option does is force an induced transaction, that has been started by Infinispan as a result of enabling autoCommit, to commit in a single phase. So only 1 RPC instead of 2RPCs as in the case of a full 2 Phase Commit (2PC).

        N.B. this option should NOT be used when modifying the same key from multiple transactions as 1PC does not offer any consistency guarantees under concurrent access.