Add method in JobRepository to find job instances by job name

fmbenhassine · fmbenhassine · commit 03497b37cced · 2025-09-30T23:43:38.000+02:00
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobOperator.java b/spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobOperator.java
@@ -286,7 +286,7 @@ JobExecution startNextInstance(Job job) throws JobRestartException, JobExecution
 	 * @throws NoSuchJobException is thrown if no {@link JobInstance}s for the jobName
 	 * exist.
 	 * @deprecated Since 6.0 in favor of
-	 * {@link org.springframework.batch.core.repository.JobRepository#getJobInstances(String, int, int)}.
+	 * {@link org.springframework.batch.core.repository.JobRepository#findJobInstances(String)}.
 	 * Scheduled for removal in 6.2 or later.
 	 */
 	@Deprecated(since = "6.0", forRemoval = true)
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/JobRepository.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/JobRepository.java
@@ -87,6 +87,16 @@ default List<JobInstance> getJobInstances(String jobName, int start, int count)
 		return Collections.emptyList();
 	}
 
+	/**
+	 * Fetch all {@link JobInstance} values for a given job name.
+	 * @param jobName The name of the job.
+	 * @return the {@link JobInstance} values.
+	 * @since 6.0
+	 */
+	default List<JobInstance> findJobInstances(String jobName) {
+		return Collections.emptyList();
+	}
+
 	/**
 	 * @param jobInstanceId The ID for the {@link JobInstance} to obtain.
 	 * @return the {@code JobInstance} that has this ID, or {@code null} if not found.
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobInstanceDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobInstanceDao.java
@@ -92,6 +92,16 @@ public interface JobInstanceDao {
 	 */
 	List<JobInstance> getJobInstances(String jobName, int start, int count);
 
+	/**
+	 * Fetch all job instances for the given job name.
+	 * @param jobName the job name
+	 * @return the job instances for the given name empty if none
+	 * @since 6.0
+	 */
+	default List<JobInstance> getJobInstances(String jobName) {
+		return getJobInstanceIds(jobName).stream().map(jobInstanceId -> getJobInstance(jobInstanceId)).toList();
+	}
+
 	/**
 	 * Fetch the last job instance by Id for the given job.
 	 * @param jobName name of the job
@@ -131,7 +141,7 @@ default List<Long> getJobInstanceIds(String jobName) {
 	 * @param count int containing the number of job instances to return.
 	 * @return a list of {@link JobInstance} for the job name requested.
 	 * @deprecated Since v6.0 and scheduled for removal in v6.2. Use
-	 * {@link #getJobInstances(String, int, int)}
+	 * {@link #getJobInstances(String)}
 	 */
 	@Deprecated(forRemoval = true)
 	List<JobInstance> findJobInstancesByName(String jobName, int start, int count);
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobInstanceDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcJobInstanceDao.java
@@ -114,6 +114,12 @@ SELECT COUNT(*)
 			ORDER BY JOB_INSTANCE_ID DESC
 			""";
 
+	private static final String FIND_JOB_INSTANCES_BY_JOB_NAME = """
+			SELECT JOB_INSTANCE_ID, JOB_NAME
+			FROM %PREFIX%JOB_INSTANCE
+			WHERE JOB_NAME LIKE ?
+			""";
+
 	private static final String FIND_LAST_JOB_INSTANCE_BY_JOB_NAME = """
 			SELECT JOB_INSTANCE_ID, JOB_NAME
 			FROM %PREFIX%JOB_INSTANCE I1
@@ -236,6 +242,17 @@ public List<JobInstance> extractData(ResultSet rs) throws SQLException, DataAcce
 		return getJdbcTemplate().query(getQuery(FIND_LAST_JOBS_BY_NAME), extractor, jobName);
 	}
 
