org.springframework.data.gemfire.transaction

Class GemfireTransactionManager

java.lang.Object

org.springframework.transaction.support.AbstractPlatformTransactionManager

org.springframework.data.gemfire.transaction.GemfireTransactionManager

All Implemented Interfaces:

Serializable, InitializingBean, PlatformTransactionManager, ResourceTransactionManager, TransactionManager

public class GemfireTransactionManager
extends AbstractPlatformTransactionManager
implements InitializingBean, ResourceTransactionManager

Local Transaction Management for Pivotal GemFire. Provides a Spring PlatformTransactionManager implementation for the Pivotal GemFire CacheTransactionManager. Binds one or multiple GemFire Regions for the specified GemFireCache to the thread, potentially allowing for one Region per GemFireCache model.

This local strategy is an alternative to executing cache operations within JTA transactions. Its advantage is that is able to work in any environment, for example a stand-alone application or a test suite. It is not able to provide XA transactions, for example to share transactions with data access.

By default, to prevent dirty reads, the GemFireCache is configured to return copies rather then direct references for get data access operations. As a workaround, one could use explicitly deep copy objects before making changes to them to avoid unnecessary copying on every fetch.

Author:

Costin Leau, John Blum

See Also:

CopyHelper.copy(Object), GemFireCache.setCopyOnRead(boolean), CacheTransactionManager, Region, TransactionId, InitializingBean, PlatformTransactionManager, TransactionDefinition, AbstractPlatformTransactionManager, ResourceTransactionManager, TransactionSynchronizationManager, setCopyOnRead(boolean), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GemfireTransactionManager.CacheHolder Holder of GemFire cache transaction state.
protected static class	GemfireTransactionManager.CacheTransactionObject GemFire local cache transaction object.

Nested classes/interfaces inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager

AbstractPlatformTransactionManager.SuspendedResourcesHolder

Field Summary

Fields

Modifier and Type	Field and Description
protected static TimeUnit	DEFAULT_RESUME_WAIT_TIME_UNIT

Fields inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager

logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION

Constructor Summary

Constructors

Constructor and Description
GemfireTransactionManager() Constructs an instance of the GemfireTransactionManager.
GemfireTransactionManager(org.apache.geode.cache.GemFireCache cache) Constructs an instance of the GemfireTransactionManager initialized with the given GemFireCache reference.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected void	doBegin(Object transaction, TransactionDefinition definition)
protected void	doCleanupAfterCompletion(Object transaction)
protected void	doCommit(DefaultTransactionStatus status)
protected Object	doGetTransaction()
protected void	doResume(Object transaction, Object suspendedResources)
protected void	doRollback(DefaultTransactionStatus status)
protected void	doSetRollbackOnly(DefaultTransactionStatus status)
protected Object	doSuspend(Object transaction)
org.apache.geode.cache.GemFireCache	getCache() Returns a reference to the GemFireCache for which this transaction manager manages local cache transactions.
protected org.apache.geode.cache.CacheTransactionManager	getCacheTransactionManager() Returns a reference to the CacheTransactionManager used by Apache Geode to manage local, cache transactions.
Object	getResourceFactory()
protected Long	getResumeWaitTime() Returns the timeout used to wait for the GemFire cache transaction to resume.
protected TimeUnit	getResumeWaitTimeUnit() Returns the TimeUnit used in the wait timeout when resuming a GemFire cache transaction.
boolean	isCopyOnRead() Indicates whether copy on read is set and used for fetch data access operations.
protected boolean	isExistingTransaction(Object transaction)
protected boolean	isResumeWaitTimeSet() Determines whether the user specified a wait time for resuming a GemFire cache transaction.
void	setCache(org.apache.geode.cache.GemFireCache cache) Sets a reference to the GemFireCache for which this transaction manager manages local cache transactions.
void	setCopyOnRead(boolean copyOnRead) Set whether the cache returns direct object references or copies of the objects it manages.
<K,V> void	setRegion(org.apache.geode.cache.Region<K,V> region) Sets the GemFire cache Region as an alternative in setting in the GemFireCache directly.
void	setResumeWaitTime(Long resumeWaitTime) Sets the timeout used to wait for the GemFire cache transaction to resume.
void	setResumeWaitTimeUnit(TimeUnit resumeWaitTimeUnit) Sets the TimeUnit used in the wait timeout when resuming a GemFire cache transaction.
protected boolean	useSavepointForNestedTransaction()

Methods inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager

commit, determineTimeout, getDefaultTimeout, getTransaction, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, newTransactionStatus, prepareForCommit, prepareSynchronization, prepareTransactionStatus, registerAfterCompletionWithExistingTransaction, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setTransactionSynchronizationName, setValidateExistingTransaction, shouldCommitOnGlobalRollbackOnly, suspend, triggerBeforeCommit, triggerBeforeCompletion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.transaction.PlatformTransactionManager

commit, getTransaction, rollback

Field Detail

DEFAULT_RESUME_WAIT_TIME_UNIT

protected static final TimeUnit DEFAULT_RESUME_WAIT_TIME_UNIT

Constructor Detail

GemfireTransactionManager

public GemfireTransactionManager()

Constructs an instance of the GemfireTransactionManager.

GemfireTransactionManager

public GemfireTransactionManager(org.apache.geode.cache.GemFireCache cache)

Constructs an instance of the GemfireTransactionManager initialized with the given GemFireCache reference.

Parameters:

cache - reference to the GemFireCache associated with cache transactions.

See Also:

GemFireCache, afterPropertiesSet()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

doGetTransaction

protected Object doGetTransaction()
                           throws TransactionException

Specified by:

doGetTransaction in class AbstractPlatformTransactionManager

