JBoss Community

Envers: Easy Entity Auditing

Similarly to Subversion, Envers has a concept of revisions. Basically, one transaction is one revision (unless the transaction didn't modify any audited entities). As the revisions are global, having a revision number, you can query for various entities at that revision, retrieving a (partial) view of the database at that revision. You can find a revision number having a date, and the other way round, you can get the date at which a revision was commited.

Envers is a Hibernate core module and works with Hibernate and Hibernate Entity Manager (see hibernate.org). For the auditing to work properly, the entities must have immutable unique identifiers (primary keys). You can use Envers wherever Hibernate works: standalone, inside JBoss AS, with JBoss Seam or Spring.

Some of the features:

• auditing of all mappings defined by the JPA specification
• auditing of some Hibernate mappings, which extend JPA, like custom types and collections/maps of "simple" types (Strings, Integers, etc.) (see here for one exception)
• logging data for each revision using a "revision entity"
• querying historical data

For a quick tutorial on how to use Envers, see the Quick Start page.

On the downloads page, you'll find the jar with the library, the source code, as well as an Envers+Seam demo: a simple wiki application and bi-temporal versioning demo.

You can also try a console demo, which is a simple app where you can create, modify and view versions of two simple entities (Person and Address), and modify a one-to-many relation between them. By default it uses hsqldb, but you can overwrite the persistence.xml and check how it works with your database, see the structure of the generated tables etc.

• Lesser General Public License version 2.1 (LGPL v2.1)