+	/**
+	 * Fetch all job instances for the given job name.
+	 * @param jobName the job name
+	 * @return the job instances for the given name empty if none
+	 * @since 6.0
+	 */
+	@Override
+	public List<JobInstance> getJobInstances(String jobName) {
+		return getJdbcTemplate().query(getQuery(FIND_JOB_INSTANCES_BY_JOB_NAME), new JobInstanceRowMapper(), jobName);
+	}
+
 	@Override
 	public List<Long> getJobInstanceIds(String jobName) {
 		return getJdbcTemplate().queryForList(getQuery(GET_JOB_INSTANCE_IDS_BY_JOB_NAME), Long.class, jobName);
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoJobInstanceDao.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoJobInstanceDao.java
@@ -124,6 +124,32 @@ public List<JobInstance> getJobInstances(String jobName, int start, int count) {
 			.toList();
 	}
 
+	/**
+	 * Fetch all job instances for the given job name.
+	 * @param jobName the job name
+	 * @return the job instances for the given name empty if none
+	 * @since 6.0
+	 */
+	@Override
+	public List<JobInstance> getJobInstances(String jobName) {
+		Query query = query(where("jobName").is(jobName));
+		return this.mongoOperations
+			.find(query, org.springframework.batch.core.repository.persistence.JobInstance.class, COLLECTION_NAME)
+			.stream()
+			.map(this.jobInstanceConverter::toJobInstance)
+			.toList();
+	}
+
+	@Override
+	public List<Long> getJobInstanceIds(String jobName) {
+		Query query = query(where("jobName").is(jobName));
+		return this.mongoOperations
+			.find(query, org.springframework.batch.core.repository.persistence.JobInstance.class, COLLECTION_NAME)
+			.stream()
+			.map(org.springframework.batch.core.repository.persistence.JobInstance::getJobInstanceId)
+			.toList();
+	}
+
 	public List<JobInstance> findJobInstancesByName(String jobName) {
 		Query query = query(where("jobName").is(jobName));
 		return this.mongoOperations
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/ResourcelessJobRepository.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/ResourcelessJobRepository.java
@@ -81,6 +81,21 @@ public List<JobInstance> getJobInstances(String jobName, int start, int count) {
 		return Collections.singletonList(this.jobInstance);
 	}
 
+	/**
+	 * Find all {@link JobInstance}s for a given job name. In this implementation, only
+	 * one job instance is held, so if it is initialized, it is returned in a single-item
+	 * list.
+	 * @param jobName The name of the job to query.
+	 * @return a list of {@link JobInstance}s for the given job name.
+	 */
+	@Override
+	public List<JobInstance> findJobInstances(String jobName) {
+		if (this.jobInstance == null) {
+			return Collections.emptyList();
+		}
+		return Collections.singletonList(this.jobInstance);
+	}
+
 	@Override
 	@Nullable
 	public JobInstance getJobInstance(long instanceId) {
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/SimpleJobRepository.java b/spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/SimpleJobRepository.java
@@ -69,6 +69,17 @@ public SimpleJobRepository(JobInstanceDao jobInstanceDao, JobExecutionDao jobExe
 		super(jobInstanceDao, jobExecutionDao, stepExecutionDao, ecDao);
 	}
 
+	/**
+	 * Fetch all {@link JobInstance} values for a given job name.
+	 * @param jobName The name of the job.
+	 * @return the {@link JobInstance} values.
+	 * @since 6.0
+	 */
+	@Override
+	public List<JobInstance> findJobInstances(String jobName) {
+		return this.jobInstanceDao.getJobInstances(jobName);
+	}
+
 	/**
 	 * Create a new {@link JobExecution} for the given {@link JobInstance} and
 	 * {@link JobParameters}, and associate the provided {@link ExecutionContext} with the
diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/repository/support/SimpleJobRepositoryIntegrationTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/repository/support/SimpleJobRepositoryIntegrationTests.java
@@ -275,7 +275,7 @@ void testDeleteJobInstance() throws Exception {
 
 		jobRepository.deleteJobInstance(jobExecution.getJobInstance());
 
-		assertEquals(0, jobRepository.getJobInstances(job.getName(), 0, 1).size());
+		assertEquals(0, jobRepository.findJobInstances(job.getName()).size());
 		assertNull(jobRepository.getLastJobExecution(job.getName(), jobParameters));
 	}
 
diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/partition/JmsIntegrationTests.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/partition/JmsIntegrationTests.java
@@ -60,9 +60,9 @@ void testSimpleProperties() {
 
 	@Test
 	void testLaunchJob() throws Exception {
-		int before = jobRepository.getJobInstances(job.getName(), 0, 100).size();
+		int before = jobRepository.findJobInstances(job.getName()).size();
 		assertNotNull(jobOperator.start(job, new JobParameters()));
-		List<JobInstance> jobInstances = jobRepository.getJobInstances(job.getName(), 0, 100);
+		List<JobInstance> jobInstances = jobRepository.findJobInstances(job.getName());
 		int after = jobInstances.size();
 		assertEquals(1, after - before);
 		JobExecution jobExecution = jobRepository.getJobExecutions(jobInstances.get(jobInstances.size() - 1)).get(0);
diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/partition/PollingIntegrationTests.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/partition/PollingIntegrationTests.java
@@ -55,9 +55,9 @@ void testSimpleProperties() {
 
 	@Test
 	void testLaunchJob() throws Exception {
-		int before = jobRepository.getJobInstances(job.getName(), 0, 100).size();
+		int before = jobRepository.findJobInstances(job.getName()).size();
 		assertNotNull(jobOperator.start(job, new JobParameters()));
-		List<JobInstance> jobInstances = jobRepository.getJobInstances(job.getName(), 0, 100);
+		List<JobInstance> jobInstances = jobRepository.findJobInstances(job.getName());
 		int after = jobInstances.size();
 		assertEquals(1, after - before);
 		JobExecution jobExecution = jobRepository.getJobExecutions(jobInstances.get(jobInstances.size() - 1)).get(0);
diff --git a/spring-batch-integration/src/test/java/org/springframework/batch/integration/partition/VanillaIntegrationTests.java b/spring-batch-integration/src/test/java/org/springframework/batch/integration/partition/VanillaIntegrationTests.java
@@ -54,9 +54,9 @@ void testSimpleProperties() {
 
 	@Test
 	void testLaunchJob() throws Exception {
-		int before = jobRepository.getJobInstances(job.getName(), 0, 100).size();
+		int before = jobRepository.findJobInstances(job.getName()).size();
 		assertNotNull(jobOperator.start(job, new JobParameters()));
-		List<JobInstance> jobInstances = jobRepository.getJobInstances(job.getName(), 0, 100);
+		List<JobInstance> jobInstances = jobRepository.findJobInstances(job.getName());
 		int after = jobInstances.size();
 		assertEquals(1, after - before);
 		JobExecution jobExecution = jobRepository.getJobExecutions(jobInstances.get(jobInstances.size() - 1)).get(0);
diff --git a/spring-batch-samples/src/test/java/org/springframework/batch/samples/amqp/AmqpJobFunctionalTests.java b/spring-batch-samples/src/test/java/org/springframework/batch/samples/amqp/AmqpJobFunctionalTests.java
@@ -81,7 +81,7 @@ void testLaunchJobWithXmlConfig() throws Exception {
 		this.jobOperatorTestUtils.startJob();
 
 		// when
-		int count = jobRepository.getJobInstances("amqp-example-job", 0, 1).size();
+		int count = jobRepository.findJobInstances("amqp-example-job").size();
 
 		// then
 		assertTrue(count > 0);
@@ -100,7 +100,7 @@ public void testLaunchJobWithJavaConfig() throws Exception {
 
 		// then
 		JobRepository localJobRepository = context.getBean(JobRepository.class);
-		int count = localJobRepository.getJobInstances("amqp-config-job", 0, 1).size();
+		int count = localJobRepository.findJobInstances("amqp-config-job").size();
 		assertTrue(count > 0);
 	}
 
diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/JobRepositoryTestUtils.java b/spring-batch-test/src/main/java/org/springframework/batch/test/JobRepositoryTestUtils.java
@@ -167,18 +167,12 @@ public void removeJobExecution(JobExecution jobExecution) {
 	public void removeJobExecutions() {
 		List<String> jobNames = this.jobRepository.getJobNames();
 		for (String jobName : jobNames) {
-			int start = 0;
-			int count = 100;
-			List<JobInstance> jobInstances = this.jobRepository.getJobInstances(jobName, start, count);
-			while (!jobInstances.isEmpty()) {
-				for (JobInstance jobInstance : jobInstances) {
-					List<JobExecution> jobExecutions = this.jobRepository.getJobExecutions(jobInstance);
-					if (jobExecutions != null && !jobExecutions.isEmpty()) {
-						removeJobExecutions(jobExecutions);
-					}
+			List<JobInstance> jobInstances = this.jobRepository.findJobInstances(jobName);
+			for (JobInstance jobInstance : jobInstances) {
+				List<JobExecution> jobExecutions = this.jobRepository.getJobExecutions(jobInstance);
+				if (jobExecutions != null && !jobExecutions.isEmpty()) {
+					removeJobExecutions(jobExecutions);
 				}
-				start += count;
-				jobInstances = this.jobRepository.getJobInstances(jobName, start, count);
 			}
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -275,7 +275,7 @@ void testDeleteJobInstance() throws Exception {`
`275`	`275`
`276`	`276`	`jobRepository.deleteJobInstance(jobExecution.getJobInstance());`
`277`	`277`
`278`		`- assertEquals(0, jobRepository.getJobInstances(job.getName(), 0, 1).size());`
	`278`	`+ assertEquals(0, jobRepository.findJobInstances(job.getName()).size());`
`279`	`279`	`assertNull(jobRepository.getLastJobExecution(job.getName(), jobParameters));`
`280`	`280`	`}`
`281`	`281`