Browse Source

DATAMONGO-1153 - Fix documentation build.

Movend jconsole.png to the images folder. Extracted MongoDB-specific auditing documentation into separate file for inclusion after the general auditing docs.
pull/269/merge
Oliver Gierke 11 years ago
parent
commit
819b424142
  1. 0
      src/main/asciidoc/images/jconsole.png
  2. 1
      src/main/asciidoc/index.adoc
  3. 33
      src/main/asciidoc/reference/mongo-auditing.adoc
  4. 33
      src/main/asciidoc/reference/mongodb.adoc

0
src/main/asciidoc/reference/jconsole.png → src/main/asciidoc/images/jconsole.png

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 48 KiB

1
src/main/asciidoc/index.adoc

@ -26,6 +26,7 @@ include::reference/introduction.adoc[] @@ -26,6 +26,7 @@ include::reference/introduction.adoc[]
include::reference/mongodb.adoc[]
include::reference/mongo-repositories.adoc[]
include::{spring-data-commons-docs}/auditing.adoc[]
include::reference/mongo-auditing.adoc[]
include::reference/mapping.adoc[]
include::reference/cross-store.adoc[]
include::reference/logging.adoc[]

33
src/main/asciidoc/reference/mongo-auditing.adoc

@ -0,0 +1,33 @@ @@ -0,0 +1,33 @@
[[mongo.auditing]]
== General auditing configuration
Activating auditing functionality is just a matter of adding the Spring Data Mongo `auditing` namespace element to your configuration:
.Activating auditing using XML configuration
====
[source,xml]
----
<mongo:auditing mapping-context-ref="customMappingContext" auditor-aware-ref="yourAuditorAwareImpl"/>
----
====
Since Spring Data MongoDB 1.4 auditing can be enabled by annotating a configuration class with the `@EnableMongoAuditing` annotation.
.Activating auditing using JavaConfig
====
[source,java]
----
@Configuration
@EnableMongoAuditing
class Config {
@Bean
public AuditorAware<AuditableUser> myAuditorProvider() {
return new AuditorAwareImpl();
}
}
----
====
If you expose a bean of type `AuditorAware` to the `ApplicationContext`, the auditing infrastructure will pick it up automatically and use it to determine the current user to be set on domain types. If you have multiple implementations registered in the `ApplicationContext`, you can select the one to be used by explicitly setting the `auditorAwareRef` attribute of `@EnableJpaAuditing`.

33
src/main/asciidoc/reference/mongodb.adoc

@ -415,39 +415,6 @@ If you need to configure additional options on the `com.mongodb.Mongo` instance @@ -415,39 +415,6 @@ If you need to configure additional options on the `com.mongodb.Mongo` instance
</bean>
----
[[mongo.auditing]]
== General auditing configuration
Activating auditing functionality is just a matter of adding the Spring Data Mongo `auditing` namespace element to your configuration:
.Activating auditing using XML configuration
====
[source,xml]
----
<mongo:auditing mapping-context-ref="customMappingContext" auditor-aware-ref="yourAuditorAwareImpl"/>
----
====
Since Spring Data MongoDB 1.4 auditing can be enabled by annotating a configuration class with the `@EnableMongoAuditing` annotation.
.Activating auditing using JavaConfig
====
[source,java]
----
@Configuration
@EnableMongoAuditing
class Config {
@Bean
public AuditorAware<AuditableUser> myAuditorProvider() {
return new AuditorAwareImpl();
}
}
----
====
If you expose a bean of type `AuditorAware` to the `ApplicationContext`, the auditing infrastructure will pick it up automatically and use it to determine the current user to be set on domain types. If you have multiple implementations registered in the `ApplicationContext`, you can select the one to be used by explicitly setting the `auditorAwareRef` attribute of `@EnableJpaAuditing`.
[[mongo-template]]
== Introduction to MongoTemplate

Loading…
Cancel
Save