Skip to content

Commit 7e22a76

Browse files
committed
Polishing.
Reformat code. Add link to Envers. Consistently use template variables. See #61 Original pull request: #279.
1 parent 0e74d3e commit 7e22a76

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

src/main/asciidoc/envers.adoc

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
[[envers.what]]
1+
[[envers.what.is.spring.data]]
22
== What is Spring Data Envers
33

44
Spring Data Envers differs from other Spring Data modules in that it is always used in combination with another Spring Data Module: Spring Data JPA.
55
It makes typical Envers queries available in repositories for Spring Data JPA.
66

7+
[[envers.what]]
78
== What is Envers?
89

9-
Envers is a Hibernate module which adds auditing capabilities to JPA entities.
10+
Envers is a https://hibernate.org/orm/envers/[Hibernate module] which adds auditing capabilities to JPA entities.
1011
This documentation assumes you are familiar with Envers just as Spring Data Envers relies on Envers being properly configured.
1112

1213
[[envers.configuration]]
@@ -40,8 +41,9 @@ In order to enable Spring Data Envers and Spring Data JPA we need to configure t
4041
@EnableJpaRepositories(repositoryFactoryBeanClass = EnversRevisionRepositoryFactoryBean.class) // <1>
4142
@EnableTransactionManagement
4243
public class EnversDemoConfiguration {
43-
@Bean
44-
public DataSource dataSource() {
44+
45+
@Bean
46+
public DataSource dataSource() {
4547
4648
EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder();
4749
return builder.setType(EmbeddedDatabaseType.HSQL).build();
@@ -77,7 +79,7 @@ In order to actually use Spring Data Envers make one or more repositories into {
7779
====
7880
[source,java]
7981
----
80-
public interface PersonRepository
82+
interface PersonRepository
8183
extends CrudRepository<Person, Long>,
8284
RevisionRepository<Person, Long, Long> // <1>
8385
{}
@@ -92,7 +94,7 @@ The entity for that repository must be an entity with Envers auditing enabled, i
9294
----
9395
@Entity
9496
@Audited
95-
public class Person {
97+
class Person {
9698
9799
@Id @GeneratedValue
98100
Long id;
@@ -111,7 +113,7 @@ You may now use the methods from `RevisionRepository` to query the revisions of
111113
----
112114
@ExtendWith(SpringExtension.class)
113115
@Import(EnversDemoConfiguration.class) // <1>
114-
public class EnversIntegrationTests {
116+
class EnversIntegrationTests {
115117
116118
final PersonRepository repository;
117119
final TransactionTemplate tx;
@@ -181,15 +183,15 @@ public class EnversIntegrationTests {
181183
}
182184
}
183185
----
184-
<1> This references the application context configuration presented above
186+
<1> This references the application context configuration presented above.
185187
====
186188

187189
[[envers.resources]]
188190
== Further Resources
189191

190192
There is a https://github.com/spring-projects/spring-data-examples[Spring Data Envers example in the Spring Data Examples repository] that you can download and play around with to get a feel for how the library works.
191193

192-
You should also check out the https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/repository/history/RevisionRepository.html[Javadoc for `RevisionRepository`] and related classes.
194+
You should also check out the {spring-data-commons-javadoc-base}/org/springframework/data/repository/history/RevisionRepository.html[Javadoc for `RevisionRepository`] and related classes.
193195

194196
Questions are best asked at https://stackoverflow.com/questions/tagged/spring-data-envers[Stackoverflow using the `spring-data-envers` tag].
195197

0 commit comments

Comments
 (0)