Class AuditWorkQueue

java.lang.Object

org.hibernate.audit.spi.AuditWorkQueue

All Implemented Interfaces:

TransactionCompletionCallbacks.BeforeCompletionCallback, TransactionCompletionCallbacks.CompletionCallback

public class AuditWorkQueue
extends Object
implements TransactionCompletionCallbacks.BeforeCompletionCallback

Transaction-scoped queue for deferred audit row writes.

Mutation coordinators enqueue audit entries instead of writing them inline during flush. Entries are keyed by EntityKey. When the same entity is modified multiple times within a transaction, entries are merged according to the following merge rules:

• ADD + MOD -> ADD (with latest state)
• ADD + DEL -> entries cancel out (no audit row)
• MOD + MOD -> MOD (with latest state)
• MOD + DEL -> DEL
• DEL + ADD -> MOD (entity re-created with potentially different state)

All audit rows (INSERT + optional REVEND UPDATE) are written at beforeTransactionCompletion.

Since:

7.4

See Also:

• AuditWriter

Constructor Summary

Constructors

Constructor	Description
AuditWorkQueue()

Method Summary

Modifier and Type	Method	Description
void	doBeforeTransactionCompletion(SharedSessionContractImplementor session)	Perform whatever processing is encapsulated here before completion of the transaction.
void	enqueue(EntityKey entityKey, Object entity, Object[] values, ModificationType modificationType, AuditWriter writer, SharedSessionContractImplementor session)	Enqueue an audit entry for deferred writing.
void	enqueueCollection(CollectionPersister collectionPersister, PersistentCollection<?> collection, Object ownerId, Object originalSnapshot, CollectionAuditWriter writer, SharedSessionContractImplementor session)	Enqueue a collection for deferred audit row writing.
void	setChangesetContext(Object changelog, Session changesetSession)	Store the changelog entity and the child session used to persist it.

Methods inherited from class Object

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

Constructor Details

AuditWorkQueue

public AuditWorkQueue()

Method Details

enqueue

public void enqueue(EntityKey entityKey,
 Object entity,
 Object[] values,
 ModificationType modificationType,
 AuditWriter writer,
 SharedSessionContractImplementor session)

Enqueue an audit entry for deferred writing. If an entry for the same entity already exists, the entries are merged.

Parameters:

entityKey - the entity key (reused from the persistence context)

entity - the entity instance (may be null for delete)

values - the entity state

modificationType - the modification type (ADD/MOD/DEL)

writer - callback to perform the actual write

session - the current session

enqueueCollection

public void enqueueCollection(CollectionPersister collectionPersister,
 PersistentCollection<?> collection,
 Object ownerId,
 Object originalSnapshot,
 CollectionAuditWriter writer,
 SharedSessionContractImplementor session)

Enqueue a collection for deferred audit row writing. On first enqueue, the current snapshot is captured. Subsequent enqueues for the same collection are ignored; the diff will be computed at transaction completion against the original snapshot.

Parameters:

collectionPersister - the collection persister

collection - the persistent collection

ownerId - the owning entity's identifier

originalSnapshot - the collection snapshot before this flush

writer - callback to compute diff and write audit rows

session - the current session

setChangesetContext

public void setChangesetContext(Object changelog,
 Session changesetSession)

Store the changelog entity and the child session used to persist it. The child session is kept open for deferred flush of @ElementCollection changes (e.g. @ModifiedEntities). Called from ChangelogSupplier.generateIdentifier(SharedSessionContract).let's

doBeforeTransactionCompletion

public void doBeforeTransactionCompletion(SharedSessionContractImplementor session)

Description copied from interface: TransactionCompletionCallbacks.BeforeCompletionCallback

Perform whatever processing is encapsulated here before completion of the transaction.

Specified by:

doBeforeTransactionCompletion in interface TransactionCompletionCallbacks.BeforeCompletionCallback

Parameters:

session - The session on which the transaction is preparing to complete.