To showcase how easy the integration is, I created a small JSF/CDI application, which uses Envers and can be deployed straight to AS7. To build the application I decided to try out JBoss Forge, which turned out to be very easy to use and provided me with a simple one-entity CRUD in no time. Just a few changes made it possible to track changes made to the entity, and view its history.
So if you are using AS 7.0.2, to add Envers to your app you just need to:
- Add hibernate-envers to the pom.xml using the provided scope
- Add @Audited to the entities that you want to audit
- Enable the Envers module by specifying a dependency in MANIFEST.MF
The last step makes the bundled Envers module visible to your application. To view all the changes necessary in detail, just take a look at this commit.
Apart from storing the changes, you may also want to view the history of an entity. That’s also pretty straightforward. All we need is to create a new JSF view and a CDI bean with a method running a simple history query. Again, this commit shows all the changes needed.
You can deploy the application in two ways:
- Run mvn clean install, and copy the resulting .war to jboss/standalone/deployments
- If you are using Forge, run forge from the checkout directory, and invoke: build, then: as7 deploy
After deployment, you should be able to access the application using http://localhost:8080/envers-as7-demo. Click on the Person link on the left to add, edit, list and view history of the entity.
By default, the application uses an example datasource, but if you wish to explore the additional schema generated by Envers you can easily change it to another database by modifying persistence.xml and creating a new datasource in the AS administration console.
As always I invite you to submit feedback on the Envers forum. Have fun!