org.apache.ignite.configuration

Class TransactionConfiguration

java.lang.Object

org.apache.ignite.configuration.TransactionConfiguration

All Implemented Interfaces:

Serializable

public class TransactionConfiguration
extends Object
implements Serializable

Transactions configuration.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DFLT_PESSIMISTIC_TX_LOG_LINGER Default size of pessimistic transactions log.
static long	DFLT_TRANSACTION_TIMEOUT Default transaction timeout.
static TransactionConcurrency	DFLT_TX_CONCURRENCY Default concurrency mode.
static TransactionIsolation	DFLT_TX_ISOLATION Default transaction isolation level.
static boolean	DFLT_TX_SERIALIZABLE_ENABLED Default value for 'txSerializableEnabled' flag.

Constructor Summary

Constructors

Constructor and Description
TransactionConfiguration() Empty constructor.
TransactionConfiguration(TransactionConfiguration cfg)

Method Summary

Methods

Modifier and Type	Method and Description
TransactionConcurrency	getDefaultTxConcurrency() Default cache transaction concurrency to use when one is not explicitly specified.
TransactionIsolation	getDefaultTxIsolation() Default cache transaction isolation to use when one is not explicitly specified.
long	getDefaultTxTimeout() Gets default transaction timeout.
int	getPessimisticTxLogLinger() Gets delay, in milliseconds, after which pessimistic recovery entries will be cleaned up for failed node.
int	getPessimisticTxLogSize() Gets size of pessimistic transactions log stored on node in order to recover transaction commit if originating node has left grid before it has sent all messages to transaction nodes.
<T> javax.cache.configuration.Factory<T>	getTxManagerFactory() Gets transaction manager factory for integration with JEE app servers.
String	getTxManagerLookupClassName() Deprecated. Use getTxManagerFactory() instead.
boolean	isTxSerializableEnabled() Deprecated.
void	setDefaultTxConcurrency(TransactionConcurrency dfltConcurrency) Sets default transaction concurrency.
void	setDefaultTxIsolation(TransactionIsolation dfltIsolation) Sets default transaction isolation.
void	setDefaultTxTimeout(long dfltTxTimeout) Sets default transaction timeout in milliseconds.
void	setPessimisticTxLogLinger(int pessimisticTxLogLinger) Sets cleanup delay for pessimistic transaction recovery log for failed node, in milliseconds.
void	setPessimisticTxLogSize(int pessimisticTxLogSize) Sets pessimistic transactions log size.
<T> void	setTxManagerFactory(javax.cache.configuration.Factory<T> factory) Sets transaction manager factory for available javax.transaction.TransactionManager implementation, if any.
void	setTxManagerLookupClassName(String tmLookupClsName) Deprecated. Use setTxManagerFactory(Factory) instead.
void	setTxSerializableEnabled(boolean txSerEnabled) Deprecated. This method has no effect, TransactionIsolation.SERIALIZABLE isolation is always enabled.

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_TX_SERIALIZABLE_ENABLED

public static final boolean DFLT_TX_SERIALIZABLE_ENABLED

Default value for 'txSerializableEnabled' flag.

See Also:

Constant Field Values

DFLT_TX_CONCURRENCY

public static final TransactionConcurrency DFLT_TX_CONCURRENCY

Default concurrency mode.

DFLT_TX_ISOLATION

public static final TransactionIsolation DFLT_TX_ISOLATION

Default transaction isolation level.

DFLT_TRANSACTION_TIMEOUT

public static final long DFLT_TRANSACTION_TIMEOUT

Default transaction timeout.

See Also:

Constant Field Values

DFLT_PESSIMISTIC_TX_LOG_LINGER

public static final int DFLT_PESSIMISTIC_TX_LOG_LINGER

Default size of pessimistic transactions log.

See Also:

Constant Field Values

Constructor Detail

TransactionConfiguration

public TransactionConfiguration()

Empty constructor.

TransactionConfiguration

public TransactionConfiguration(TransactionConfiguration cfg)

Parameters:

cfg - Configuration to copy.

Method Detail

isTxSerializableEnabled

@Deprecated
public boolean isTxSerializableEnabled()

Deprecated.

Gets flag to enable/disable TransactionIsolation.SERIALIZABLE isolation level for cache transactions. Serializable level does carry certain overhead and if not used, should be disabled. Default value is false.

Returns:

True if serializable transactions are enabled, false otherwise.

setTxSerializableEnabled

@Deprecated
public void setTxSerializableEnabled(boolean txSerEnabled)

