12.7.4. Getting Started with Entity Auditing

Procedure 12.8. Add Auditing Support to a JPA Entity

1. Configure the available auditing parameters to suit the deployment: Section 12.7.5.1, “Configure Envers Parameters”.
2. Open the JPA entity to be audited.
3. Import the org.hibernate.envers.Audited interface.
4. Apply the @Audited annotation to each field or property to be audited, or apply it once to the whole class.

   Example 12.30. Audit Two Fields

   import org.hibernate.envers.Audited;
   
   import javax.persistence.Entity;
   import javax.persistence.Id;
   import javax.persistence.GeneratedValue;
   import javax.persistence.Column;
   
   @Entity
   public class Person {
       @Id
       @GeneratedValue
       private int id;
   
       @Audited
       private String name;
   
       private String surname;
   
       @ManyToOne
       @Audited
       private Address address;
   
       // add getters, setters, constructors, equals and hashCode here
   }
   

   Example 12.31. Audit an entire Class

   import org.hibernate.envers.Audited;
   
   import javax.persistence.Entity;
   import javax.persistence.Id;
   import javax.persistence.GeneratedValue;
   import javax.persistence.Column;
   
   @Entity
   @Audited
   public class Person {
       @Id
       @GeneratedValue
       private int id;
   
       private String name;
   
       private String surname;
   
       @ManyToOne
       private Address address;
   
       // add getters, setters, constructors, equals and hashCode here
   }