Throws:

TransactionException

isExistingTransaction

protected boolean isExistingTransaction(Object transaction)
                                 throws TransactionException

Overrides:

isExistingTransaction in class AbstractPlatformTransactionManager

Throws:

TransactionException

doBegin

protected void doBegin(Object transaction,
                       TransactionDefinition definition)
                throws TransactionException

Specified by:

doBegin in class AbstractPlatformTransactionManager

Throws:

TransactionException

doCommit

protected void doCommit(DefaultTransactionStatus status)
                 throws TransactionException

Specified by:

doCommit in class AbstractPlatformTransactionManager

Throws:

TransactionException

doSuspend

protected Object doSuspend(Object transaction)
                    throws TransactionException

Overrides:

doSuspend in class AbstractPlatformTransactionManager

Throws:

TransactionException

doResume

protected void doResume(Object transaction,
                        Object suspendedResources)
                 throws TransactionException

Overrides:

doResume in class AbstractPlatformTransactionManager

Throws:

TransactionException

doRollback

protected void doRollback(DefaultTransactionStatus status)
                   throws TransactionException

Specified by:

doRollback in class AbstractPlatformTransactionManager

Throws:

TransactionException

doCleanupAfterCompletion

protected void doCleanupAfterCompletion(Object transaction)

Overrides:

doCleanupAfterCompletion in class AbstractPlatformTransactionManager

doSetRollbackOnly

protected void doSetRollbackOnly(DefaultTransactionStatus status)

Overrides:

doSetRollbackOnly in class AbstractPlatformTransactionManager

useSavepointForNestedTransaction

protected final boolean useSavepointForNestedTransaction()

Overrides:

useSavepointForNestedTransaction in class AbstractPlatformTransactionManager

setCache

public void setCache(org.apache.geode.cache.GemFireCache cache)

Sets a reference to the GemFireCache for which this transaction manager manages local cache transactions.

Parameters:

cache - reference to the GemFireCache.

See Also:

GemFireCache

getCache

public org.apache.geode.cache.GemFireCache getCache()

Returns a reference to the GemFireCache for which this transaction manager manages local cache transactions.

Returns:

a reference to the GemFireCache.

See Also:

GemFireCache

getCacheTransactionManager

protected org.apache.geode.cache.CacheTransactionManager getCacheTransactionManager()

Returns a reference to the CacheTransactionManager used by Apache Geode to manage local, cache transactions.

Returns:

a reference to the CacheTransactionManager.

See Also:

CacheTransactionManager, getCache()

setCopyOnRead

public void setCopyOnRead(boolean copyOnRead)

Set whether the cache returns direct object references or copies of the objects it manages. While copies imply additional work for every fetch operation, direct object references can cause dirty reads across concurrent threads in the same VM, whether or not transactions are used. One could explicitly deep copy objects before making changes (for example by using CopyHelper.copy(Object) in which case this setting can be set to false However, unless there is a measurable performance penalty, the recommendation is to keep this setting to true.

Parameters:

copyOnRead - boolean value indicating whether copies (default) rather then direct object references will be returned on fetch operations.

isCopyOnRead

public boolean isCopyOnRead()

Indicates whether copy on read is set and used for fetch data access operations.

Returns:

the setting for copy-on-read.

See Also:

setCopyOnRead(boolean)

setRegion

public <K,V> void setRegion(org.apache.geode.cache.Region<K,V> region)

Sets the GemFire cache Region as an alternative in setting in the GemFireCache directly.

Type Parameters:

K - Class type of the Region key.

V - Class type of the Region value.

Parameters:

region - GemFire cache Region directly involved in the local cache transaction.

Throws:

IllegalArgumentException - if Region is null.

See Also:

Region

getResourceFactory

public Object getResourceFactory()

Specified by:

getResourceFactory in interface ResourceTransactionManager

setResumeWaitTime

public void setResumeWaitTime(Long resumeWaitTime)

Sets the timeout used to wait for the GemFire cache transaction to resume.

Parameters:

resumeWaitTime - long value with the timeout used to wait for the GemFire cache transaction to resume.

See Also:

CacheTransactionManager.tryResume(TransactionId, long, TimeUnit)

getResumeWaitTime

protected Long getResumeWaitTime()

Returns the timeout used to wait for the GemFire cache transaction to resume.

Returns:

the long value with the timeout used to wait for the GemFire cache transaction to resume.

See Also:

CacheTransactionManager.tryResume(TransactionId, long, TimeUnit)

isResumeWaitTimeSet

protected boolean isResumeWaitTimeSet()

Determines whether the user specified a wait time for resuming a GemFire cache transaction.

Returns:

a boolean value to indicate whether the user specified a wait time for resuming a GemFire cache transaction.

See Also:

CacheTransactionManager.tryResume(TransactionId, long, TimeUnit), getResumeWaitTime()

setResumeWaitTimeUnit

public void setResumeWaitTimeUnit(TimeUnit resumeWaitTimeUnit)

Sets the TimeUnit used in the wait timeout when resuming a GemFire cache transaction.

Parameters:

resumeWaitTimeUnit - TimeUnit used in the wait timeout when resuming a GemFire cache transaction.

See Also:

CacheTransactionManager.tryResume(TransactionId, long, TimeUnit)

getResumeWaitTimeUnit

protected TimeUnit getResumeWaitTimeUnit()

Returns the TimeUnit used in the wait timeout when resuming a GemFire cache transaction. Defaults to TimeUnit.SECONDS.

Returns:

the TimeUnit used in the wait timeout when resuming a GemFire cache transaction.

See Also:

CacheTransactionManager.tryResume(TransactionId, long, TimeUnit)