Module dk.cloudcreate.essentials.components.foundation

Package dk.cloudcreate.essentials.components.foundation.transaction.spring

Class SpringTransactionAwareUnitOfWorkFactory<TRX_MGR extends org.springframework.transaction.PlatformTransactionManager,UOW extends SpringTransactionAwareUnitOfWork<TRX_MGR,UOW>>

java.lang.Object

dk.cloudcreate.essentials.components.foundation.transaction.spring.SpringTransactionAwareUnitOfWorkFactory<TRX_MGR,UOW>

Type Parameters:

TRX_MGR - the platform transaction manager that this UnitOfWorkFactory is compatible with

UOW - the Unit of work implementation that this SpringTransactionAwareUnitOfWorkFactory specialization is compatible with

All Implemented Interfaces:

UnitOfWorkFactory<UOW>

Direct Known Subclasses:

SpringMongoTransactionAwareUnitOfWorkFactory, SpringTransactionAwareJdbiUnitOfWorkFactory

public abstract class SpringTransactionAwareUnitOfWorkFactory<TRX_MGR extends org.springframework.transaction.PlatformTransactionManager,UOW extends SpringTransactionAwareUnitOfWork<TRX_MGR,UOW>>
extends Object
implements UnitOfWorkFactory<UOW>

Variant of the UnitOfWorkFactory which can delegate the creation of the underlying transaction to the provided PlatformTransactionManager instance.
The UnitOfWork type specialization needs to extend SpringTransactionAwareUnitOfWork

See Also:

• SpringTransactionAwareJdbiUnitOfWorkFactory
• SpringMongoTransactionAwareUnitOfWorkFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.springframework.transaction.support.DefaultTransactionDefinition	defaultTransactionDefinition
protected static final org.slf4j.Logger	log
protected final TRX_MGR	transactionManager
protected final Class<?>	unitOfWorkType	The class representation of the UOW generic type parameter. The UnitOfWork is bound a resource with the TransactionSynchronizationManager using the unitOfWorkType class as key.

Fields inherited from interface dk.cloudcreate.essentials.components.foundation.transaction.UnitOfWorkFactory

unitOfWorkLog

Constructor Summary

Constructors

Constructor	Description
SpringTransactionAwareUnitOfWorkFactory(TRX_MGR transactionManager)

Method Summary

Modifier and Type	Method	Description
protected void	afterCommitAfterCallingLifecycleCallbackResources(UOW unitOfWork)	Called during TransactionSynchronization.afterCommit() AFTER all registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.afterCommit(UnitOfWork, List) method called
protected void	afterCommitBeforeCallingLifecycleCallbackResources(UOW unitOfWork)	Called during TransactionSynchronization.afterCommit() BEFORE any registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.afterCommit(UnitOfWork, List) method called
protected void	afterRollbackAfterCallingLifecycleCallbackResources(UOW unitOfWork)	Called during TransactionSynchronization.afterCompletion(int) AFTER all registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.afterRollback(UnitOfWork, List, Exception) method called
protected void	afterRollbackBeforeCallingLifecycleCallbackResources(UOW unitOfWork)	Called during TransactionSynchronization.afterCompletion(int) BEFORE any registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.afterRollback(UnitOfWork, List, Exception) method called
protected void	beforeCommitAfterCallingLifecycleCallbackResources(UOW unitOfWork)	Called during TransactionSynchronization.beforeCommit(boolean) AFTER all registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.beforeCommit(UnitOfWork, List) method called
protected void	beforeCommitBeforeCallingLifecycleCallbackResources(UOW unitOfWork)	Called during TransactionSynchronization.beforeCommit(boolean) BEFORE any registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.beforeCommit(UnitOfWork, List) method called
protected org.springframework.transaction.support.DefaultTransactionDefinition	createDefaultTransactionDefinition()	Override to create a custom DefaultTransactionDefinition.
protected abstract UOW	createUnitOfWorkForFactoryManagedTransaction(org.springframework.transaction.TransactionStatus transaction)	Create a UnitOfWork wrapping a Spring Transaction managed by this UnitOfWorkFactory
protected abstract UOW	createUnitOfWorkForSpringManagedTransaction()	Create a UnitOfWork participating in an existing Spring Managed Transaction that isn't managed by this UnitOfWorkFactory
Optional<UOW>	getCurrentUnitOfWork()	Get the currently active UnitOfWork
UOW	getOrCreateNewUnitOfWork()	Get the currently active UnitOfWork or create a new UnitOfWork if one is missing
UOW	getRequiredUnitOfWork()	Get a required active UnitOfWork
TRX_MGR	getTransactionManager()
protected Class<?>	resolveUnitOfWorkType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface dk.cloudcreate.essentials.components.foundation.transaction.UnitOfWorkFactory

usingUnitOfWork, usingUnitOfWork, withUnitOfWork, withUnitOfWork

Field Details

log

protected static final org.slf4j.Logger log

transactionManager

protected final TRX_MGR extends org.springframework.transaction.PlatformTransactionManager transactionManager

defaultTransactionDefinition

protected final org.springframework.transaction.support.DefaultTransactionDefinition defaultTransactionDefinition

