Class CollectionAuditSupport

java.lang.Object

org.hibernate.persister.collection.mutation.CollectionAuditSupport

@Incubating
public class CollectionAuditSupport
extends Object

Shared diffing, operation planning, and binding support for audited collection row mutations.

Like EntityAuditSupport, this type keeps audit operation construction queue-neutral. Legacy collection audit coordinators consume operation groups through the normal mutation executor, while the graph queue materializes execution-agnostic plans as FlushOperations during transaction completion. This type also owns collection-row diffing and owner-entity audit-change resolution because those are audit semantics shared by both queues.

The main invariants guarded here are:

• Collection audit rows are derived from the collection's original snapshot and final in-memory state.
• Row identity is delegated to AuditCollectionRowMutationHelper so keyed, indexed, identifier, element, and one-to-many join-column shapes bind consistently.
• Validity-strategy transaction-end updates use the same row identity as audit inserts and restrict on REVEND is null.
• Owner entity MOD audit changes are resolved here as logical audit changes, not by teaching collection coordinators about graph execution.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CollectionAuditSupport.AuditCollectionChange	One row-level collection audit change.
static final record	CollectionAuditSupport.AuditCollectionOperation	A resolved collection audit mutation operation.
static final record	CollectionAuditSupport.AuditInsertPlan	Execution-agnostic plan for inserting collection audit rows.
static final record	CollectionAuditSupport.OwnerAuditChange	Owning entity audit change implied by a collection mutation.
static final record	CollectionAuditSupport.TransactionEndPlan	Execution-agnostic plan for closing previous validity audit rows.

Constructor Summary

Constructors

Constructor	Description
CollectionAuditSupport(CollectionMutationTarget mutationTarget, SessionFactoryImplementor sessionFactory, boolean[] indexColumnIsSettable, boolean[] elementColumnIsSettable, UnaryOperator<Object> indexIncrementer, AuditMapping auditMapping)

Method Summary

Modifier and Type	Method	Description
void	bindAuditInsertValues(PersistentCollection<?> collection, Object ownerId, CollectionAuditSupport.AuditCollectionChange change, Object changesetId, SharedSessionContractImplementor session, JdbcValueBindings jdbcValueBindings)	Bind values for one graph-queue collection audit INSERT.
void	bindAuditInsertValues(PersistentCollection<?> collection, Object ownerId, CollectionAuditSupport.AuditCollectionChange change, SharedSessionContractImplementor session, JdbcValueBindings jdbcValueBindings)	Bind values for one legacy collection audit INSERT.
void	bindTransactionEndValues(PersistentCollection<?> collection, Object ownerId, CollectionAuditSupport.AuditCollectionChange change, Object changesetId, SharedSessionContractImplementor session, JdbcValueBindings jdbcValueBindings)	Bind values for one graph-queue validity-strategy transaction-end UPDATE.
void	bindTransactionEndValues(PersistentCollection<?> collection, Object ownerId, CollectionAuditSupport.AuditCollectionChange change, SharedSessionContractImplementor session, JdbcValueBindings jdbcValueBindings)	Bind values for one legacy validity-strategy transaction-end UPDATE.
MutationOperationGroup	getAuditInsertOperationGroup()
CollectionMutationTarget	getMutationTarget()
EntityAuditSupport	getOwnerMutationSupport()
MutationOperationGroup	getTransactionEndUpdateGroup()
CollectionAuditSupport.AuditInsertPlan	resolveAuditInsertPlan()	Resolve the audit insert plan for row-level collection audit changes.
List<CollectionAuditSupport.AuditCollectionChange>	resolveChanges(PersistentCollection<?> collection, Object originalSnapshot)
CollectionAuditSupport.OwnerAuditChange	resolveOwnerAuditChange(Object ownerId, PersistentCollection<?> collection, SharedSessionContractImplementor session)	Resolve the owning entity change implied by an audited collection change.
CollectionAuditSupport.TransactionEndPlan	resolveTransactionEndUpdatePlan()	Resolve the validity-strategy transaction-end plan for collection audit rows.

Methods inherited from class Object

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

Constructor Details

CollectionAuditSupport

