Module dk.cloudcreate.essentials.components.foundation

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

Interface UnitOfWork

All Known Subinterfaces:

ClientSessionAwareUnitOfWork, HandleAwareUnitOfWork

All Known Implementing Classes:

GenericHandleAwareUnitOfWorkFactory.GenericHandleAwareUnitOfWork, SpringMongoTransactionAwareUnitOfWorkFactory.SpringMongoTransactionAwareUnitOfWork, SpringTransactionAwareJdbiUnitOfWorkFactory.SpringTransactionAwareHandleAwareUnitOfWork, SpringTransactionAwareUnitOfWork

public interface UnitOfWork

Method Summary

Modifier and Type	Method	Description
void	commit()	Commit the UnitOfWork and any underlying transaction - see UnitOfWorkStatus.Committed
Exception	getCauseOfRollback()	The cause of a Rollback or a markAsRollbackOnly(Exception)
default void	markAsRollbackOnly()
void	markAsRollbackOnly(Exception cause)
<T> T	registerLifecycleCallbackForResource(T resource, UnitOfWorkLifecycleCallback<T> associatedUnitOfWorkCallback)	TODO: Adjust example to the new API Register a resource (e.g.
default void	rollback()	Roll back the UnitOfWork and any underlying transaction - see UnitOfWorkStatus.RolledBack
void	rollback(Exception cause)	Roll back the UnitOfWork and any underlying transaction - see UnitOfWorkStatus.RolledBack
void	start()	Start the UnitOfWork and any underlying transaction
UnitOfWorkStatus	status()	Get the status of the UnitOfWork

Method Detail

start

void start()

Start the UnitOfWork and any underlying transaction

commit

void commit()

Commit the UnitOfWork and any underlying transaction - see UnitOfWorkStatus.Committed

rollback

void rollback(Exception cause)

Roll back the UnitOfWork and any underlying transaction - see UnitOfWorkStatus.RolledBack

Parameters:

cause - the cause of the rollback

status

UnitOfWorkStatus status()

Get the status of the UnitOfWork

getCauseOfRollback

Exception getCauseOfRollback()

The cause of a Rollback or a markAsRollbackOnly(Exception)

markAsRollbackOnly

default void markAsRollbackOnly()

markAsRollbackOnly

void markAsRollbackOnly(Exception cause)

rollback

default void rollback()

Roll back the UnitOfWork and any underlying transaction - see UnitOfWorkStatus.RolledBack

registerLifecycleCallbackForResource

<T> T registerLifecycleCallbackForResource(T resource,
                                           UnitOfWorkLifecycleCallback<T> associatedUnitOfWorkCallback)

TODO: Adjust example to the new API Register a resource (e.g. an Aggregate) that should have its UnitOfWorkLifecycleCallback called during UnitOfWork operation.
Example:

 Aggregate aggregate = unitOfWork.registerLifecycleCallbackForResource(aggregate.loadFromEvents(event),
                                                                       new AggregateRootRepositoryUnitOfWorkLifecycleCallback()));
 

Where the Aggreg

{@code
 class AggregateRootRepositoryUnitOfWorkLifecycleCallback implements UnitOfWorkLifecycleCallback {

Type Parameters:

T - the type of resource

Parameters:

resource - the resource that should be tracked

associatedUnitOfWorkCallback - the callback instance for the given resource

Returns:

the resource or a proxy to it