Deprecated. This method has no effect, TransactionIsolation.SERIALIZABLE isolation is always enabled.

Parameters:

txSerEnabled - Flag to enable/disable serializable cache transactions.

getDefaultTxConcurrency

public TransactionConcurrency getDefaultTxConcurrency()

Default cache transaction concurrency to use when one is not explicitly specified. Default value is defined by DFLT_TX_CONCURRENCY.

Returns:

Default cache transaction concurrency.

See Also:

Transaction

setDefaultTxConcurrency

public void setDefaultTxConcurrency(TransactionConcurrency dfltConcurrency)

Sets default transaction concurrency.

Parameters:

dfltConcurrency - Default cache transaction concurrency.

getDefaultTxIsolation

public TransactionIsolation getDefaultTxIsolation()

Default cache transaction isolation to use when one is not explicitly specified. Default value is defined by DFLT_TX_ISOLATION.

Returns:

Default cache transaction isolation.

See Also:

Transaction

setDefaultTxIsolation

public void setDefaultTxIsolation(TransactionIsolation dfltIsolation)

Sets default transaction isolation.

Parameters:

dfltIsolation - Default cache transaction isolation.

getDefaultTxTimeout

public long getDefaultTxTimeout()

Gets default transaction timeout. Default value is defined by DFLT_TRANSACTION_TIMEOUT which is 0 and means that transactions will never time out.

Returns:

Default transaction timeout.

setDefaultTxTimeout

public void setDefaultTxTimeout(long dfltTxTimeout)

Sets default transaction timeout in milliseconds. By default this value is defined by DFLT_TRANSACTION_TIMEOUT.

Parameters:

dfltTxTimeout - Default transaction timeout.

getPessimisticTxLogSize

public int getPessimisticTxLogSize()

Gets size of pessimistic transactions log stored on node in order to recover transaction commit if originating node has left grid before it has sent all messages to transaction nodes.

If not set, default value is 0 which means unlimited log size.

Returns:

Pessimistic transaction log size.

setPessimisticTxLogSize

public void setPessimisticTxLogSize(int pessimisticTxLogSize)

Sets pessimistic transactions log size.

Parameters:

pessimisticTxLogSize - Pessimistic transactions log size.

See Also:

getPessimisticTxLogSize()

getPessimisticTxLogLinger

public int getPessimisticTxLogLinger()

Gets delay, in milliseconds, after which pessimistic recovery entries will be cleaned up for failed node.

If not set, default value is DFLT_PESSIMISTIC_TX_LOG_LINGER.

Returns:

Pessimistic log cleanup delay in milliseconds.

setPessimisticTxLogLinger

public void setPessimisticTxLogLinger(int pessimisticTxLogLinger)

Sets cleanup delay for pessimistic transaction recovery log for failed node, in milliseconds.

Parameters:

pessimisticTxLogLinger - Pessimistic log cleanup delay.

See Also:

getPessimisticTxLogLinger()

getTxManagerLookupClassName

@Deprecated
public String getTxManagerLookupClassName()

Deprecated. Use getTxManagerFactory() instead.

Gets class name of transaction manager finder for integration for JEE app servers.

Returns:

Transaction manager finder.

setTxManagerLookupClassName

@Deprecated
public void setTxManagerLookupClassName(String tmLookupClsName)

Deprecated. Use setTxManagerFactory(Factory) instead.

Sets look up mechanism for available TransactionManager implementation, if any.

Parameters:

tmLookupClsName - Name of class implementing GridCacheTmLookup interface that is used to receive JTA transaction manager.

getTxManagerFactory

public <T> javax.cache.configuration.Factory<T> getTxManagerFactory()

Gets transaction manager factory for integration with JEE app servers.

Type Parameters:

T - Instance of javax.transaction.TransactionManager.

Returns:

Transaction manager factory.

setTxManagerFactory

public <T> void setTxManagerFactory(javax.cache.configuration.Factory<T> factory)

Sets transaction manager factory for available javax.transaction.TransactionManager implementation, if any.

It allows to use different transactional systems. Implement factory that produce native javax.transaction.TransactionManager within your environment.

The following implementations are provided out of the box (jta module must be enabled):

• org.apache.ignite.cache.jta.jndi.CacheJndiTmFactory utilizes configured JNDI names to look up a transaction manager.

Ignite will throw IgniteCheckedException if Factory.create() method throws any exception, returns null-value or returns non-TransactionManager instance.

Type Parameters:

T - Instance of javax.transaction.TransactionManager.

Parameters:

factory - Transaction manager factory.