Skip to content

Commit

Permalink
Audit user changes - update README.md documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
josegar74 authored and juanluisrp committed Nov 14, 2024
1 parent 6fc2013 commit abed63e
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions auditable/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Auditable Module

The auditable module contains the classes that allow auditing changes in user information.
The auditable module contains the classes that allow auditing changes in user information using [Hibernate Envers](https://hibernate.org/orm/envers/).

Support for new auditable entities can be added, for example to audit changes in group information. See as an example, [UserAuditable](src/main/java/org/fao/geonet/auditable/model/UserAuditable.java).
Support for new auditable entities can be added, for example to audit changes in group information. For users auditing:

The current auditable service [AuditableService](src/main/java/org/fao/geonet/auditable/AuditableService.java) uses [Javers](https://javers.org/),
but new auditable services can be implemented using other technologies.

An example of using the auditable service can be found in [UserApi](../services/src/main/java/org/fao/geonet/api/users/UsersApi.java).
- Entity with the information to audit: [UserAuditable](../domain/src/main/java/org/fao/geonet/domain/auditable/UserAuditable.java).
- Related JPA repository: [UserAuditableRepository](../domain/src/main/java/org/fao/geonet/repository/UserAuditableRepository.java).
- The auditable service: [UserAuditableService](src/main/java/org/fao/geonet/auditable/UserAuditableService.java).
- The users API updated to use the auditable service: [UserApi](../services/src/main/java/org/fao/geonet/api/users/UsersApi.java).



Expand Down

0 comments on commit abed63e

Please sign in to comment.