Update javadocs

spring-projects · Nov 21, 2024 · 1105d22 · 1105d22
1 parent 0d42569
commit 1105d22
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/...main/java/org/springframework/batch/core/explore/support/MongoJobExplorerFactoryBean.java b/...main/java/org/springframework/batch/core/explore/support/MongoJobExplorerFactoryBean.java
@@ -25,9 +25,17 @@
 import org.springframework.batch.core.repository.dao.MongoStepExecutionDao;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.data.mongodb.core.MongoOperations;
+import org.springframework.data.mongodb.core.convert.MappingMongoConverter;
 import org.springframework.util.Assert;
 
 /**
+ * This factory bean creates a job explorer backed by MongoDB. It requires a mongo
+ * template and a mongo transaction manager. <strong>The mongo template must be configured
+ * with a {@link MappingMongoConverter} having a {@code MapKeyDotReplacement} set to a non
+ * null value. See {@code MongoDBJobRepositoryIntegrationTests} for an example. This is
+ * required to support execution context keys containing dots (like "step.type" or
+ * "batch.version")</strong>
+ *
  * @author Mahmoud Ben Hassine
  * @since 5.2.0
  */

diff --git a/...java/org/springframework/batch/core/repository/support/MongoJobRepositoryFactoryBean.java b/...java/org/springframework/batch/core/repository/support/MongoJobRepositoryFactoryBean.java
@@ -25,9 +25,17 @@
 import org.springframework.batch.core.repository.dao.MongoStepExecutionDao;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.data.mongodb.core.MongoOperations;
+import org.springframework.data.mongodb.core.convert.MappingMongoConverter;
 import org.springframework.util.Assert;
 
 /**
+ * This factory bean creates a job repository backed by MongoDB. It requires a mongo
+ * template and a mongo transaction manager. <strong>The mongo template must be configured
+ * with a {@link MappingMongoConverter} having a {@code MapKeyDotReplacement} set to a non
+ * null value. See {@code MongoDBJobRepositoryIntegrationTests} for an example. This is
+ * required to support execution context keys containing dots (like "step.type" or
+ * "batch.version")</strong>
+ *
  * @author Mahmoud Ben Hassine
  * @since 5.2.0
  */