Skip to content

Commit 8d62320

Browse files
Update auditing documentation.
Mention that even when only using the CreatedDate & LastModifiedDate annotations it is mandatory to enable auditing. Closes #2283
1 parent 5844648 commit 8d62320

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/main/asciidoc/auditing.adoc

+8-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
[[auditing.basics]]
55
== Basics
66
Spring Data provides sophisticated support to transparently keep track of who created or changed an entity and when the change happened. To benefit from that functionality, you have to equip your entity classes with auditing metadata that can be defined either using annotations or by implementing an interface.
7+
Additionally auditing has to be enabled either via Java or XML configuration which ensures required infrastructure components get registered.
8+
Please refer to the store specific section for configuration samples.
9+
10+
[NOTE]
11+
====
12+
Applications that only track creation and modification dates do not need to specify an <<auditing.auditor-aware>>.
13+
====
714

815
[[auditing.annotations]]
916
=== Annotation-based Auditing Metadata
@@ -19,7 +26,7 @@ class Customer {
1926
private User user;
2027
2128
@CreatedDate
22-
private DateTime createdDate;
29+
private Instant createdDate;
2330
2431
// … further properties omitted
2532
}

0 commit comments

Comments
 (0)