Rename MongoItemReader to MongoPagingItemReader

Resolves #4341

Author: fmbenhassine

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoItemReader.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 the original author or authors.
+ * Copyright 2012-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -77,26 +77,29 @@
  * @author Takaaki Iida
  * @author Mahmoud Ben Hassine
  * @author Parikshit Dutta
+ * @deprecated Use {@link MongoPagingItemReader} instead. Scheduled for removal in v5.3 or
+ * later.
  */
+@Deprecated(since = "5.1", forRemoval = true)
 public class MongoItemReader<T> extends AbstractPaginatedDataItemReader<T> implements InitializingBean {
 
-	private MongoOperations template;
+	protected MongoOperations template;
 
-	private Query query;
+	protected Query query;
 
-	private String queryString;
+	protected String queryString;
 
-	private Class<? extends T> type;
+	protected Class<? extends T> type;
 
-	private Sort sort;
+	protected Sort sort;
 
-	private String hint;
+	protected String hint;
 
-	private String fields;
+	protected String fields;
 
-	private String collection;
+	protected String collection;
 
-	private List<Object> parameterValues = new ArrayList<>();
+	protected List<Object> parameterValues = new ArrayList<>();
 
 	public MongoItemReader() {
 		super();
@@ -243,14 +246,14 @@ public void afterPropertiesSet() throws Exception {
 		}
 	}
 
-	private String replacePlaceholders(String input, List<Object> values) {
+	protected String replacePlaceholders(String input, List<Object> values) {
 		ParameterBindingJsonReader reader = new ParameterBindingJsonReader(input, values.toArray());
 		DecoderContext decoderContext = DecoderContext.builder().build();
 		Document document = new ParameterBindingDocumentCodec().decode(reader, decoderContext);
 		return document.toJson();
 	}
 
-	private Sort convertToSort(Map<String, Sort.Direction> sorts) {
+	protected Sort convertToSort(Map<String, Sort.Direction> sorts) {
 		List<Sort.Order> sortValues = new ArrayList<>(sorts.size());
 
 		for (Map.Entry<String, Sort.Direction> curSort : sorts.entrySet()) {

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/MongoPagingItemReader.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2012-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.batch.item.data;
+
+import org.springframework.batch.item.ExecutionContext;
+import org.springframework.batch.item.ItemReader;
+import org.springframework.data.mongodb.core.query.Query;
+import org.springframework.util.ClassUtils;
+
+/**
+ * <p>
+ * Restartable {@link ItemReader} that reads documents from MongoDB via a paging
+ * technique.
+ * </p>
+ *
+ * <p>
+ * If you set JSON String query {@link #setQuery(String)} then it executes the JSON to
+ * retrieve the requested documents.
+ * </p>
+ *
+ * <p>
+ * If you set Query object {@link #setQuery(Query)} then it executes the Query to retrieve
+ * the requested documents.
+ * </p>
+ *
+ * <p>
+ * The query is executed using paged requests specified in the {@link #setPageSize(int)}.
+ * Additional pages are requested as needed to provide data when the {@link #read()}
+ * method is called.
+ * </p>
+ *
+ * <p>
+ * The JSON String query provided supports parameter substitution via ?&lt;index&gt;
+ * placeholders where the &lt;index&gt; indicates the index of the parameterValue to
+ * substitute.
+ * </p>
+ *
+ * <p>
+ * The implementation is thread-safe between calls to {@link #open(ExecutionContext)}, but
+ * remember to use <code>saveState=false</code> if used in a multi-threaded client (no
+ * restart available).
+ * </p>
+ *
+ * @param <T> type of items to read
+ * @since 5.1
+ * @author Michael Minella
+ * @author Takaaki Iida
+ * @author Mahmoud Ben Hassine
+ * @author Parikshit Dutta
+ */
+public class MongoPagingItemReader<T> extends MongoItemReader<T> {
+
+	/**
+	 * Create a new {@link MongoPagingItemReader}.
+	 */
+	public MongoPagingItemReader() {
+		setName(ClassUtils.getShortName(MongoPagingItemReader.class));
+	}
+
+}

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/builder/MongoItemReaderBuilder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2022 the original author or authors.
+ * Copyright 2017-2023 the original author or authors.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -37,36 +37,39 @@
  * @author Parikshit Dutta
  * @since 4.0
  * @see MongoItemReader
+ * @deprecated Use {@link MongoPagingItemReaderBuilder} instead. Scheduled for removal in
+ * v5.3 or later.
  */
+@Deprecated(since = "5.1", forRemoval = true)
 public class MongoItemReaderBuilder<T> {
 
-	private MongoOperations template;
+	protected MongoOperations template;
 
-	private String jsonQuery;
+	protected String jsonQuery;
 
-	private Class<? extends T> targetType;
+	protected Class<? extends T> targetType;
 
-	private Map<String, Sort.Direction> sorts;
+	protected Map<String, Sort.Direction> sorts;
 
-	private String hint;
+	protected String hint;
 
-	private String fields;
+	protected String fields;
 
-	private String collection;
+	protected String collection;
 
-	private List<Object> parameterValues = new ArrayList<>();
+	protected List<Object> parameterValues = new ArrayList<>();
 
 	protected int pageSize = 10;
 
-	private boolean saveState = true;
+	protected boolean saveState = true;
 
-	private String name;
+	protected String name;
 
-	private int maxItemCount = Integer.MAX_VALUE;
+	protected int maxItemCount = Integer.MAX_VALUE;
 
-	private int currentItemCount;
+	protected int currentItemCount;
 
-	private Query query;
+	protected Query query;
 
 	/**
 	 * Configure if the state of the