Replace usage of JobLauncher with JobOperator in JobLaunchingGateway and JobLaunchingMessageHandler

Resolves #4924

Author: fmbenhassine

spring-batch-integration/src/main/java/org/springframework/batch/integration/config/xml/JobLaunchingGatewayParser.java

@@ -1,5 +1,5 @@
 /*
-   * Copyright 2002-2013 the original author or authors.
+   * Copyright 2002-2025 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.
@@ -17,7 +17,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import org.springframework.batch.core.launch.JobLauncher;
+import org.springframework.batch.core.launch.JobOperator;
 import org.springframework.batch.integration.launch.JobLaunchingGateway;
 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.xml.ParserContext;
@@ -28,10 +28,11 @@
 
 /**
  * The parser for the Job-Launching Gateway, which will instantiate a
- * {@link JobLaunchingGatewayParser}. If no {@link JobLauncher} reference has been
- * provided, this parse will use the use the globally registered bean 'jobLauncher'.
+ * {@link JobLaunchingGatewayParser}. If no {@link JobOperator} reference has been
+ * provided, this parse will use the globally registered bean 'jobOperator'.
  *
  * @author Gunnar Hillert
+ * @author Mahmoud Ben Hassine
  * @since 1.3
  *
  */
@@ -50,16 +51,16 @@ protected BeanDefinitionBuilder parseHandler(Element element, ParserContext pars
 		final BeanDefinitionBuilder jobLaunchingGatewayBuilder = BeanDefinitionBuilder
 			.genericBeanDefinition(JobLaunchingGateway.class);
 
-		final String jobLauncher = element.getAttribute("job-launcher");
+		final String jobOperator = element.getAttribute("job-operator");
 
-		if (StringUtils.hasText(jobLauncher)) {
-			jobLaunchingGatewayBuilder.addConstructorArgReference(jobLauncher);
+		if (StringUtils.hasText(jobOperator)) {
+			jobLaunchingGatewayBuilder.addConstructorArgReference(jobOperator);
 		}
 		else {
 			if (logger.isDebugEnabled()) {
-				logger.debug("No jobLauncher specified, using default 'jobLauncher' reference instead.");
+				logger.debug("No jobOperator specified, using default 'jobOperator' reference instead.");
 			}
-			jobLaunchingGatewayBuilder.addConstructorArgReference("jobLauncher");
+			jobLaunchingGatewayBuilder.addConstructorArgReference("jobOperator");
 		}
 
 		IntegrationNamespaceUtils.setValueIfAttributeDefined(jobLaunchingGatewayBuilder, element, "reply-timeout",

spring-batch-integration/src/main/java/org/springframework/batch/integration/launch/JobLaunchingGateway.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2025 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.
@@ -18,7 +18,7 @@
 
 import org.springframework.batch.core.job.JobExecution;
 import org.springframework.batch.core.job.JobExecutionException;
-import org.springframework.batch.core.launch.JobLauncher;
+import org.springframework.batch.core.launch.JobOperator;
 import org.springframework.integration.handler.AbstractReplyProducingMessageHandler;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessageHandlingException;
@@ -29,20 +29,21 @@
  * to a {@link JobLaunchingMessageHandler}.
  *
  * @author Gunnar Hillert
+ * @author Mahmoud Ben Hassine
  * @since 1.3
  */
 public class JobLaunchingGateway extends AbstractReplyProducingMessageHandler {
 
 	private final JobLaunchingMessageHandler jobLaunchingMessageHandler;
 
 	/**
-	 * Constructor taking a {@link JobLauncher} as parameter.
-	 * @param jobLauncher Must not be null.
+	 * Constructor taking a {@link JobOperator} as parameter.
+	 * @param jobOperator Must not be null.
 	 *
 	 */
-	public JobLaunchingGateway(JobLauncher jobLauncher) {
-		Assert.notNull(jobLauncher, "jobLauncher must not be null.");
-		this.jobLaunchingMessageHandler = new JobLaunchingMessageHandler(jobLauncher);
+	public JobLaunchingGateway(JobOperator jobOperator) {
+		Assert.notNull(jobOperator, "jobLauncher must not be null.");
+		this.jobLaunchingMessageHandler = new JobLaunchingMessageHandler(jobOperator);
 	}
 
 	/**

spring-batch-integration/src/main/java/org/springframework/batch/integration/launch/JobLaunchingMessageHandler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2023 the original author or authors.
+ * Copyright 2006-2025 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.
@@ -20,7 +20,7 @@
 import org.springframework.batch.core.job.JobExecution;
 import org.springframework.batch.core.job.JobExecutionException;
 import org.springframework.batch.core.job.parameters.JobParameters;
-import org.springframework.batch.core.launch.JobLauncher;
+import org.springframework.batch.core.launch.JobOperator;
 import org.springframework.integration.annotation.ServiceActivator;
 
 /**
@@ -30,19 +30,20 @@
  * @author Jonas Partner
  * @author Dave Syer
  * @author Gunnar Hillert
+ * @author Mahmoud Ben Hassine
  *
  */
 public class JobLaunchingMessageHandler implements JobLaunchRequestHandler {
 
-	private final JobLauncher jobLauncher;
+	private final JobOperator jobOperator;
 
 	/**
-	 * @param jobLauncher {@link org.springframework.batch.core.launch.JobLauncher} used
+	 * @param jobOperator {@link org.springframework.batch.core.launch.JobOperator} used
 	 * to execute Spring Batch jobs
 	 */
-	public JobLaunchingMessageHandler(JobLauncher jobLauncher) {
+	public JobLaunchingMessageHandler(JobOperator jobOperator) {
 		super();
-		this.jobLauncher = jobLauncher;
+		this.jobOperator = jobOperator;
 	}
 
 	@Override
@@ -51,7 +52,7 @@ public JobExecution launch(JobLaunchRequest request) throws JobExecutionExceptio
 		Job job = request.getJob();
 		JobParameters jobParameters = request.getJobParameters();
 
-		return jobLauncher.run(job, jobParameters);
+		return jobOperator.start(job, jobParameters);
 	}
 
 }

spring-batch-integration/src/main/resources/org/springframework/batch/integration/config/xml/spring-batch-integration.xsd

@@ -79,20 +79,20 @@
 							]]></xsd:documentation>
 				</xsd:annotation>
 			</xsd:attribute>
-			<xsd:attribute name="job-launcher" type="xsd:string">
+			<xsd:attribute name="job-operator" type="xsd:string">
 				<xsd:annotation>
 					<xsd:appinfo>
 						<xsd:documentation><![CDATA[
-								Pass in a custom JobLauncher bean reference.
+								Pass in a custom JobOperator bean reference.
 								This attribute is optional. If not specified the
 								adapter will re-use the default instance (under
-								the id 'jobLauncher', e.g. when using the
+								the id 'jobOperator', e.g. when using the
 								@EnableBatchProcessing annotation via JavaConfig).
 								If no default instance exists an exception is
 								thrown.
 							]]></xsd:documentation>
 						<tool:annotation kind="ref">
-							<tool:expected-type type="org.springframework.batch.core.launch.JobLauncher"/>
+							<tool:expected-type type="org.springframework.batch.core.launch.JobOperator"/>
 						</tool:annotation>
 					</xsd:appinfo>
 				</xsd:annotation>

spring-batch-integration/src/test/java/org/springframework/batch/integration/launch/JobLaunchingGatewayTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2025 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.
@@ -19,7 +19,7 @@
 import org.springframework.batch.core.job.Job;
 import org.springframework.batch.core.job.parameters.JobParameters;
 import org.springframework.batch.core.job.parameters.JobParametersInvalidException;
-import org.springframework.batch.core.launch.JobLauncher;
+import org.springframework.batch.core.launch.JobOperator;
 import org.springframework.batch.integration.JobSupport;
 import org.springframework.integration.support.MessageBuilder;
 import org.springframework.messaging.Message;
@@ -33,6 +33,7 @@
 
 /**
  * @author Gunnar Hillert
+ * @author Mahmoud Ben Hassine
  * @since 1.3
  *
  */
@@ -45,11 +46,11 @@ void testExceptionRaised() throws Exception {
 			.withPayload(new JobLaunchRequest(new JobSupport("testJob"), new JobParameters()))
 			.build();
 
-		final JobLauncher jobLauncher = mock();
-		when(jobLauncher.run(any(Job.class), any(JobParameters.class)))
+		final JobOperator jobOperator = mock();
+		when(jobOperator.start(any(Job.class), any(JobParameters.class)))
 			.thenThrow(new JobParametersInvalidException("This is a JobExecutionException."));
 
-		JobLaunchingGateway jobLaunchingGateway = new JobLaunchingGateway(jobLauncher);
+		JobLaunchingGateway jobLaunchingGateway = new JobLaunchingGateway(jobOperator);
 		Exception exception = assertThrows(MessageHandlingException.class,
 				() -> jobLaunchingGateway.handleMessage(message));
 		assertEquals("This is a JobExecutionException.", exception.getCause().getMessage());

spring-batch-integration/src/test/java/org/springframework/batch/integration/launch/JobLaunchingMessageHandlerTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2008-2023 the original author or authors.
+ * Copyright 2008-2025 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.
@@ -27,7 +27,7 @@
 import org.springframework.batch.core.job.JobExecution;
 import org.springframework.batch.core.job.JobInstance;
 import org.springframework.batch.core.job.parameters.JobParameters;
-import org.springframework.batch.core.launch.JobLauncher;
+import org.springframework.batch.core.launch.support.TaskExecutorJobOperator;
 import org.springframework.batch.integration.JobSupport;
 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
 
@@ -36,24 +36,24 @@ class JobLaunchingMessageHandlerTests {
 
 	JobLaunchRequestHandler messageHandler;
 
-	StubJobLauncher jobLauncher;
+	StubJobOperator jobOperator;
 
 	@BeforeEach
 	void setUp() {
-		jobLauncher = new StubJobLauncher();
-		messageHandler = new JobLaunchingMessageHandler(jobLauncher);
+		jobOperator = new StubJobOperator();
+		messageHandler = new JobLaunchingMessageHandler(jobOperator);
 	}
 
 	@Test
 	void testSimpleDelivery() throws Exception {
 		messageHandler.launch(new JobLaunchRequest(new JobSupport("testjob"), null));
 
-		assertEquals(1, jobLauncher.jobs.size(), "Wrong job count");
-		assertEquals("testjob", jobLauncher.jobs.get(0).getName(), "Wrong job name");
+		assertEquals(1, jobOperator.jobs.size(), "Wrong job count");
+		assertEquals("testjob", jobOperator.jobs.get(0).getName(), "Wrong job name");
 
 	}
 
-	private static class StubJobLauncher implements JobLauncher {
+	private static class StubJobOperator extends TaskExecutorJobOperator {
 
 		List<Job> jobs = new ArrayList<>();
 
@@ -62,7 +62,7 @@ private static class StubJobLauncher implements JobLauncher {
 		AtomicLong jobId = new AtomicLong();
 
 		@Override
-		public JobExecution run(Job job, JobParameters jobParameters) {
+		public JobExecution start(Job job, JobParameters jobParameters) {
 			jobs.add(job);
 			parameters.add(jobParameters);
 			return new JobExecution(new JobInstance(jobId.getAndIncrement(), job.getName()), jobParameters);