Package org.infinispan.configuration.cache

Class TransactionConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.TransactionConfigurationBuilder

All Implemented Interfaces:

Builder<TransactionConfiguration>, ConfigurationChildBuilder

public class TransactionConfigurationBuilder
extends Object
implements Builder<TransactionConfiguration>

Defines transactional (JTA) characteristics of the cache.

Author:

pmuir, Pedro Ruivo

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConfigurationBuilder	builder

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
TransactionConfigurationBuilder	autoCommit(boolean b)	If the cache is transactional (i.e.
Configuration	build()
TransactionConfigurationBuilder	cacheStopTimeout(long l)	If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish.
TransactionConfigurationBuilder	cacheStopTimeout(long l, TimeUnit unit)	If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish.
ClusteringConfigurationBuilder	clustering()
TransactionConfigurationBuilder	completedTxTimeout(long timeout)	The duration (millis) in which to keep information about the completion of a transaction.
TransactionConfiguration	create()	Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()	Deprecated, for removal: This API element is subject to removal in a future version. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
LockingConfigurationBuilder	locking()
TransactionConfigurationBuilder	lockingMode(LockingMode lockingMode)	Configures whether the cache uses optimistic or pessimistic locking.
MemoryConfigurationBuilder	memory()
TransactionConfigurationBuilder	notifications(boolean enabled)
PersistenceConfigurationBuilder	persistence()
QueryConfigurationBuilder	query()
TransactionConfigurationBuilder	read(TransactionConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
TransactionConfigurationBuilder	reaperWakeUpInterval(long interval)	The time interval (millis) at which the thread that cleans up transaction completion information kicks in.
RecoveryConfigurationBuilder	recovery()	This method allows configuration of the transaction recovery cache.
SecurityConfigurationBuilder	security()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
StatisticsConfigurationBuilder	statistics()
ConfigurationChildBuilder	template(boolean template)
String	toString()
TransactionConfigurationBuilder	transaction()
TransactionManagerLookup	transactionManagerLookup()
TransactionConfigurationBuilder	transactionManagerLookup(TransactionManagerLookup tml)	Configure Transaction manager lookup directly using an instance of TransactionManagerLookup.
TransactionMode	transactionMode()
TransactionConfigurationBuilder	transactionMode(TransactionMode transactionMode)
TransactionConfigurationBuilder	transactionSynchronizationRegistryLookup(TransactionSynchronizationRegistryLookup lookup)	Configure Transaction Synchronization Registry lookup directly using an instance of TransactionManagerLookup.
UnsafeConfigurationBuilder	unsafe()
boolean	use1PcForAutoCommitTransactions()
TransactionConfigurationBuilder	use1PcForAutoCommitTransactions(boolean b)	Before Infinispan 5.1 you could access the cache both transactionally and non-transactionally.
TransactionConfigurationBuilder	useSynchronization(boolean b)	Configures whether the cache registers a synchronization with the transaction manager, or registers itself as an XA resource.
void	validate()	Validate the data in this builder before building the configuration bean
void	validate(GlobalConfiguration globalConfig)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.commons.configuration.Builder

read, reset

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

jmxStatistics

Field Details

builder

protected final ConfigurationBuilder builder

Method Details

autoCommit

public TransactionConfigurationBuilder autoCommit(boolean b)

If the cache is transactional (i.e. transactionMode(org.infinispan.transaction.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 TransactionConfigurationBuilder 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.

This configuration property may be adjusted at runtime

cacheStopTimeout

public TransactionConfigurationBuilder cacheStopTimeout(long l,
 TimeUnit unit)

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.

This configuration property may be adjusted at runtime

lockingMode

public TransactionConfigurationBuilder lockingMode(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:

• TransactionConfiguration.transactionMode()

transactionManagerLookup

public TransactionConfigurationBuilder transactionManagerLookup(TransactionManagerLookup tml)

Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

transactionManagerLookup

public TransactionManagerLookup transactionManagerLookup()

transactionSynchronizationRegistryLookup

public TransactionConfigurationBuilder transactionSynchronizationRegistryLookup(TransactionSynchronizationRegistryLookup lookup)

Configure Transaction Synchronization Registry lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

transactionMode

public TransactionConfigurationBuilder transactionMode(TransactionMode transactionMode)

transactionMode

public TransactionMode transactionMode()

useSynchronization

public TransactionConfigurationBuilder useSynchronization(boolean b)

Configures whether the cache registers a synchronization with the transaction manager, or registers itself as an XA resource. It is often unnecessary to register as a full XA resource unless you intend to make use of recovery as well, and registering a synchronization is significantly more efficient.

Parameters:

b - if true, Synchronizations are used rather than XAResources when communicating with a TransactionManager.

recovery

public RecoveryConfigurationBuilder recovery()

This method allows configuration of the transaction recovery cache. When this method is called, it automatically enables recovery. So, if you want it to be disabled, make sure you call RecoveryConfigurationBuilder.disable() )}

use1PcForAutoCommitTransactions

public TransactionConfigurationBuilder use1PcForAutoCommitTransactions(boolean b)

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).

use1PcForAutoCommitTransactions

public boolean use1PcForAutoCommitTransactions()

reaperWakeUpInterval

public TransactionConfigurationBuilder reaperWakeUpInterval(long interval)

The time interval (millis) at which the thread that cleans up transaction completion information kicks in. Defaults to 30000.

completedTxTimeout

public TransactionConfigurationBuilder completedTxTimeout(long timeout)

The duration (millis) in which to keep information about the completion of a transaction. Defaults to 60000.

notifications

public TransactionConfigurationBuilder notifications(boolean enabled)

Returns:

are transactional notifications ( TransactionRegistered and TransactionCompleted) triggered?

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<TransactionConfiguration>

validate

public void validate()

Description copied from interface: Builder

Validate the data in this builder before building the configuration bean

Specified by:

validate in interface Builder<TransactionConfiguration>

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

create

public TransactionConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<TransactionConfiguration>

Returns:

read

public TransactionConfigurationBuilder read(TransactionConfiguration template,
 Combine combine)

Description copied from interface: Builder

Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration

Specified by:

read in interface Builder<TransactionConfiguration>

Parameters:

template - the configuration from which to "clone" this config if needed.

combine - the way attributes and children of this instance and the template should be combined.

toString

public String toString()

Overrides:

toString in class Object

template

public ConfigurationChildBuilder template(boolean template)

Specified by:

template in interface ConfigurationChildBuilder

simpleCache

public ConfigurationChildBuilder simpleCache(boolean simpleCache)

Specified by:

simpleCache in interface ConfigurationChildBuilder

simpleCache

public boolean simpleCache()

Specified by:

simpleCache in interface ConfigurationChildBuilder

clustering

public ClusteringConfigurationBuilder clustering()

Specified by:

clustering in interface ConfigurationChildBuilder

customInterceptors

@Deprecated(forRemoval=true)
public CustomInterceptorsConfigurationBuilder customInterceptors()

Deprecated, for removal: This API element is subject to removal in a future version.

Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors

Specified by:

customInterceptors in interface ConfigurationChildBuilder

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding in interface ConfigurationChildBuilder

expiration

public ExpirationConfigurationBuilder expiration()

Specified by:

expiration in interface ConfigurationChildBuilder

query

public QueryConfigurationBuilder query()

Specified by:

query in interface ConfigurationChildBuilder

indexing

public IndexingConfigurationBuilder indexing()

Specified by:

indexing in interface ConfigurationChildBuilder

invocationBatching

public InvocationBatchingConfigurationBuilder invocationBatching()

Specified by:

invocationBatching in interface ConfigurationChildBuilder

statistics

public StatisticsConfigurationBuilder statistics()

Specified by:

statistics in interface ConfigurationChildBuilder

persistence

public PersistenceConfigurationBuilder persistence()

Specified by:

persistence in interface ConfigurationChildBuilder

locking

public LockingConfigurationBuilder locking()

Specified by:

locking in interface ConfigurationChildBuilder

security

public SecurityConfigurationBuilder security()

Specified by:

security in interface ConfigurationChildBuilder

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites in interface ConfigurationChildBuilder

memory

public MemoryConfigurationBuilder memory()

Specified by:

memory in interface ConfigurationChildBuilder

getBuilder

protected ConfigurationBuilder getBuilder()

build

public Configuration build()

Specified by:

build in interface ConfigurationChildBuilder