public CollectionAuditSupport(CollectionMutationTarget mutationTarget,
 SessionFactoryImplementor sessionFactory,
 boolean[] indexColumnIsSettable,
 boolean[] elementColumnIsSettable,
 UnaryOperator<Object> indexIncrementer,
 AuditMapping auditMapping)

Method Details

getMutationTarget

public CollectionMutationTarget getMutationTarget()

getOwnerMutationSupport

@Nullable
public EntityAuditSupport getOwnerMutationSupport()

resolveOwnerAuditChange

public CollectionAuditSupport.OwnerAuditChange resolveOwnerAuditChange(Object ownerId,
 PersistentCollection<?> collection,
 SharedSessionContractImplementor session)

Resolve the owning entity change implied by an audited collection change.

Collection audit rows record the row-level ADD/DEL changes, while the owning entity receives a MOD audit row so revision queries can see that the association changed. The owner is resolved from the persistence context first, then from the collection wrapper, and finally by entity key lookup. If the owner cannot be resolved, no owner MOD change is produced; the collection row audit work can still be recorded.

getAuditInsertOperationGroup

public MutationOperationGroup getAuditInsertOperationGroup()

getTransactionEndUpdateGroup

public MutationOperationGroup getTransactionEndUpdateGroup()

resolveAuditInsertPlan

public CollectionAuditSupport.AuditInsertPlan resolveAuditInsertPlan()

Resolve the audit insert plan for row-level collection audit changes.

The returned plan is execution-agnostic. It identifies the JDBC mutation operation that inserts audit rows, while queue-specific code decides how to materialize and execute that operation.

resolveTransactionEndUpdatePlan

public CollectionAuditSupport.TransactionEndPlan resolveTransactionEndUpdatePlan()

Resolve the validity-strategy transaction-end plan for collection audit rows.

The returned plan describes the update operation used to close previous audit rows for changed collection-row identities. A null result means the active audit strategy does not require this update.

resolveChanges

public List<CollectionAuditSupport.AuditCollectionChange> resolveChanges(PersistentCollection<?> collection,
 Object originalSnapshot)

bindAuditInsertValues

public void bindAuditInsertValues(PersistentCollection<?> collection,
 Object ownerId,
 CollectionAuditSupport.AuditCollectionChange change,
 SharedSessionContractImplementor session,
 JdbcValueBindings jdbcValueBindings)

Bind values for one legacy collection audit INSERT.

The CollectionAuditSupport.AuditCollectionChange.rawEntry() is passed through unchanged so the row mutation helper can use the collection wrapper's normal row access methods for list, map, id-bag, element, and association rows.

bindAuditInsertValues

public void bindAuditInsertValues(PersistentCollection<?> collection,
 Object ownerId,
 CollectionAuditSupport.AuditCollectionChange change,
 Object changesetId,
 SharedSessionContractImplementor session,
 JdbcValueBindings jdbcValueBindings)

Bind values for one graph-queue collection audit INSERT.

This mirrors the legacy binding variant while using graph queue bindings, which are keyed by column name because the surrounding flush operation already carries the mutating audit table descriptor.

bindTransactionEndValues

public void bindTransactionEndValues(PersistentCollection<?> collection,
 Object ownerId,
 CollectionAuditSupport.AuditCollectionChange change,
 SharedSessionContractImplementor session,
 JdbcValueBindings jdbcValueBindings)

Bind values for one legacy validity-strategy transaction-end UPDATE.

The UPDATE closes the previous audit row for the same collection row identity. Zero affected rows are tolerated by callers because a row being added for the first time has no previous audit row to close.

bindTransactionEndValues

public void bindTransactionEndValues(PersistentCollection<?> collection,
 Object ownerId,
 CollectionAuditSupport.AuditCollectionChange change,
 Object changesetId,
 SharedSessionContractImplementor session,
 JdbcValueBindings jdbcValueBindings)

Bind values for one graph-queue validity-strategy transaction-end UPDATE.

See Also:

• bindTransactionEndValues(PersistentCollection, Object, AuditCollectionChange, SharedSessionContractImplementor, JdbcValueBindings)