Auditing is een van de belangrijkste onderdelen in ieder systeem. Er zijn al enkele manieren om dit te regelen. Het makkelijkste is een audit log, Gerry Noij is nu bezig met het beschrijven van het temporal object pattern.

JBoss heeft sinds dit jaar een nieuw project erbij: Envers. Annoteer je de classes of properties met @Versioned, dan wordt de rest voor je geregeld.

The Envers project aims to enable easy versioning of persistent classes. All that you have to do is annotate your persistent class or some of its properties, that you want to version, with @Versioned. For each versioned entity, a table will be created, which will hold the history of changes made to the entity. You can then retrieve and query historical data without much effort.

Om een voorbeeld te geven hoe je classes er in het vervolg uitzien, een klein stukje overgenomen van de quickstart.

Class Person:

import org.jboss.versions.Versioned;  

import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.GeneratedValue;
import javax.persistence.Column;  

@Entity
@Versioned // that's the important part
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
}

Class Address:

@Entity
@Versioned
public class Address {
    @Id
    @GeneratedValue
    private int id;  

    private String streetName;  

    private Integer houseNumber;  

    private Integer flatNumber;  

    @OneToMany(mappedBy = "address")
    private Set<Person> persons;  

    // add getters, setters, constructors, equals and hashCode here
}

Daarnaast moeten er 6 listeners worden geregistreerd. Als je het schema laat genereren, worden er 2 extra tabellen aangemaakt: address_versions en person_versions en deze worden automatisch gevuld met historische data. Het ophalen van een specifieke versie gebeurt met een VersionReader:

VersionsReader reader = VersionsReaderFactory.get(entityManager);
Person oldPerson = reader.find(Person.class, personId, revision); 

Het is mij net bekend geworden dat dit bestaat, ik heb zelf geen ervaring met Envers. Misschien dat anderen dat wel hebben?

Dit bericht is gepost op 30 December 2008 om 1:05 pm uur en is geplaatst in Tools/Frameworks. Je kunt alle reacties op dit bericht volgen via de RSS 2.0 feed. Je kunt een reactie achter laten of trackback vanaf je eigen site.