Package org.hibernate.audit

@Incubating package org.hibernate.audit

API for querying the history of audited entities.

Audited entities are transparently versioned: every insert, update, and delete is recorded in a companion audit table. Point-in-time reads are available via atChangeset() sessions, while the AuditLog interface provides programmatic access to revision history, modification types, and cross-entity change queries.

This package also contains the base classes and contracts for defining custom changeset entities and changeset listeners.

See Also:

• Audited
• Changelog
• AuditStrategy
• AuditLog
• AuditLogFactory

Related Packages

Package	Description
org.hibernate	This package defines the central Hibernate APIs, beginning with SessionFactory, which represents an instance of Hibernate at runtime and is the source of new instances of Session and StatelessSession, the most important APIs exposing persistence-related operations for entities.
org.hibernate.audit.spi

Class	Description
AuditEntry<T>	A tuple representing an entity at a specific changeset in the audit history.
AuditException	Indicates a problem related to audit functionality.
AuditLog	A service for querying the audit log.
AuditLogFactory	Factory for obtaining AuditLog instances.
AuditStrategy	Enumerates the possible strategies for querying audited entities and collections.
ChangelogMapping	Base @MappedSuperclass for changeset entities, providing the standard REV (auto-generated integer primary key) and REVTSTMP (Unix epoch timestamp) columns.
ChangesetListener	A callback invoked when a new changelog entity is created, allowing the application to populate custom fields such as the current user or a comment.
DefaultChangelog	A built-in changelog entity which maps to the REVINFO table.
DefaultTrackingModifiedEntitiesChangelog	A built-in changelog entity with entity change tracking.
EntityTrackingChangesetListener	A callback invoked for each entity change within a transaction, in addition to the ChangesetListener.newChangeset(Object) callback invoked once when the changelog entity is created.
ModificationType	The type of modification recorded in the modification type column of the audit log.
TrackingModifiedEntitiesChangelogMapping	Extension of ChangelogMapping that tracks which entity types were modified in each revision.