unitOfWorkType

protected final Class<?> unitOfWorkType

The class representation of the UOW generic type parameter.
The UnitOfWork is bound a resource with the TransactionSynchronizationManager using the unitOfWorkType class as key.

Constructor Details

SpringTransactionAwareUnitOfWorkFactory

public SpringTransactionAwareUnitOfWorkFactory(TRX_MGR transactionManager)

Method Details

resolveUnitOfWorkType

protected Class<?> resolveUnitOfWorkType()

createDefaultTransactionDefinition

protected org.springframework.transaction.support.DefaultTransactionDefinition createDefaultTransactionDefinition()

Override to create a custom DefaultTransactionDefinition.

Returns:

per default, it generates a DefaultTransactionDefinition with propagation TransactionDefinition.PROPAGATION_REQUIRED and Isolation-level TransactionDefinition.ISOLATION_READ_COMMITTED

getTransactionManager

public TRX_MGR getTransactionManager()

getRequiredUnitOfWork

public UOW getRequiredUnitOfWork()

Description copied from interface: UnitOfWorkFactory

Get a required active UnitOfWork

Specified by:

getRequiredUnitOfWork in interface UnitOfWorkFactory<TRX_MGR extends org.springframework.transaction.PlatformTransactionManager>

Returns:

the active UnitOfWork

getCurrentUnitOfWork

public Optional<UOW> getCurrentUnitOfWork()

Description copied from interface: UnitOfWorkFactory

Get the currently active UnitOfWork

Specified by:

getCurrentUnitOfWork in interface UnitOfWorkFactory<TRX_MGR extends org.springframework.transaction.PlatformTransactionManager>

Returns:

the currently active UnitOfWork wrapped in an Optional or Optional.empty() in case there isn't a currently active UnitOfWork

getOrCreateNewUnitOfWork

public UOW getOrCreateNewUnitOfWork()

Description copied from interface: UnitOfWorkFactory

Get the currently active UnitOfWork or create a new UnitOfWork if one is missing

Specified by:

getOrCreateNewUnitOfWork in interface UnitOfWorkFactory<TRX_MGR extends org.springframework.transaction.PlatformTransactionManager>

Returns:

a UnitOfWork

createUnitOfWorkForFactoryManagedTransaction

protected abstract UOW createUnitOfWorkForFactoryManagedTransaction(org.springframework.transaction.TransactionStatus transaction)

Create a UnitOfWork wrapping a Spring Transaction managed by this UnitOfWorkFactory

Parameters:

transaction - the Spring Transaction managed by this UnitOfWorkFactory

Returns:

a UnitOfWork wrapping the existing active Spring managed transaction

createUnitOfWorkForSpringManagedTransaction

protected abstract UOW createUnitOfWorkForSpringManagedTransaction()

Create a UnitOfWork participating in an existing Spring Managed Transaction that isn't managed by this UnitOfWorkFactory

Returns:

a UnitOfWork that is participating in an existing Spring Managed Transaction that isn't managed by this UnitOfWorkFactory

afterCommitAfterCallingLifecycleCallbackResources

protected void afterCommitAfterCallingLifecycleCallbackResources(UOW unitOfWork)

Called during TransactionSynchronization.afterCommit() AFTER all registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.afterCommit(UnitOfWork, List) method called

Parameters:

unitOfWork - the unit of work

afterCommitBeforeCallingLifecycleCallbackResources

protected void afterCommitBeforeCallingLifecycleCallbackResources(UOW unitOfWork)

Called during TransactionSynchronization.afterCommit() BEFORE any registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.afterCommit(UnitOfWork, List) method called

Parameters:

unitOfWork - the unit of work

beforeCommitAfterCallingLifecycleCallbackResources

protected void beforeCommitAfterCallingLifecycleCallbackResources(UOW unitOfWork)

Called during TransactionSynchronization.beforeCommit(boolean) AFTER all registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.beforeCommit(UnitOfWork, List) method called

Parameters:

unitOfWork - the unit of work

beforeCommitBeforeCallingLifecycleCallbackResources

protected void beforeCommitBeforeCallingLifecycleCallbackResources(UOW unitOfWork)

Called during TransactionSynchronization.beforeCommit(boolean) BEFORE any registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.beforeCommit(UnitOfWork, List) method called

Parameters:

unitOfWork - the unit of work

afterRollbackBeforeCallingLifecycleCallbackResources

protected void afterRollbackBeforeCallingLifecycleCallbackResources(UOW unitOfWork)

Called during TransactionSynchronization.afterCompletion(int) BEFORE any registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.afterRollback(UnitOfWork, List, Exception) method called

Parameters:

unitOfWork - the unit of work

afterRollbackAfterCallingLifecycleCallbackResources

protected void afterRollbackAfterCallingLifecycleCallbackResources(UOW unitOfWork)

Called during TransactionSynchronization.afterCompletion(int) AFTER all registered SpringTransactionAwareUnitOfWork.unitOfWorkLifecycleCallbackResources have had their UnitOfWorkLifecycleCallback.afterRollback(UnitOfWork, List, Exception) method called

Parameters:

unitOfWork - the unit of work