+# Latest news
-# Spring Batch [](https://build.spring.io/browse/BATCH-GRAD)
+* June 10, 2026: [Spring Batch 6.0.4 and 5.2.6 released](https://spring.io/blog/2026/06/10/spring-batch-6-0-4-and-5-2-6-available-now)
+* March 18, 2026: [Spring Batch 6.0.3 and 5.2.5 released](https://spring.io/blog/2026/03/18/spring-batch-6-0-3-and-5-2-5-available-now)
+* January 21, 2026: [Spring Batch 6.0.2 is out](https://spring.io/blog/2026/01/21/spring-batch-6-0-2-available-now)
+* December 17, 2025: [Spring Batch 6.0.1 available now](https://spring.io/blog/2025/12/17/spring-batch-6-0-1-available-now)
+* November 19, 2025: [Spring Batch 6.0.0 GA is out!](https://spring.io/blog/2025/11/19/spring-batch-6-0-0-ga)
-Spring Batch is a lightweight, comprehensive batch framework designed to enable the development of robust batch applications vital for the daily operations of enterprise systems. Spring Batch builds upon the productivity, POJO-based development approach, and general ease of use capabilities people have come to know from the [Spring Framework](https://github.com/SpringSource/spring-framework), while making it easy for developers to access and leverage more advanced enterprise services when necessary.
+# Spring Batch [](https://github.com/spring-projects/spring-batch/actions/workflows/continuous-integration.yml)
-If you are looking for a runtime orchestration tool for your Batch applications, or need a management console to view current and historic executions, take a look at [Spring Cloud Data Flow](https://cloud.spring.io/spring-cloud-dataflow/). It is an orchestration tool for deploying and executing data integration based microservices including Spring Batch applications.
+Spring Batch is a lightweight, comprehensive batch framework designed to enable the development of robust batch applications vital for the daily operations of enterprise systems. Spring Batch builds upon the productivity, POJO-based development approach, and general ease of use capabilities people have come to know from the [Spring Framework](https://github.com/spring-projects/spring-framework), while making it easy for developers to access and leverage more advanced enterprise services when necessary.
+
+# Getting Started
+
+## Two minutes tutorial
+
+This quick tutorial shows you how to setup a minimal project to run a simple batch job with Spring Batch.
+
+In your favorite IDE, create a new Maven-based Java 17+ project and add the following dependency to your `pom.xml`:
+
+```xml
+- * The 'merge' extension should be used to define how projects are merged, for example: - *
- * configure(subprojects) {
- * apply plugin: MergePlugin
- * }
- *
- * project("myproject") {
- * }
- *
- * project("myproject-extra") {
- * merge.into = project("myproject")
- * }
- *
- * - * This plugin adds two new configurations: - *
-
- *
- merging - Contains the projects being merged into this project
- - *
- runtimeMerge - Contains all dependencies that are merge projects. These are used - * to allow an IDE to reference merge projects. - *
- a {@link JobRepository} (bean name "jobRepository") - *
- a {@link JobLauncher} (bean name "jobLauncher") - *
- a {@link JobRegistry} (bean name "jobRegistry") - *
- a {@link org.springframework.batch.core.explore.JobExplorer} (bean name "jobExplorer") - *
- a {@link PlatformTransactionManager} (bean name "transactionManager") - *
- a {@link JobBuilderFactory} (bean name "jobBuilders") as a convenience to prevent you from having to inject the - * job repository into every job, as in the examples above - *
- a {@link StepBuilderFactory} (bean name "stepBuilders") as a convenience to prevent you from having to inject the - * job repository and transaction manager into every step - *
- {@link org.springframework.batch.support.transaction.ResourcelessTransactionManager} - * if no {@link javax.sql.DataSource} is provided within the context - *
- {@link org.springframework.jdbc.datasource.DataSourceTransactionManager} - * if a {@link javax.sql.DataSource} is provided within the context + *
- a {@link JobRepository} (bean name "jobRepository" of type + * {@link org.springframework.batch.core.repository.support.ResourcelessJobRepository}) + *
- a {@link org.springframework.batch.core.launch.JobOperator} (bean name + * "jobOperator" of type + * {@link org.springframework.batch.core.launch.support.TaskExecutorJobOperator}) *
- a {@link ResourcelessJobRepository} named "jobRepository" + *
- a {@link TaskExecutorJobOperator} named "jobOperator" + *
- a {@link org.springframework.batch.core.scope.StepScope} named "stepScope" + *
- a {@link org.springframework.batch.core.scope.JobScope} named "jobScope" + *
- a {@link JobRepository} named "jobRepository" + *
- a {@link JobOperator} named "jobOperator" + *
- a {@link org.springframework.batch.core.scope.StepScope} named "stepScope" + *
- a {@link org.springframework.batch.core.scope.JobScope} named "jobScope" + *
- a {@link JobRepository} named "jobRepository" + *
- a {@link JobOperator} named "jobOperator" + *
- a {@link org.springframework.batch.core.scope.StepScope} named "stepScope" + *
- a {@link org.springframework.batch.core.scope.JobScope} named "jobScope" + *
- Inject "jobRepository" into any {@link JobParserJobFactoryBean} - * without a jobRepository. - *
- Inject "transactionManager" into any - * {@link StepParserStepFactoryBean} without a transactionManager. - *
- Inject "jobRepository" into any {@link JobParserJobFactoryBean} without a + * jobRepository. + *
- Inject "transactionManager" into any {@link StepParserStepFactoryBean} without + * a transactionManager. + *
-
- *
- * @author Rob Winch
- * @author Phillip Webb
- */
-class MergePlugin implements Plugin
-
-
-
-
+ * {@code ExitStatus} is immutable and, therefore, thread-safe.
*
* @author Dave Syer
+ * @author Mahmoud Ben Hassine
+ * @author JiWon Seo
+ * @author Yanming Zhou
*
*/
-@SuppressWarnings("serial")
public class ExitStatus implements Serializable, Comparable
+ * Public getter for the exit exception.
+ * @return the exception that caused the step to exit
+ * @since 6.0.3
+ */
+ @Nullable public Throwable getExitException() {
+ return this.exitException;
+ }
+
+ /**
+ * Create a new {@link ExitStatus} with a logical combination of the exit code and a
+ * concatenation of the descriptions. If either value has a higher severity, its exit
+ * code is used in the result. In the case of equal severity, the exit code is
+ * replaced if the new value is alphabetically greater.
*
*
* Severity is defined by the exit code:
@@ -121,17 +153,20 @@ public String getExitDescription() {
*
* - * If the input is null just return this. - * - * @param status an {@link ExitStatus} to combine with this one. - * @return a new {@link ExitStatus} combining the current value and the - * argument provided. + * If the input is {@code null} just return this. + * @param status An {@link ExitStatus} object to combine with this one. + * @return a new {@link ExitStatus} combining the current value and the argument + * provided. */ - public ExitStatus and(ExitStatus status) { + public ExitStatus and(@Nullable ExitStatus status) { if (status == null) { return this; } ExitStatus result = addExitDescription(status.exitDescription); + Throwable exitException = status.exitException; + if (exitException != null) { + result = result.withExitException(exitException); + } if (compareTo(status) < 0) { result = result.replaceExitCode(status.exitCode); } @@ -139,8 +174,9 @@ public ExitStatus and(ExitStatus status) { } /** - * @param status an {@link ExitStatus} to compare - * @return greater than zero, 0, less than zero according to the severity and exit code + * @param status An {@link ExitStatus} to compare + * @return greater than zero, 0, or less than zero, according to the severity and exit + * code. * @see java.lang.Comparable */ @Override @@ -155,8 +191,10 @@ public int compareTo(ExitStatus status) { } /** - * @param status - * @return + * Determines severity (an int between 1 and 7, inclusive) based on an + * {@code ExitStatus} object. + * @param status The {@code ExitStatus} object from which to determine the severity. + * @return the severity number. */ private int severity(ExitStatus status) { if (status.exitCode.startsWith(EXECUTING.exitCode)) { @@ -180,27 +218,25 @@ private int severity(ExitStatus status) { return 7; } - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() - */ @Override public String toString() { - return String.format("exitCode=%s;exitDescription=%s", exitCode, exitDescription); + return String.format("exitCode=%s;exitDescription=%s;exitException=%s", exitCode, exitDescription, + exitException); } /** - * Compare the fields one by one. + * Compare the fields, one by one. * * @see java.lang.Object#equals(java.lang.Object) */ @Override - public boolean equals(Object obj) { - if (obj == null) { + public boolean equals(@Nullable Object o) { + if (o == null || getClass() != o.getClass()) { return false; } - return toString().equals(obj.toString()); + ExitStatus that = (ExitStatus) o; + return Objects.equals(exitCode, that.exitCode) && Objects.equals(exitDescription, that.exitDescription) + && Objects.equals(exitException, that.exitException); } /** @@ -210,16 +246,14 @@ public boolean equals(Object obj) { */ @Override public int hashCode() { - return toString().hashCode(); + return Objects.hash(exitCode, exitDescription, exitException); } /** - * Add an exit code to an existing {@link ExitStatus}. If there is already a - * code present tit will be replaced. - * - * @param code the code to add - * @return a new {@link ExitStatus} with the same properties but a new exit - * code. + * Add an exit code to an existing {@link ExitStatus}. If there is already a code + * present, it will be replaced. + * @param code The code to add. + * @return a new {@link ExitStatus} with the same properties but a new exit code. */ public ExitStatus replaceExitCode(String code) { return new ExitStatus(code, exitDescription); @@ -227,43 +261,49 @@ public ExitStatus replaceExitCode(String code) { /** * Check if this status represents a running process. - * - * @return true if the exit code is "EXECUTING" or "UNKNOWN" + * @return {@code true} if the exit code is {@code EXECUTING} or {@code UNKNOWN}. */ public boolean isRunning() { - return "EXECUTING".equals(this.exitCode) || "UNKNOWN".equals(this.exitCode); + return EXECUTING.exitCode.equals(this.exitCode) || UNKNOWN.exitCode.equals(this.exitCode); } /** - * Add an exit description to an existing {@link ExitStatus}. If there is - * already a description present the two will be concatenated with a - * semicolon. - * - * @param description the description to add + * Add an exit description to an existing {@link ExitStatus}. If there is already a + * description present, the two are concatenated with a semicolon. + * @param description The description to add. * @return a new {@link ExitStatus} with the same properties but a new exit - * description + * description. */ public ExitStatus addExitDescription(String description) { - StringBuilder buffer = new StringBuilder(); - boolean changed = StringUtils.hasText(description) && !exitDescription.equals(description); if (StringUtils.hasText(exitDescription)) { - buffer.append(exitDescription); - if (changed) { + if (StringUtils.hasText(description) && !exitDescription.equals(description)) { + StringBuilder buffer = new StringBuilder(description.length() + 2 + exitDescription.length()); + buffer.append(exitDescription); buffer.append("; "); + buffer.append(description); + return new ExitStatus(exitCode, buffer.toString()); } + return this; } - if (changed) { - buffer.append(description); + else { + return new ExitStatus(exitCode, description); } - return new ExitStatus(exitCode, buffer.toString()); } /** - * Extract the stack trace from the throwable provided and append it to - * the exist description. - * - * @param throwable {@link Throwable} instance containing the stack trace. - * @return a new ExitStatus with the stack trace appended + * Create new instance with the exit exception. + * @param exitException the last exception that caused the step to exit + * @since 6.0.4 + */ + public ExitStatus withExitException(Throwable exitException) { + return new ExitStatus(this.exitCode, this.exitDescription, exitException); + } + + /** + * Extract the stack trace from the throwable provided and append it to the existing + * description. + * @param throwable A {@link Throwable} instance containing the stack trace. + * @return a new ExitStatus with the stack trace appended. */ public ExitStatus addExitDescription(Throwable throwable) { StringWriter writer = new StringWriter(); @@ -273,16 +313,17 @@ public ExitStatus addExitDescription(Throwable throwable) { } /** - * @param status the exit code to be evaluated - * @return true if the value matches a known exit code + * @param status The {@code ExitStatus} object containing the exit code to be + * evaluated. + * @return {@code true} if the value matches a known exit code. */ - public static boolean isNonDefaultExitStatus(ExitStatus status) { - return status == null || status.getExitCode() == null || - status.getExitCode().equals(ExitStatus.COMPLETED.getExitCode()) || - status.getExitCode().equals(ExitStatus.EXECUTING.getExitCode()) || - status.getExitCode().equals(ExitStatus.FAILED.getExitCode()) || - status.getExitCode().equals(ExitStatus.NOOP.getExitCode()) || - status.getExitCode().equals(ExitStatus.STOPPED.getExitCode()) || - status.getExitCode().equals(ExitStatus.UNKNOWN.getExitCode()); + public static boolean isNonDefaultExitStatus(@Nullable ExitStatus status) { + return status == null || status.getExitCode().equals(ExitStatus.COMPLETED.getExitCode()) + || status.getExitCode().equals(ExitStatus.EXECUTING.getExitCode()) + || status.getExitCode().equals(ExitStatus.FAILED.getExitCode()) + || status.getExitCode().equals(ExitStatus.NOOP.getExitCode()) + || status.getExitCode().equals(ExitStatus.STOPPED.getExitCode()) + || status.getExitCode().equals(ExitStatus.UNKNOWN.getExitCode()); } + } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/ItemProcessListener.java b/spring-batch-core/src/main/java/org/springframework/batch/core/ItemProcessListener.java deleted file mode 100644 index dbb79421e7..0000000000 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/ItemProcessListener.java +++ /dev/null @@ -1,57 +0,0 @@ -/* - * Copyright 2006-2018 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 - * - * http://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.core; - -import org.springframework.batch.item.ItemProcessor; -import org.springframework.lang.Nullable; - -/** - * Listener interface for the processing of an item. Implementations - * of this interface will be notified before and after an item is - * passed to the {@link ItemProcessor} and in the event of any - * exceptions thrown by the processor. - * - * @author Dave Syer - * @author Mahmoud Ben Hassine - * - */ -public interface ItemProcessListener
- * Listener interface for the writing of items. Implementations - * of this interface will be notified before, after, and in case - * of any exception thrown while writing a list of items. - *
- * - *- * Note: This listener is designed to work around the - * lifecycle of an item. This means that each method should be - * called once within the lifecycle of an item and in fault - * tolerant scenarios, any transactional work that is done in - * one of these methods would be rolled back and not re-applied. - * Because of this, it is recommended to not perform any logic - * using this listener that participates in a transaction. - *
- * - * @author Lucas Ward - * - */ -public interface ItemWriteListenerLong value or {@code null} if the key is absent
- */
- @Nullable
- public Long getLong(String key){
- if (!parameters.containsKey(key)) {
- return null;
- }
- Object value = parameters.get(key).getValue();
- return value==null ? null : ((Long)value).longValue();
- }
-
- /**
- * Typesafe Getter for the Long represented by the provided key. If the
- * key does not exist, the default value will be returned.
- *
- * @param key to return the value for
- * @param defaultValue to return if the value doesn't exist
- * @return the parameter represented by the provided key, defaultValue
- * otherwise.
- * @deprecated Use {@link JobParameters#getLong(java.lang.String, java.lang.Long)}
- * instead. This method will be removed in a future release.
- */
- @Deprecated
- public Long getLong(String key, long defaultValue){
- if(parameters.containsKey(key)){
- return getLong(key);
- }
- else{
- return defaultValue;
- }
- }
-
- /**
- * Typesafe Getter for the Long represented by the provided key. If the
- * key does not exist, the default value will be returned.
- *
- * @param key to return the value for
- * @param defaultValue to return if the value doesn't exist
- * @return the parameter represented by the provided key, defaultValue
- * otherwise.
- */
- @Nullable
- public Long getLong(String key, @Nullable Long defaultValue){
- if(parameters.containsKey(key)){
- return getLong(key);
- }
- else{
- return defaultValue;
- }
- }
-
- /**
- * Typesafe Getter for the String represented by the provided key.
- *
- * @param key The key to get a value for
- * @return The String value or {@code null} if the key is absent
- */
- @Nullable
- public String getString(String key){
- JobParameter value = parameters.get(key);
- return value==null ? null : value.toString();
- }
-
- /**
- * Typesafe Getter for the String represented by the provided key. If the
- * key does not exist, the default value will be returned.
- *
- * @param key to return the value for
- * @param defaultValue to return if the value doesn't exist
- * @return the parameter represented by the provided key, defaultValue
- * otherwise.
- */
- @Nullable
- public String getString(String key, @Nullable String defaultValue){
- if(parameters.containsKey(key)){
- return getString(key);
- }
- else{
- return defaultValue;
- }
- }
-
- /**
- * Typesafe Getter for the Long represented by the provided key.
- *
- * @param key The key to get a value for
- * @return The Double value or {@code null} if the key is absent
- */
- @Nullable
- public Double getDouble(String key){
- if (!parameters.containsKey(key)) {
- return null;
- }
- Double value = (Double)parameters.get(key).getValue();
- return value==null ? null : value.doubleValue();
- }
-
- /**
- * Typesafe Getter for the Double represented by the provided key. If the
- * key does not exist, the default value will be returned.
- *
- * @param key to return the value for
- * @param defaultValue to return if the value doesn't exist
- * @return the parameter represented by the provided key, defaultValue
- * otherwise.
- * @deprecated Use {@link JobParameters#getDouble(java.lang.String, java.lang.Double)}
- * instead. This method will be removed in a future release.
- */
- @Deprecated
- public Double getDouble(String key, double defaultValue){
- if(parameters.containsKey(key)){
- return getDouble(key);
- }
- else{
- return defaultValue;
- }
- }
-
- /**
- * Typesafe Getter for the Double represented by the provided key. If the
- * key does not exist, the default value will be returned.
- *
- * @param key to return the value for
- * @param defaultValue to return if the value doesn't exist
- * @return the parameter represented by the provided key, defaultValue
- * otherwise.
- */
- @Nullable
- public Double getDouble(String key, @Nullable Double defaultValue){
- if(parameters.containsKey(key)){
- return getDouble(key);
- }
- else{
- return defaultValue;
- }
- }
-
- /**
- * Typesafe Getter for the Date represented by the provided key.
- *
- * @param key The key to get a value for
- * @return The java.util.Date value or {@code null} if the key
- * is absent
- */
- @Nullable
- public Date getDate(String key){
- return this.getDate(key,null);
- }
-
- /**
- * Typesafe Getter for the Date represented by the provided key. If the
- * key does not exist, the default value will be returned.
- *
- * @param key to return the value for
- * @param defaultValue to return if the value doesn't exist
- * @return the parameter represented by the provided key, defaultValue
- * otherwise.
- */
- @Nullable
- public Date getDate(String key, @Nullable Date defaultValue){
- if(parameters.containsKey(key)){
- return (Date)parameters.get(key).getValue();
- }
- else{
- return defaultValue;
- }
- }
-
- /**
- * Get a map of all parameters, including string, long, and date.
- *
- * @return an unmodifiable map containing all parameters.
- */
- public Map- *
- * Using the identifying flag indicates if the parameter will be used - * in the identification of a JobInstance. That flag defaults to true. - * - * @author Lucas Ward - * @author Michael Minella - * @author Glenn Renfro - * @author Mahmoud Ben Hassine - * @since 1.0 - * @see JobParameters - * @see JobParameter - */ -public class JobParametersBuilder { - - private Map
+ * Note that some ClassLoaders do not expose the package metadata, hence this class might
+ * not be able to determine the Spring Batch version in all environments.
+ *
+ * @author Mahmoud Ben Hassine
+ * @since 5.0
+ */
+public final class SpringBatchVersion {
+
+ /**
+ * The key to use in the execution context for batch version.
+ */
+ public static final String BATCH_VERSION_KEY = "batch.version";
+
+ private SpringBatchVersion() {
+ }
+
+ /**
+ * Return the full version string of the present Spring Batch codebase, or
+ * {@code "N/A"} if it cannot be determined.
+ * @see Package#getImplementationVersion()
+ */
+ public static @Nullable String getVersion() {
+ Package pkg = SpringBatchVersion.class.getPackage();
+ if (pkg != null && pkg.getImplementationVersion() != null) {
+ return pkg.getImplementationVersion();
+ }
+ return "N/A";
+ }
+
+}
\ No newline at end of file
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/StartLimitExceededException.java b/spring-batch-core/src/main/java/org/springframework/batch/core/StartLimitExceededException.java
deleted file mode 100644
index 4d61a50bdc..0000000000
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/StartLimitExceededException.java
+++ /dev/null
@@ -1,28 +0,0 @@
-/*
- * Copyright 2006-2007 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
- *
- * http://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.core;
-
-/**
- * Indicates the step's start limit has been exceeded.
- */
-@SuppressWarnings("serial")
-public class StartLimitExceededException extends RuntimeException {
-
- public StartLimitExceededException(String message) {
- super(message);
- }
-}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/Step.java b/spring-batch-core/src/main/java/org/springframework/batch/core/Step.java
deleted file mode 100644
index 5ae3ed7fe7..0000000000
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/Step.java
+++ /dev/null
@@ -1,56 +0,0 @@
-/*
- * Copyright 2006-2007 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
- *
- * http://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.core;
-
-/**
- * Batch domain interface representing the configuration of a step. As with the {@link Job}, a {@link Step} is meant to
- * explicitly represent the configuration of a step by a developer, but also the ability to execute the step.
- *
- * @author Dave Syer
- *
- */
-public interface Step {
-
- static final String STEP_TYPE_KEY = "batch.stepType";
- /**
- * @return the name of this step.
- */
- String getName();
-
- /**
- * @return true if a step that is already marked as complete can be started again.
- */
- boolean isAllowStartIfComplete();
-
- /**
- * @return the number of times a job can be started with the same identifier.
- */
- int getStartLimit();
-
- /**
- * Process the step and assign progress and status meta information to the {@link StepExecution} provided. The
- * {@link Step} is responsible for setting the meta information and also saving it if required by the
- * implementation.
- * Enable Spring Batch features and provide a base configuration for setting up batch jobs in an @Configuration
- * class, roughly equivalent to using the {@code
- *
- * It is not safe to re-use an instance of {@link Step} to process multiple concurrent executions.
- *
- * @param stepExecution an entity representing the step to be executed
- *
- * @throws JobInterruptedException if the step is interrupted externally
- */
- void execute(StepExecution stepExecution) throws JobInterruptedException;
-
-}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/StepContribution.java b/spring-batch-core/src/main/java/org/springframework/batch/core/StepContribution.java
deleted file mode 100644
index cb7ccfb166..0000000000
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/StepContribution.java
+++ /dev/null
@@ -1,226 +0,0 @@
-/*
- * Copyright 2006-2013 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
- *
- * http://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.core;
-
-import java.io.Serializable;
-
-/**
- * Represents a contribution to a {@link StepExecution}, buffering changes until
- * they can be applied at a chunk boundary.
- *
- * @author Dave Syer
- *
- */
-@SuppressWarnings("serial")
-public class StepContribution implements Serializable {
-
- private volatile int readCount = 0;
-
- private volatile int writeCount = 0;
-
- private volatile int filterCount = 0;
-
- private final int parentSkipCount;
-
- private volatile int readSkipCount;
-
- private volatile int writeSkipCount;
-
- private volatile int processSkipCount;
-
- private ExitStatus exitStatus = ExitStatus.EXECUTING;
-
- /**
- * @param execution {@link StepExecution} the stepExecution used to initialize
- * {@code skipCount}.
- */
- public StepContribution(StepExecution execution) {
- this.parentSkipCount = execution.getSkipCount();
- }
-
- /**
- * Set the {@link ExitStatus} for this contribution.
- *
- * @param status {@link ExitStatus} instance to be used to set the exit status.
- */
- public void setExitStatus(ExitStatus status) {
- this.exitStatus = status;
- }
-
- /**
- * Public getter for the status.
- *
- * @return the {@link ExitStatus} for this contribution
- */
- public ExitStatus getExitStatus() {
- return exitStatus;
- }
-
- /**
- * Increment the counter for the number of items processed.
- *
- * @param count int amount to increment by.
- */
- public void incrementFilterCount(int count) {
- filterCount += count;
- }
-
- /**
- * Increment the counter for the number of items read.
- */
- public void incrementReadCount() {
- readCount++;
- }
-
- /**
- * Increment the counter for the number of items written.
- *
- * @param count int amount to increment by.
- */
- public void incrementWriteCount(int count) {
- writeCount += count;
- }
-
- /**
- * Public access to the read counter.
- *
- * @return the item counter.
- */
- public int getReadCount() {
- return readCount;
- }
-
- /**
- * Public access to the write counter.
- *
- * @return the item counter.
- */
- public int getWriteCount() {
- return writeCount;
- }
-
- /**
- * Public getter for the filter counter.
- *
- * @return the filter counter
- */
- public int getFilterCount() {
- return filterCount;
- }
-
- /**
- * @return the sum of skips accumulated in the parent {@link StepExecution}
- * and this StepContribution.
- */
- public int getStepSkipCount() {
- return readSkipCount + writeSkipCount + processSkipCount + parentSkipCount;
- }
-
- /**
- * @return the number of skips collected in this
- * StepContribution (not including skips accumulated in the
- * parent {@link StepExecution}).
- */
- public int getSkipCount() {
- return readSkipCount + writeSkipCount + processSkipCount;
- }
-
- /**
- * Increment the read skip count for this contribution
- */
- public void incrementReadSkipCount() {
- readSkipCount++;
- }
-
- /**
- * Increment the read skip count for this contribution
- *
- * @param count int amount to increment by.
- */
- public void incrementReadSkipCount(int count) {
- readSkipCount += count;
- }
-
- /**
- * Increment the write skip count for this contribution
- */
- public void incrementWriteSkipCount() {
- writeSkipCount++;
- }
-
- /**
- *
- */
- public void incrementProcessSkipCount() {
- processSkipCount++;
- }
-
- /**
- * @return the read skip count
- */
- public int getReadSkipCount() {
- return readSkipCount;
- }
-
- /**
- * @return the write skip count
- */
- public int getWriteSkipCount() {
- return writeSkipCount;
- }
-
- /**
- * Public getter for the process skip count.
- *
- * @return the process skip count
- */
- public int getProcessSkipCount() {
- return processSkipCount;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see java.lang.Object#toString()
- */
- @Override
- public String toString() {
- return "[StepContribution: read=" + readCount + ", written=" + writeCount + ", filtered=" + filterCount
- + ", readSkips=" + readSkipCount + ", writeSkips=" + writeSkipCount + ", processSkips="
- + processSkipCount + ", exitStatus=" + exitStatus.getExitCode() + "]";
- }
-
- /**
- * @see java.lang.Object#equals(java.lang.Object)
- */
- @Override
- public boolean equals(Object obj) {
- if (!(obj instanceof StepContribution)) {
- return false;
- }
- StepContribution other = (StepContribution) obj;
- return toString().equals(other.toString());
- }
-
- /**
- * @see java.lang.Object#hashCode()
- */
- @Override
- public int hashCode() {
- return 11 + toString().hashCode() * 43;
- }
-
-}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/StepExecution.java b/spring-batch-core/src/main/java/org/springframework/batch/core/StepExecution.java
deleted file mode 100644
index f038ad8c87..0000000000
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/StepExecution.java
+++ /dev/null
@@ -1,544 +0,0 @@
-/*
- * Copyright 2006-2013 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
- *
- * http://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.core;
-
-import java.io.IOException;
-import java.io.ObjectInputStream;
-import java.util.ArrayList;
-import java.util.Date;
-import java.util.List;
-import java.util.concurrent.CopyOnWriteArrayList;
-
-import org.springframework.batch.item.ExecutionContext;
-import org.springframework.util.Assert;
-
-/**
- * Batch domain object representation the execution of a step. Unlike
- * {@link JobExecution}, there are additional properties related the processing
- * of items such as commit count, etc.
- *
- * @author Lucas Ward
- * @author Dave Syer
- *
- */
-@SuppressWarnings("serial")
-public class StepExecution extends Entity {
-
- private final JobExecution jobExecution;
-
- private final String stepName;
-
- private volatile BatchStatus status = BatchStatus.STARTING;
-
- private volatile int readCount = 0;
-
- private volatile int writeCount = 0;
-
- private volatile int commitCount = 0;
-
- private volatile int rollbackCount = 0;
-
- private volatile int readSkipCount = 0;
-
- private volatile int processSkipCount = 0;
-
- private volatile int writeSkipCount = 0;
-
- private volatile Date startTime = new Date(System.currentTimeMillis());
-
- private volatile Date endTime = null;
-
- private volatile Date lastUpdated = null;
-
- private volatile ExecutionContext executionContext = new ExecutionContext();
-
- private volatile ExitStatus exitStatus = ExitStatus.EXECUTING;
-
- private volatile boolean terminateOnly;
-
- private volatile int filterCount;
-
- private transient volatile List
- *
- * Expected signature: void afterChunk(ChunkContext context)
+ * Marks a method to be called after a chunk is processed.
+ * Expected signature: void afterChunk(Chunk)
*
* @author Lucas Ward
+ * @author Mahmoud Ben Hassine
* @since 2.0
- * @see ChunkListener#afterChunk(ChunkContext context)
+ * @see ChunkListener#afterChunk(Chunk)
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface AfterChunk {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterChunkError.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterChunkError.java
index a8ef5fce5a..0e0b51b203 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterChunkError.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterChunkError.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -15,7 +15,7 @@
*/
package org.springframework.batch.core.annotation;
-import org.springframework.batch.core.ChunkListener;
+import org.springframework.batch.core.listener.ChunkListener;
import org.springframework.batch.core.scope.context.ChunkContext;
import java.lang.annotation.ElementType;
@@ -24,8 +24,7 @@
import java.lang.annotation.Target;
/**
- * Marks a method to be called after a has failed and been
- * marked for rollback.
+ * Marks a method to be called after a chunk has failed and been marked for rollback.
*
* Expected signature: void afterFailedChunk(ChunkContext context)
*
@@ -34,7 +33,7 @@
* @see ChunkListener#afterChunkError(ChunkContext context)
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface AfterChunkError {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterJob.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterJob.java
index 94ecf5b343..a3c343e3c9 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterJob.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterJob.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -21,22 +21,22 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.Job;
-import org.springframework.batch.core.JobExecution;
-import org.springframework.batch.core.JobExecutionListener;
+import org.springframework.batch.core.job.Job;
+import org.springframework.batch.core.job.JobExecution;
+import org.springframework.batch.core.listener.JobExecutionListener;
/**
- * Marks a method to be called after a {@link Job} has completed. Annotated
- * methods will be called regardless of the status of the {@link JobExecution}.
+ * Marks a method to be called after a {@link Job} has completed. Annotated methods are
+ * called regardless of the status of the {@link JobExecution}.
*
* Expected signature: void afterJob({@link JobExecution} jobExecution)
- *
+ *
* @author Lucas Ward
* @since 2.0
* @see JobExecutionListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface AfterJob {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterProcess.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterProcess.java
index 652040c0f8..0498fab9e9 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterProcess.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterProcess.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -21,21 +21,22 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.ItemProcessListener;
-import org.springframework.batch.item.ItemProcessor;
+import org.springframework.batch.core.listener.ItemProcessListener;
+import org.springframework.batch.infrastructure.item.ItemProcessor;
/**
- * Marks a method to be called after an item is passed to an
- * {@link ItemProcessor}
+ * Marks a method to be called after an item is passed to an {@link ItemProcessor}.
+ * {@code item} is the input item. {@code result} is the processed item. {@code result}
+ * can be null if the {@code item} is filtered.
*
* Expected signature: void afterProcess(T item, S result)
- *
- * @author Lucas Ward
+ *
+ * @author Lucas Ward, Jay Bryant
* @since 2.0
* @see ItemProcessListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface AfterProcess {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterRead.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterRead.java
index 2d99719f45..84ac36d110 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterRead.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterRead.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2002-2008 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -20,20 +20,20 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.ItemReadListener;
-import org.springframework.batch.item.ItemReader;
+import org.springframework.batch.core.listener.ItemReadListener;
+import org.springframework.batch.infrastructure.item.ItemReader;
/**
* Marks a method to be called after an item is read from an {@link ItemReader}
*
* Expected signature: void afterRead(T item)
- *
+ *
* @author Lucas Ward
* @since 2.0
* @see ItemReadListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface AfterRead {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterStep.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterStep.java
index 2e30bc310a..c9d25ee211 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterStep.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterStep.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -22,23 +22,22 @@
import java.lang.annotation.Target;
import org.springframework.batch.core.ExitStatus;
-import org.springframework.batch.core.Step;
-import org.springframework.batch.core.StepExecution;
-import org.springframework.batch.core.StepExecutionListener;
+import org.springframework.batch.core.step.Step;
+import org.springframework.batch.core.step.StepExecution;
+import org.springframework.batch.core.listener.StepExecutionListener;
/**
- * Marks a method to be called after a {@link Step} has completed. Annotated
- * methods will be called regardless of the status of the {@link StepExecution}.
+ * Marks a method to be called after a {@link Step} has completed. Annotated methods are
+ * called regardless of the status of the {@link StepExecution}.
*
- * Expected signature: {@link ExitStatus} afterStep({@link StepExecution}
- * stepExecution);
- *
+ * Expected signature: {@link ExitStatus} afterStep({@link StepExecution} stepExecution);
+ *
* @author Lucas Ward
* @since 2.0
* @see StepExecutionListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface AfterStep {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterWrite.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterWrite.java
index d253fbb293..b6833d9096 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterWrite.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterWrite.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -20,22 +20,25 @@
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import java.util.List;
-import org.springframework.batch.core.ItemWriteListener;
-import org.springframework.batch.item.ItemWriter;
+import org.springframework.batch.core.listener.ItemWriteListener;
+import org.springframework.batch.infrastructure.item.Chunk;
+import org.springframework.batch.infrastructure.item.ItemWriter;
/**
- * Marks a method to be called after an item is passed to an {@link ItemWriter}
+ * Marks a method to be called after an item is passed to an {@link ItemWriter}. Note that
+ * this annotation takes a {@link Chunk} because Spring Batch generally processes a group
+ * of items (for the sake of efficiency).
*
- * Expected signature: void afterWrite({@link List}<? extends S> items)
- *
+ * Expected signature: void afterWrite({@link Chunk}<? extends S> items)
+ *
* @author Lucas Ward
+ * @author Mahmoud Ben Hassine
* @since 2.0
* @see ItemWriteListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface AfterWrite {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeChunk.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeChunk.java
index fa86e9ab08..0a5fe0e3d1 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeChunk.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeChunk.java
@@ -1,11 +1,11 @@
/*
- * 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -20,20 +20,21 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.ChunkListener;
-import org.springframework.batch.core.scope.context.ChunkContext;
+import org.springframework.batch.core.listener.ChunkListener;
+import org.springframework.batch.infrastructure.item.Chunk;
/**
* Marks a method to be called before a chunk is executed.
*
- * Expected signature: void beforeChunk(ChunkContext context)
+ * Expected signature: void beforeChunk(Chunk)
*
* @author Lucas Ward
+ * @author Mahmoud Ben Hassine
* @since 2.0
- * @see ChunkListener#beforeChunk(ChunkContext context)
+ * @see ChunkListener#beforeChunk(Chunk)
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface BeforeChunk {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeJob.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeJob.java
index 318320953b..f47ba4bbb5 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeJob.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeJob.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -21,25 +21,25 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.Job;
-import org.springframework.batch.core.JobExecution;
-import org.springframework.batch.core.JobExecutionListener;
-import org.springframework.batch.core.Step;
+import org.springframework.batch.core.job.Job;
+import org.springframework.batch.core.job.JobExecution;
+import org.springframework.batch.core.listener.JobExecutionListener;
+import org.springframework.batch.core.step.Step;
import org.springframework.beans.factory.annotation.Qualifier;
/**
- * Marks a method to be called before a {@link Job} is executed, which comes
- * after a {@link JobExecution} is created and persisted, but before the first
- * {@link Step} is executed.
+ * Marks a method to be called before a {@link Job} is executed, which comes after a
+ * {@link JobExecution} is created and persisted but before the first {@link Step} is
+ * executed.
*
* Expected signature: void beforeJob({@link JobExecution} jobExecution)
- *
+ *
* @author Lucas Ward
* @since 2.0
* @see JobExecutionListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
@Qualifier("JobExecutionListener")
public @interface BeforeJob {
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeProcess.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeProcess.java
index 585bb26c9e..519eb29bb2 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeProcess.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeProcess.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2002-2008 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -20,21 +20,20 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.ItemProcessListener;
-import org.springframework.batch.item.ItemProcessor;
+import org.springframework.batch.core.listener.ItemProcessListener;
+import org.springframework.batch.infrastructure.item.ItemProcessor;
/**
- * Marks a method to be called before an item is passed to an
- * {@link ItemProcessor}
+ * Marks a method to be called before an item is passed to an {@link ItemProcessor}
*
* Expected signature: void beforeProcess(T item)
- *
+ *
* @author Lucas Ward
* @since 2.0
* @see ItemProcessListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface BeforeProcess {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeRead.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeRead.java
index 5d03df98b0..61fcdb3ee3 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeRead.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeRead.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2002-2008 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -20,20 +20,20 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.ItemReadListener;
-import org.springframework.batch.item.ItemReader;
+import org.springframework.batch.core.listener.ItemReadListener;
+import org.springframework.batch.infrastructure.item.ItemReader;
/**
* Marks a method to be called before an item is read from an {@link ItemReader}
*
* Expected signature: void beforeRead()
- *
+ *
* @author Lucas Ward
* @since 2.0
* @see ItemReadListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface BeforeRead {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeStep.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeStep.java
index a32afccd6d..5db8edbe2a 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeStep.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeStep.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -21,23 +21,22 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.Step;
-import org.springframework.batch.core.StepExecution;
-import org.springframework.batch.core.StepExecutionListener;
+import org.springframework.batch.core.step.Step;
+import org.springframework.batch.core.step.StepExecution;
+import org.springframework.batch.core.listener.StepExecutionListener;
/**
- * Marks a method to be called before a {@link Step} is executed, which comes
- * after a {@link StepExecution} is created and persisted, but before the first
- * item is read.
+ * Marks a method to be called before a {@link Step} is executed, which comes after a
+ * {@link StepExecution} is created and persisted but before the first item is read.
*
* Expected signature: void beforeStep({@link StepExecution} stepExecution)
- *
+ *
* @author Lucas Ward
* @since 2.0
* @see StepExecutionListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface BeforeStep {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeWrite.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeWrite.java
index db025cb663..177f7268bd 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeWrite.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeWrite.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -20,22 +20,23 @@
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import java.util.List;
-import org.springframework.batch.core.ItemWriteListener;
-import org.springframework.batch.item.ItemWriter;
+import org.springframework.batch.core.listener.ItemWriteListener;
+import org.springframework.batch.infrastructure.item.Chunk;
+import org.springframework.batch.infrastructure.item.ItemWriter;
/**
- * Marks a method to be called before an item is passed to an {@link ItemWriter}
+ * Marks a method to be called before a chunk is passed to an {@link ItemWriter}.
*
- * Expected signature: void beforeWrite({@link List}<? extends S> items)
- *
+ * Expected signature: void beforeWrite({@link Chunk}<? extends S> items)
+ *
* @author Lucas Ward
+ * @author Mahmoud Ben Hassine
* @since 2.0
* @see ItemWriteListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface BeforeWrite {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnChunkError.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnChunkError.java
new file mode 100644
index 0000000000..22022076c2
--- /dev/null
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnChunkError.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2025-present 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.core.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.batch.core.listener.ChunkListener;
+import org.springframework.batch.infrastructure.item.Chunk;
+
+/**
+ * Marks a method to be called after a chunk has failed.
+ * Expected signature: void onChunkError(Exception, Chunk)
+ *
+ * @author Mahmoud Ben Hassine
+ * @since 6.0
+ * @see ChunkListener#onChunkError(Exception, Chunk)
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD })
+public @interface OnChunkError {
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnProcessError.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnProcessError.java
index ea4be526a1..f5ffb5bff5 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnProcessError.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnProcessError.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -21,21 +21,20 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.ItemProcessListener;
-import org.springframework.batch.item.ItemProcessor;
+import org.springframework.batch.core.listener.ItemProcessListener;
+import org.springframework.batch.infrastructure.item.ItemProcessor;
/**
- * Marks a method to be called if an exception is thrown by an
- * {@link ItemProcessor}
+ * Marks a method to be called if an exception is thrown by an {@link ItemProcessor}.
*
* Expected signature: void onProcessError(T item, {@link Exception} e)
- *
+ *
* @author Lucas Ward
* @since 2.0
* @see ItemProcessListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface OnProcessError {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnReadError.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnReadError.java
index 00c69d2940..f55c2aacc1 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnReadError.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnReadError.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2002-2008 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -20,21 +20,20 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.ItemReadListener;
-import org.springframework.batch.item.ItemReader;
+import org.springframework.batch.core.listener.ItemReadListener;
+import org.springframework.batch.infrastructure.item.ItemReader;
/**
- * Marks a method to be called if an exception is thrown by an
- * {@link ItemReader}
+ * Marks a method to be called if an exception is thrown by an {@link ItemReader}.
*
* Expected signature: void onReadError({@link Exception} ex)
- *
+ *
* @author Lucas Ward
* @since 2.0
* @see ItemReadListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface OnReadError {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInProcess.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInProcess.java
index 92468c0007..56ac26a81a 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInProcess.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInProcess.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -21,21 +21,21 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.SkipListener;
-import org.springframework.batch.item.ItemProcessor;
+import org.springframework.batch.core.listener.SkipListener;
+import org.springframework.batch.infrastructure.item.ItemProcessor;
/**
- * Marks a method to be called when an item is skipped due to an exception
- * thrown in the {@link ItemProcessor}.
+ * Marks a method to be called when an item is skipped due to an exception thrown in the
+ * {@link ItemProcessor}.
*
* Expected signature: void onSkipInProcess(T item, {@link Throwable} t)
- *
+ *
* @author Lucas Ward
* @since 2.0
* @see SkipListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface OnSkipInProcess {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInRead.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInRead.java
index 3387795b75..e8dd2595fd 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInRead.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInRead.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -21,21 +21,21 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.SkipListener;
-import org.springframework.batch.item.ItemReader;
+import org.springframework.batch.core.listener.SkipListener;
+import org.springframework.batch.infrastructure.item.ItemReader;
/**
- * Marks a method to be called when an item is skipped due to an exception
- * thrown in the {@link ItemReader}
+ * Marks a method to be called when an item is skipped due to an exception thrown in the
+ * {@link ItemReader}.
*
* Expected signature: void onSkipInRead({@link Throwable} t)
- *
+ *
* @author Lucas Ward
* @since 2.0
* @see SkipListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface OnSkipInRead {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInWrite.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInWrite.java
index c4798267be..fb58b4fc1e 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInWrite.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInWrite.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -21,21 +21,21 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import org.springframework.batch.core.SkipListener;
-import org.springframework.batch.item.ItemWriter;
+import org.springframework.batch.core.listener.SkipListener;
+import org.springframework.batch.infrastructure.item.ItemWriter;
/**
- * Marks a method to be called when an item is skipped due to an exception
- * thrown in the {@link ItemWriter}.
+ * Marks a method to be called when an item is skipped due to an exception thrown in the
+ * {@link ItemWriter}.
*
* Expected signature: void onSkipInWrite(S item, {@link Throwable} t)
- *
+ *
* @author Lucas Ward
* @since 2.0
* @see SkipListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface OnSkipInWrite {
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnWriteError.java b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnWriteError.java
index 466a8459f4..cf7f153715 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnWriteError.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnWriteError.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -20,24 +20,26 @@
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import java.util.List;
-import org.springframework.batch.core.ItemWriteListener;
-import org.springframework.batch.item.ItemWriter;
+import org.springframework.batch.core.listener.ItemWriteListener;
+import org.springframework.batch.infrastructure.item.Chunk;
+import org.springframework.batch.infrastructure.item.ItemWriter;
/**
- * Marks a method to be called if an exception is thrown by an
- * {@link ItemWriter}
+ * Marks a method to be called if an exception is thrown by an {@link ItemWriter}. Note
+ * that this annotation takes a {@link Chunk} because Spring Batch generally processes a
+ * group of items (for the sake of efficiency).
*
- * Expected signature: void onWriteError({@link Exception} exception,
- * {@link List}<? extends S> items)
- *
+ * Expected signature: void onWriteError({@link Exception} exception, {@link Chunk}<?
+ * extends S> items)
+ *
* @author Lucas Ward
+ * @author Mahmoud Ben Hassine
* @since 2.0
* @see ItemWriteListener
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD})
+@Target({ ElementType.METHOD })
public @interface OnWriteError {
-}
\ No newline at end of file
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/aot/CoreRuntimeHints.java b/spring-batch-core/src/main/java/org/springframework/batch/core/aot/CoreRuntimeHints.java
new file mode 100644
index 0000000000..3d79b860f8
--- /dev/null
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/aot/CoreRuntimeHints.java
@@ -0,0 +1,180 @@
+/*
+ * Copyright 2022-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.
+ * 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.core.aot;
+
+import java.lang.reflect.Method;
+import java.sql.Types;
+import java.time.Duration;
+import java.time.Instant;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.LocalTime;
+import java.time.OffsetDateTime;
+import java.time.OffsetTime;
+import java.time.Period;
+import java.time.ZonedDateTime;
+import java.util.ArrayList;
+import java.util.Calendar;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Hashtable;
+import java.util.LinkedHashMap;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Properties;
+import java.util.Set;
+import java.util.UUID;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.locks.AbstractOwnableSynchronizer;
+import java.util.concurrent.locks.AbstractQueuedSynchronizer;
+import java.util.concurrent.locks.ReentrantLock;
+import java.util.stream.Stream;
+
+import org.springframework.aop.SpringProxy;
+import org.springframework.aop.framework.Advised;
+import org.springframework.aot.hint.ExecutableMode;
+import org.springframework.aot.hint.MemberCategory;
+import org.springframework.aot.hint.RuntimeHints;
+import org.springframework.aot.hint.RuntimeHintsRegistrar;
+import org.springframework.aot.hint.SerializationHints;
+import org.springframework.aot.hint.TypeReference;
+import org.springframework.batch.core.Entity;
+import org.springframework.batch.core.ExitStatus;
+import org.springframework.batch.core.job.JobExecution;
+import org.springframework.batch.core.job.JobInstance;
+import org.springframework.batch.core.job.parameters.JobParameter;
+import org.springframework.batch.core.job.parameters.JobParameters;
+import org.springframework.batch.core.launch.JobOperator;
+import org.springframework.batch.core.listener.ChunkListener;
+import org.springframework.batch.core.listener.ItemProcessListener;
+import org.springframework.batch.core.listener.ItemReadListener;
+import org.springframework.batch.core.listener.ItemWriteListener;
+import org.springframework.batch.core.listener.JobExecutionListener;
+import org.springframework.batch.core.listener.SkipListener;
+import org.springframework.batch.core.listener.StepExecutionListener;
+import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.batch.core.repository.explore.JobExplorer;
+import org.springframework.batch.core.step.StepContribution;
+import org.springframework.batch.core.step.StepExecution;
+import org.springframework.batch.core.scope.context.JobContext;
+import org.springframework.batch.core.scope.context.StepContext;
+import org.springframework.batch.infrastructure.item.Chunk;
+import org.springframework.batch.infrastructure.item.ExecutionContext;
+import org.springframework.core.DecoratingProxy;
+import org.springframework.util.Assert;
+import org.springframework.util.ReflectionUtils;
+
+/**
+ * {@link RuntimeHintsRegistrar} for Spring Batch core module.
+ *
+ * @author Glenn Renfro
+ * @author Mahmoud Ben Hassine
+ * @author Alexander Arshavskiy
+ * @author Andrey Litvitski
+ * @author François Martin
+ * @since 5.0
+ */
+public class CoreRuntimeHints implements RuntimeHintsRegistrar {
+
+ @Override
+ public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
+
+ Setname.
- *
+ *
* @author Dave Syer
* @author Mahmoud Ben Hassine
- *
+ * @deprecated since 6.0 in favor of {@link JobRegistry}. Scheduled for removal in 6.2 or
+ * later.
*/
+@NullUnmarked
+@Deprecated(since = "6.0", forRemoval = true)
public interface JobLocator {
/**
* Locates a {@link Job} at runtime.
- *
- * @param name the name of the {@link Job} which should be
- * unique
+ * @param name the name of the {@link Job} which should be unique
* @return a {@link Job} identified by the given name
- *
- * @throws NoSuchJobException if the required configuration can
- * not be found.
+ * @throws NoSuchJobException if the required configuration can not be found.
*/
Job getJob(@Nullable String name) throws NoSuchJobException;
+
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/JobRegistry.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/JobRegistry.java
index 3415750645..fd367a55ae 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/JobRegistry.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/JobRegistry.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -15,32 +15,49 @@
*/
package org.springframework.batch.core.configuration;
-import org.springframework.batch.core.Job;
+import java.util.Collection;
+
+import org.jspecify.annotations.Nullable;
+
+import org.springframework.batch.core.job.Job;
/**
* A runtime service registry interface for registering job configurations by
* name.
- *
+ *
* @author Dave Syer
- *
+ * @author Mahmoud Ben Hassine
+ *
*/
-public interface JobRegistry extends ListableJobLocator {
+public interface JobRegistry {
+
+ /**
+ * Returns a {@link Job} by name.
+ * @param name the name of the {@link Job} which should be unique
+ * @return a {@link Job} identified by the given name, or null if no such job exists.
+ */
+ @Nullable Job getJob(String name);
+
+ /**
+ * Provides the currently registered job names. The return value is unmodifiable and
+ * disconnected from the underlying registry storage.
+ * @return a collection of String. Empty if none are registered.
+ */
+ Collection
* @Configuration
* @EnableBatchProcessing
- * @Import(DataSourceConfiguration.class)
* public class AppConfig {
*
- * @Autowired
- * private JobBuilderFactory jobs;
- *
- * @Bean
- * public Job job() {
- * return jobs.get("myJob").start(step1()).next(step2()).build();
- * }
+ * @Bean
+ * public Job job(JobRepository jobRepository) {
+ * return new JobBuilder("myJob", jobRepository).start(step1()).next(step2()).build();
+ * }
*
- * @Bean
- * protected Step step1() {
- * ...
- * }
+ * @Bean
+ * protected Step step1() {
+ * ...
+ * }
*
- * @Bean
- * protected Step step2() {
- * ...
- * }
+ * @Bean
+ * protected Step step2() {
+ * ...
+ * }
* }
*
*
- * The user should to provide a {@link DataSource} as a bean in the context, or else implement {@link BatchConfigurer} in
- * the configuration class itself, e.g.
- *
- *
- * @Configuration
- * @EnableBatchProcessing
- * public class AppConfig extends DefaultBatchConfigurer {
- *
- * @Bean
- * public Job job() {
- * ...
- * }
- *
- * @Override
- * protected JobRepository createJobRepository() {
- * ...
- * }
- *
- * ...
- *
- * }
- *
- *
- * If a user does not provide a {@link javax.sql.DataSource} within the context, a Map based
- * {@link org.springframework.batch.core.repository.JobRepository} will be used. If multiple
- * {@link javax.sql.DataSource}s are defined in the context, the one annotated with
- * {@link org.springframework.context.annotation.Primary} will be used (Note that if none
- * of them is annotated with {@link org.springframework.context.annotation.Primary}, the one
- * named dataSource will be used if any, otherwise a {@link UnsatisfiedDependencyException}
- * will be thrown).
- *
- * Note that only one of your configuration classes needs to have the @EnableBatchProcessing
- * annotation. Once you have an @EnableBatchProcessing class in your configuration you will have an
- * instance of {@link StepScope} and {@link org.springframework.batch.core.scope.JobScope} so your beans inside steps
- * can have @Scope("step") and @Scope("job") respectively. You will also be
- * able to @Autowired some useful stuff into your context:
- *
- * -
- *
@EnableBatchProcessing annotation. Once you have an
+ * @EnableBatchProcessing class in your configuration, you have an
+ * instance of {@link org.springframework.batch.core.scope.StepScope} and
+ * {@link org.springframework.batch.core.scope.JobScope}, so your beans inside steps can
+ * have @Scope("step") and @Scope("job") respectively.
+ * You can also use @Autowired to insert some useful beans into your
+ * context:
*
* -
- *
- * @Configuration
- * @EnableBatchProcessing
- * public class AppConfig extends DefaultBatchConfigurer {
- *
- * @Bean
- * public Job job() {
- * ...
- * }
- *
- * @Override
- * public PlatformTransactionManager getTransactionManager() {
- * return new MyTransactionManager();
- * }
- *
- * ...
- *
- * }
- *
- *
- * If the configuration is specified as modular=true then the context will also contain an
- * {@link AutomaticJobRegistrar}. The job registrar is useful for modularizing your configuration if there are multiple
- * jobs. It works by creating separate child application contexts containing job configurations and registering those
- * jobs. The jobs can then create steps and other dependent components without needing to worry about bean definition
- * name clashes. Beans of type {@link ApplicationContextFactory} will be registered automatically with the job
- * registrar. Example:
+ * If the configuration is specified as modular=true, the context also
+ * contains an {@link AutomaticJobRegistrar}. The job registrar is useful for modularizing
+ * your configuration if there are multiple jobs. It works by creating separate child
+ * application contexts to contain job configurations and register those jobs. The jobs
+ * can then create steps and other dependent components without needing to worry about
+ * bean definition name clashes. Beans of type {@link ApplicationContextFactory} are
+ * automatically registered with the job registrar. Example:
*
*
* @Configuration
* @EnableBatchProcessing(modular=true)
* public class AppConfig {
*
- * @Bean
- * public ApplicationContextFactory someJobs() {
- * return new GenericApplicationContextFactory(SomeJobConfiguration.class);
- * }
+ * @Bean
+ * public ApplicationContextFactory someJobs() {
+ * return new GenericApplicationContextFactory(SomeJobConfiguration.class);
+ * }
*
- * @Bean
- * public ApplicationContextFactory moreJobs() {
- * return new GenericApplicationContextFactory(MoreJobConfiguration.class);
- * }
+ * @Bean
+ * public ApplicationContextFactory moreJobs() {
+ * return new GenericApplicationContextFactory(MoreJobConfiguration.class);
+ * }
*
- * ...
+ * ...
*
* }
*
*
- * Note that a modular parent context in general should not itself contain @Bean definitions for job,
- * especially if a {@link BatchConfigurer} is provided, because cyclic configuration dependencies are otherwise likely
- * to develop.
+ * Note that a modular parent context, in general, should not itself contain
+ * @Bean definitions for job, because cyclic configuration dependencies are likely to
+ * develop.
*
* - * For reference, the first example above can be compared to the following Spring XML configuration: + * For reference, compare the first example shown earlier to the following Spring XML + * configuration: * *
* {@code
*
*
- *
+ *
- *
+ *
*
* }
@@ -194,22 +140,65 @@
*
* @author Dave Syer
* @author Mahmoud Ben Hassine
- *
+ * @author Taeik Lim
+ * @see EnableJdbcJobRepository
+ * @see EnableMongoJobRepository
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
-@Import(BatchConfigurationSelector.class)
+@Import({ BatchRegistrar.class, ScopeConfiguration.class, AutomaticJobRegistrarBeanPostProcessor.class,
+ BatchObservabilityBeanPostProcessor.class })
public @interface EnableBatchProcessing {
/**
- * Indicate whether the configuration is going to be modularized into multiple application contexts. If true then
- * you should not create any @Bean Job definitions in this context, but rather supply them in separate (child)
- * contexts through an {@link ApplicationContextFactory}.
- *
- * @return boolean indicating whether the configuration is going to be
- * modularized into multiple application contexts. Defaults to false.
+ * Indicate whether the configuration is going to be modularized into multiple
+ * application contexts. If true, you should not create any @Bean Job definitions
+ * in this context but, rather, supply them in separate (child) contexts through an
+ * {@link ApplicationContextFactory}.
+ * @return boolean indicating whether the configuration is going to be modularized
+ * into multiple application contexts. Defaults to {@code false}.
+ * @deprecated since 6.0 in favor of Spring's context hierarchies and
+ * {@link GroupAwareJob}s. Scheduled for removal in 6.2 or later.
*/
+ @Deprecated(since = "6.0", forRemoval = true)
boolean modular() default false;
+ /**
+ * Set the task executor to use in the job operator.
+ * @return the bean name of the task executor to use. Defaults to
+ * {@literal taskExecutor}
+ */
+ String taskExecutorRef() default "taskExecutor";
+
+ /**
+ * Set the job registry to use in the job operator.
+ * @return the bean name of the job registry to use. Defaults to
+ * {@literal jobRegistry}
+ */
+ String jobRegistryRef() default "jobRegistry";
+
+ /**
+ * Set the observation registry to use in batch artifacts.
+ * @return the bean name of the observation registry to use. Defaults to
+ * {@literal observationRegistry}
+ */
+ String observationRegistryRef() default "observationRegistry";
+
+ /**
+ * Set the transaction manager to use in the job operator.
+ * @return the bean name of the transaction manager to use. Defaults to
+ * {@literal transactionManager}
+ */
+ String transactionManagerRef() default "transactionManager";
+
+ /**
+ * Set the {@link JobParametersConverter} to use in the job operator.
+ * @return the bean name of the job parameters converter to use. Defaults to
+ * {@literal jobParametersConverter}
+ * @deprecated since 6.0 with no replacement. Scheduled for removal in 6.2 or later
+ */
+ @Deprecated(since = "6.0", forRemoval = true)
+ String jobParametersConverterRef() default "jobParametersConverter";
+
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/EnableJdbcJobRepository.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/EnableJdbcJobRepository.java
new file mode 100644
index 0000000000..f665477f13
--- /dev/null
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/EnableJdbcJobRepository.java
@@ -0,0 +1,154 @@
+/*
+ * Copyright 2012-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.
+ * 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.core.configuration.annotation;
+
+import org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao;
+import org.springframework.batch.infrastructure.support.DatabaseType;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.jdbc.core.JdbcOperations;
+import org.springframework.transaction.PlatformTransactionManager;
+import org.springframework.transaction.annotation.Isolation;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.sql.Types;
+
+import javax.sql.DataSource;
+
+/**
+ * Annotation to enable a JDBC-based infrastructure in a Spring Batch application.
+ *
+ * This annotation should be used on a {@link Configuration @Configuration} class
+ * annotated with {@link EnableBatchProcessing }. It will automatically configure the
+ * necessary beans for a JDBC-based infrastructure, including a job repository.
+ *
+ * The default configuration assumes that a {@link DataSource} bean named "dataSource" and
+ * a {@link PlatformTransactionManager} bean named "transactionManager" are available in
+ * the application context.
+ *
+ * @author Mahmoud Ben Hassine
+ * @since 6.0
+ * @see EnableBatchProcessing
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface EnableJdbcJobRepository {
+
+ /**
+ * Set the type of the data source to use in the job repository. The default type will
+ * be introspected from the datasource's metadata.
+ * @since 5.1
+ * @see DatabaseType
+ * @return the type of data source.
+ */
+ String databaseType() default "";
+
+ /**
+ * Set the value of the {@code validateTransactionState} parameter. Defaults to
+ * {@code true}.
+ * @return true if the transaction state should be validated, false otherwise
+ */
+ boolean validateTransactionState() default true;
+
+ /**
+ * Set the isolation level for create parameter value. Defaults to
+ * {@link Isolation#SERIALIZABLE}.
+ * @return the value of the isolation level for create parameter
+ */
+ Isolation isolationLevelForCreate() default Isolation.SERIALIZABLE;
+
+ /**
+ * The charset to use in the job repository
+ * @return the charset to use. Defaults to {@literal UTF-8}.
+ */
+ String charset() default "UTF-8";
+
+ /**
+ * The Batch tables prefix. Defaults to
+ * {@link AbstractJdbcBatchMetadataDao#DEFAULT_TABLE_PREFIX}.
+ * @return the Batch table prefix
+ */
+ String tablePrefix() default AbstractJdbcBatchMetadataDao.DEFAULT_TABLE_PREFIX;
+
+ /**
+ * The maximum length of exit messages in the database. Defaults to
+ * {@link AbstractJdbcBatchMetadataDao#DEFAULT_EXIT_MESSAGE_LENGTH}
+ * @return the maximum length of exit messages in the database
+ */
+ int maxVarCharLength() default AbstractJdbcBatchMetadataDao.DEFAULT_EXIT_MESSAGE_LENGTH;
+
+ /**
+ * The type of large objects.
+ * @return the type of large objects.
+ */
+ int clobType() default Types.CLOB;
+
+ /**
+ * Set the data source to use in the job repository.
+ * @return the bean name of the data source to use. Default to {@literal dataSource}.
+ */
+ String dataSourceRef() default "dataSource";
+
+ /**
+ * Set the {@link PlatformTransactionManager} to use in the job repository.
+ * @return the bean name of the transaction manager to use. Defaults to
+ * {@literal transactionManager}
+ */
+ String transactionManagerRef() default "transactionManager";
+
+ /**
+ * Set the {@link JdbcOperations} to use in the job repository.
+ * @return the bean name of the {@link JdbcOperations} to use. Defaults to
+ * {@literal jdbcTemplate}.
+ */
+ String jdbcOperationsRef() default "jdbcTemplate";
+
+ /**
+ * The generator that determines a unique key for identifying job instance objects
+ * @return the bean name of the job key generator to use. Defaults to
+ * {@literal jobKeyGenerator}.
+ *
+ * @since 5.1
+ */
+ String jobKeyGeneratorRef() default "jobKeyGenerator";
+
+ /**
+ * Set the execution context serializer to use in the job repository.
+ * @return the bean name of the execution context serializer to use. Default to
+ * {@literal executionContextSerializer}.
+ */
+ String executionContextSerializerRef() default "executionContextSerializer";
+
+ /**
+ * The incrementer factory to use in various DAOs.
+ * @return the bean name of the incrementer factory to use. Defaults to
+ * {@literal incrementerFactory}.
+ */
+ String incrementerFactoryRef() default "incrementerFactory";
+
+ /**
+ * Set the conversion service to use in the job repository. This service is used to
+ * convert job parameters from String literal to typed values and vice versa.
+ * @return the bean name of the conversion service to use. Defaults to
+ * {@literal conversionService}
+ */
+ String conversionServiceRef() default "conversionService";
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/EnableMongoJobRepository.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/EnableMongoJobRepository.java
new file mode 100644
index 0000000000..922bca0192
--- /dev/null
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/EnableMongoJobRepository.java
@@ -0,0 +1,101 @@
+/*
+ * Copyright 2012-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.
+ * 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.core.configuration.annotation;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.mongodb.MongoTransactionManager;
+import org.springframework.data.mongodb.core.MongoOperations;
+import org.springframework.transaction.annotation.Isolation;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * * Annotation to enable a MongoDB-based job repository in a Spring Batch application.
+ *
+ * This annotation should be used on a {@link Configuration @Configuration} class
+ * annotated with {@link EnableBatchProcessing}. It will automatically configure the
+ * necessary beans for a MongoDB-based infrastructure, including a job repository.
+ *
+ * The default configuration assumes that a {@link MongoOperations} bean named
+ * "mongoTemplate" and a {@link MongoTransactionManager} bean named "transactionManager"
+ * are available in the application context.
+ *
+ * @author Mahmoud Ben Hassine
+ * @since 6.0
+ * @see EnableBatchProcessing
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface EnableMongoJobRepository {
+
+ String mongoOperationsRef() default "mongoTemplate";
+
+ /**
+ * Set the {@link MongoTransactionManager} to use in the job repository.
+ * @return the bean name of the transaction manager to use. Defaults to
+ * {@literal transactionManager}
+ */
+ String transactionManagerRef() default "transactionManager";
+
+ /**
+ * Set the isolation level for create parameter value. Defaults to
+ * {@link Isolation#SERIALIZABLE}.
+ * @return the value of the isolation level for create parameter
+ */
+ Isolation isolationLevelForCreate() default Isolation.SERIALIZABLE;
+
+ /**
+ * Set the value of the {@code validateTransactionState} parameter. Defaults to
+ * {@code true}.
+ * @return true if the transaction state should be validated, false otherwise
+ */
+ boolean validateTransactionState() default true;
+
+ /**
+ * The generator that determines a unique key for identifying job instance objects
+ * @return the bean name of the job key generator to use. Defaults to
+ * {@literal jobKeyGenerator}.
+ *
+ */
+ String jobKeyGeneratorRef() default "jobKeyGenerator";
+
+ /**
+ * The incrementer that will be used to generate unique ids for job instances.
+ * @return the bean name of the job instance incrementer to use. Defaults to
+ * {@literal jobInstanceIncrementer}.
+ */
+ String jobInstanceIncrementerRef() default "jobInstanceIncrementer";
+
+ /**
+ * The incrementer that will be used to generate unique ids for job executions.
+ * @return the bean name of the job execution incrementer to use. Defaults to
+ * {@literal jobExecutionIncrementer}.
+ */
+ String jobExecutionIncrementerRef() default "jobExecutionIncrementer";
+
+ /**
+ * The incrementer that will be used to generate unique ids for step executions.
+ * @return the bean name of the step execution incrementer to use. Defaults to
+ * {@literal stepExecutionIncrementer}.
+ */
+ String stepExecutionIncrementerRef() default "stepExecutionIncrementer";
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/JobBuilderFactory.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/JobBuilderFactory.java
deleted file mode 100644
index b6414d3f51..0000000000
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/JobBuilderFactory.java
+++ /dev/null
@@ -1,47 +0,0 @@
-/*
- * Copyright 2012-2013 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
- *
- * http://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.core.configuration.annotation;
-
-import org.springframework.batch.core.job.builder.JobBuilder;
-import org.springframework.batch.core.repository.JobRepository;
-
-/**
- * Convenient factory for a {@link JobBuilder} which sets the {@link JobRepository} automatically.
- *
- * @author Dave Syer
- *
- */
-public class JobBuilderFactory {
-
- private JobRepository jobRepository;
-
- public JobBuilderFactory(JobRepository jobRepository) {
- this.jobRepository = jobRepository;
- }
-
- /**
- * Creates a job builder and initializes its job repository. Note that if the builder is used to create a @Bean
- * definition then the name of the job and the bean name might be different.
- *
- * @param name the name of the job
- * @return a job builder
- */
- public JobBuilder get(String name) {
- JobBuilder builder = new JobBuilder(name).repository(jobRepository);
- return builder;
- }
-
-}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/JobScope.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/JobScope.java
index 3aaabc546b..91b70fc0dc 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/JobScope.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/JobScope.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2013 the original author or authors.
+ * Copyright 2013-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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -24,9 +24,11 @@
/**
*
- * Convenient annotation for job scoped beans that defaults the proxy mode, so that it doesn't have to be specified
- * explicitly on every bean definition. Use this on any @Bean that needs to inject @Values from the job
- * context, and any bean that needs to share a lifecycle with a job execution (e.g. an JobExecutionListener). E.g.
+ * Convenient annotation for job-scoped beans that defaults the proxy mode, so that it
+ * does not have to be specified explicitly on every bean definition. Use this on any
+ * @Bean that needs to inject @Values from the job context, and any bean that
+ * needs to share a lifecycle with a job execution (such as an JobExecutionListener). The
+ * following listing shows an example:
*
*
*
@@ -34,14 +36,17 @@
* @JobScope
* protected Callable<String> value(@Value("#{jobExecution.jobInstance.jobName}")
* final String value) {
- * return new SimpleCallable(value);
+ * return new SimpleCallable(value);
* }
*
*
- * Marking a @Bean as @JobScope is equivalent to marking it as @Scope(value="job", proxyMode=TARGET_CLASS)
+ *
+ * Marking a @Bean as @JobScope is equivalent to marking it as
+ * @Scope(value="job", proxyMode=TARGET_CLASS)
+ *
*
* @author Michael Minella
- *
+ * @author Taeik Lim
* @since 3.0.1
*
*/
@@ -50,4 +55,4 @@
@Documented
public @interface JobScope {
-}
\ No newline at end of file
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/ModularBatchConfiguration.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/ModularBatchConfiguration.java
deleted file mode 100644
index f2b809eeb7..0000000000
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/ModularBatchConfiguration.java
+++ /dev/null
@@ -1,84 +0,0 @@
-/*
- * Copyright 2012-2013 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
- *
- * http://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.core.configuration.annotation;
-
-import org.springframework.batch.core.configuration.support.ApplicationContextFactory;
-import org.springframework.batch.core.configuration.support.AutomaticJobRegistrar;
-import org.springframework.batch.core.configuration.support.DefaultJobLoader;
-import org.springframework.batch.core.explore.JobExplorer;
-import org.springframework.batch.core.launch.JobLauncher;
-import org.springframework.batch.core.repository.JobRepository;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.context.ApplicationContext;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.transaction.PlatformTransactionManager;
-
-import java.util.Collection;
-
-/**
- * Base {@code Configuration} class providing common structure for enabling and using Spring Batch. Customization is
- * available by implementing the {@link BatchConfigurer} interface.
- *
- * @author Dave Syer
- * @since 2.2
- * @see EnableBatchProcessing
- */
-@Configuration
-public class ModularBatchConfiguration extends AbstractBatchConfiguration {
-
- @Autowired
- private ApplicationContext context;
-
- @Autowired(required = false)
- private Collection configurers;
-
- private AutomaticJobRegistrar registrar = new AutomaticJobRegistrar();
-
- @Override
- @Bean
- public JobRepository jobRepository() throws Exception {
- return getConfigurer(configurers).getJobRepository();
- }
-
- @Override
- @Bean
- public JobLauncher jobLauncher() throws Exception {
- return getConfigurer(configurers).getJobLauncher();
- }
-
- @Override
- @Bean
- public PlatformTransactionManager transactionManager() throws Exception {
- return getConfigurer(configurers).getTransactionManager();
- }
-
- @Override
- @Bean
- public JobExplorer jobExplorer() throws Exception {
- return getConfigurer(configurers).getJobExplorer();
- }
-
- @Bean
- public AutomaticJobRegistrar jobRegistrar() throws Exception {
- registrar.setJobLoader(new DefaultJobLoader(jobRegistry()));
- for (ApplicationContextFactory factory : context.getBeansOfType(ApplicationContextFactory.class).values()) {
- registrar.addApplicationContextFactory(factory);
- }
- return registrar;
- }
-
-}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/SimpleBatchConfiguration.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/SimpleBatchConfiguration.java
deleted file mode 100644
index 592000fdd9..0000000000
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/SimpleBatchConfiguration.java
+++ /dev/null
@@ -1,147 +0,0 @@
-/*
- * Copyright 2012-2013 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
- *
- * http://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.core.configuration.annotation;
-
-import org.aopalliance.intercept.MethodInterceptor;
-import org.aopalliance.intercept.MethodInvocation;
-import org.springframework.aop.framework.ProxyFactory;
-import org.springframework.aop.target.AbstractLazyCreationTargetSource;
-import org.springframework.batch.core.configuration.JobRegistry;
-import org.springframework.batch.core.configuration.support.MapJobRegistry;
-import org.springframework.batch.core.explore.JobExplorer;
-import org.springframework.batch.core.launch.JobLauncher;
-import org.springframework.batch.core.repository.JobRepository;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.context.ApplicationContext;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.transaction.PlatformTransactionManager;
-
-import java.util.concurrent.atomic.AtomicReference;
-
-/**
- * Base {@code Configuration} class providing common structure for enabling and using Spring Batch. Customization is
- * available by implementing the {@link BatchConfigurer} interface. The main components are created as lazy proxies that
- * only initialize when a method is called. This is to prevent (as much as possible) configuration cycles from
- * developing when these components are needed in a configuration resource that itself provides a
- * {@link BatchConfigurer}.
- *
- * @author Dave Syer
- * @since 2.2
- * @see EnableBatchProcessing
- */
-@Configuration
-public class SimpleBatchConfiguration extends AbstractBatchConfiguration {
-
- @Autowired
- private ApplicationContext context;
-
- private boolean initialized = false;
-
- private AtomicReference jobRepository = new AtomicReference<>();
-
- private AtomicReference jobLauncher = new AtomicReference<>();
-
- private AtomicReference jobRegistry = new AtomicReference<>();
-
- private AtomicReference transactionManager = new AtomicReference<>();
-
- private AtomicReference jobExplorer = new AtomicReference<>();
-
- @Override
- @Bean
- public JobRepository jobRepository() throws Exception {
- return createLazyProxy(jobRepository, JobRepository.class);
- }
-
- @Override
- @Bean
- public JobLauncher jobLauncher() throws Exception {
- return createLazyProxy(jobLauncher, JobLauncher.class);
- }
-
- @Override
- @Bean
- public JobRegistry jobRegistry() throws Exception {
- return createLazyProxy(jobRegistry, JobRegistry.class);
- }
-
- @Override
- @Bean
- public JobExplorer jobExplorer() {
- return createLazyProxy(jobExplorer, JobExplorer.class);
- }
-
- @Override
- @Bean
- public PlatformTransactionManager transactionManager() throws Exception {
- return createLazyProxy(transactionManager, PlatformTransactionManager.class);
- }
-
- private T createLazyProxy(AtomicReference reference, Class type) {
- ProxyFactory factory = new ProxyFactory();
- factory.setTargetSource(new ReferenceTargetSource<>(reference));
- factory.addAdvice(new PassthruAdvice());
- factory.setInterfaces(new Class[] { type });
- @SuppressWarnings("unchecked")
- T proxy = (T) factory.getProxy();
- return proxy;
- }
-
- /**
- * Sets up the basic components by extracting them from the {@link BatchConfigurer configurer}, defaulting to some
- * sensible values as long as a unique DataSource is available.
- *
- * @throws Exception if there is a problem in the configurer
- */
- protected void initialize() throws Exception {
- if (initialized) {
- return;
- }
- BatchConfigurer configurer = getConfigurer(context.getBeansOfType(BatchConfigurer.class).values());
- jobRepository.set(configurer.getJobRepository());
- jobLauncher.set(configurer.getJobLauncher());
- transactionManager.set(configurer.getTransactionManager());
- jobRegistry.set(new MapJobRegistry());
- jobExplorer.set(configurer.getJobExplorer());
- initialized = true;
- }
-
- private class PassthruAdvice implements MethodInterceptor {
-
- @Override
- public Object invoke(MethodInvocation invocation) throws Throwable {
- return invocation.proceed();
- }
-
- }
-
- private class ReferenceTargetSource extends AbstractLazyCreationTargetSource {
-
- private AtomicReference reference;
-
- public ReferenceTargetSource(AtomicReference reference) {
- this.reference = reference;
- }
-
- @Override
- protected Object createObject() throws Exception {
- initialize();
- return reference.get();
- }
- }
-
-}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/StepBuilderFactory.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/StepBuilderFactory.java
deleted file mode 100644
index 7e8993201b..0000000000
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/StepBuilderFactory.java
+++ /dev/null
@@ -1,53 +0,0 @@
-/*
- * Copyright 2012-2013 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
- *
- * http://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.core.configuration.annotation;
-
-import org.springframework.batch.core.repository.JobRepository;
-import org.springframework.batch.core.step.builder.StepBuilder;
-import org.springframework.transaction.PlatformTransactionManager;
-
-/**
- * Convenient factory for a {@link StepBuilder} which sets the {@link JobRepository} and
- * {@link PlatformTransactionManager} automatically.
- *
- * @author Dave Syer
- *
- */
-public class StepBuilderFactory {
-
- private JobRepository jobRepository;
-
- private PlatformTransactionManager transactionManager;
-
- public StepBuilderFactory(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
- this.jobRepository = jobRepository;
- this.transactionManager = transactionManager;
- }
-
- /**
- * Creates a step builder and initializes its job repository and transaction manager. Note that if the builder is
- * used to create a @Bean definition then the name of the step and the bean name might be different.
- *
- * @param name the name of the step
- * @return a step builder
- */
- public StepBuilder get(String name) {
- StepBuilder builder = new StepBuilder(name).repository(jobRepository).transactionManager(
- transactionManager);
- return builder;
- }
-
-}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/StepScope.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/StepScope.java
index 19e66489ee..712f97e9b4 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/StepScope.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/StepScope.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2013 the original author or authors.
+ * Copyright 2013-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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -24,9 +24,11 @@
/**
*
- * Convenient annotation for step scoped beans that defaults the proxy mode, so that it doesn't have to be specified
- * explicitly on every bean definition. Use this on any @Bean that needs to inject @Values from the step
- * context, and any bean that needs to share a lifecycle with a step execution (e.g. an ItemStream). E.g.
+ * Convenient annotation for step-scoped beans. It defaults the proxy mode so that it need
+ * not be specified explicitly on every bean definition. Use this on any @Bean that
+ * needs to inject @Values from the step context and on any bean that needs to share a
+ * lifecycle with a step execution (such as an ItemStream). The following listing shows an
+ * example:
*
*
*
@@ -34,14 +36,17 @@
* @StepScope
* protected Callable<String> value(@Value("#{stepExecution.stepName}")
* final String value) {
- * return new SimpleCallable(value);
+ * return new SimpleCallable(value);
* }
*
*
- * Marking a @Bean as @StepScope is equivalent to marking it as @Scope(value="step", proxyMode=TARGET_CLASS)
+ *
+ * Marking a @Bean as @StepScope is equivalent to marking it as
+ * @Scope(value="step", proxyMode=TARGET_CLASS)
+ *
*
* @author Dave Syer
- *
+ * @author Taeik Lim
* @since 2.2
*
*/
@@ -50,4 +55,4 @@
@Documented
public @interface StepScope {
-}
\ No newline at end of file
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/package-info.java
index 6b876be28c..5c6ba0004d 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/package-info.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/package-info.java
@@ -4,7 +4,7 @@
* @author Michael Minella
* @author Mahmoud Ben Hassine
*/
-@NonNullApi
+@NullMarked
package org.springframework.batch.core.configuration.annotation;
-import org.springframework.lang.NonNullApi;
+import org.jspecify.annotations.NullMarked;
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/package-info.java
index 95c8411bae..e5d9b41039 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/package-info.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/package-info.java
@@ -4,7 +4,7 @@
* @author Michael Minella
* @author Mahmoud Ben Hassine
*/
-@NonNullApi
+@NullMarked
package org.springframework.batch.core.configuration;
-import org.springframework.lang.NonNullApi;
+import org.jspecify.annotations.NullMarked;
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/AbstractApplicationContextFactory.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/AbstractApplicationContextFactory.java
index b45c9fdfee..cb61736aed 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/AbstractApplicationContextFactory.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/AbstractApplicationContextFactory.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2014 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -23,6 +23,7 @@
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.NullUnmarked;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactoryAware;
@@ -31,7 +32,6 @@
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.config.CustomEditorConfigurer;
-import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer;
import org.springframework.beans.factory.support.AbstractBeanFactory;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.context.ApplicationContext;
@@ -42,17 +42,22 @@
import org.springframework.util.ClassUtils;
/**
- * {@link ApplicationContextFactory} implementation that takes a parent context and a path to the context to create.
- * When createApplicationContext method is called, the child {@link ApplicationContext} will be returned. The child
- * context is not re-created every time it is requested, it is lazily initialized and cached. Clients should ensure that
- * it is closed when it is no longer needed. If a path is not set, the parent will always be returned.
+ * {@link ApplicationContextFactory} implementation that takes a parent context and a path
+ * to the context to create. When the {@code createApplicationContext} method is called,
+ * the child {@link ApplicationContext} is returned. The child context is not re-created
+ * every time it is requested. It is lazily initialized and cached. Clients should ensure
+ * that it is closed when it is no longer needed. If a path is not set, the parent is
+ * always returned.
*
+ * @deprecated since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
*/
+@NullUnmarked
+@Deprecated(since = "6.0", forRemoval = true)
public abstract class AbstractApplicationContextFactory implements ApplicationContextFactory, ApplicationContextAware {
private static final Log logger = LogFactory.getLog(AbstractApplicationContextFactory.class);
- private Object[] resources;
+ private final Object[] resources;
private ConfigurableApplicationContext parent;
@@ -63,31 +68,30 @@ public abstract class AbstractApplicationContextFactory implements ApplicationCo
private Collection> beanPostProcessorExcludeClasses;
/**
- * Create a factory instance with the resource specified. The resources are Spring configuration files or java
- * packages containing configuration files.
- *
+ * Create a factory instance with the resource specified. The resources are Spring
+ * configuration files or Java packages that contain configuration files.
* @param resource resource to be used in the creation of the ApplicationContext.
*/
public AbstractApplicationContextFactory(Object... resource) {
this.resources = resource;
beanFactoryPostProcessorClasses = new ArrayList<>();
- beanFactoryPostProcessorClasses.add(PropertyPlaceholderConfigurer.class);
beanFactoryPostProcessorClasses.add(PropertySourcesPlaceholderConfigurer.class);
beanFactoryPostProcessorClasses.add(CustomEditorConfigurer.class);
beanPostProcessorExcludeClasses = new ArrayList<>();
/*
- * Assume that a BeanPostProcessor that is BeanFactoryAware must be specific to the parent and remove it from
- * the child (e.g. an AutoProxyCreator will not work properly). Unfortunately there might still be a a
- * BeanPostProcessor with a dependency that itself is BeanFactoryAware, but we can't legislate for that here.
+ * Assume that a BeanPostProcessor that is BeanFactoryAware must be specific to
+ * the parent and remove it from the child (e.g. an AutoProxyCreator will not work
+ * properly). Unfortunately there might still be a a BeanPostProcessor with a
+ * dependency that itself is BeanFactoryAware, but we can't legislate for that
+ * here.
*/
beanPostProcessorExcludeClasses.add(BeanFactoryAware.class);
}
/**
- * Flag to indicate that configuration such as bean post processors and custom editors should be copied from the
- * parent context. Defaults to true.
- *
+ * Flag to indicate that configuration, such as bean post processors and custom
+ * editors, should be copied from the parent context. Defaults to {@code true}.
* @param copyConfiguration the flag value to set
*/
public void setCopyConfiguration(boolean copyConfiguration) {
@@ -95,9 +99,8 @@ public void setCopyConfiguration(boolean copyConfiguration) {
}
/**
- * Protected access for subclasses to the flag determining whether configuration should be copied from parent
- * context.
- *
+ * Protected access for subclasses to the flag that determines whether configuration
+ * should be copied from the parent context.
* @return the flag value
*/
protected final boolean isCopyConfiguration() {
@@ -105,40 +108,35 @@ protected final boolean isCopyConfiguration() {
}
/**
- * Determines which bean factory post processors (like property placeholders) should be copied from the parent
- * context. Defaults to {@link PropertyPlaceholderConfigurer} and {@link CustomEditorConfigurer}.
- *
+ * Determines which bean factory post processors (such as property placeholders)
+ * should be copied from the parent context. Defaults to
+ * {@link PropertySourcesPlaceholderConfigurer} and {@link CustomEditorConfigurer}.
* @param beanFactoryPostProcessorClasses array of post processor types to be copied
*/
public void setBeanFactoryPostProcessorClasses(
Class[] beanFactoryPostProcessorClasses) {
this.beanFactoryPostProcessorClasses = new ArrayList<>();
- for (int i = 0; i < beanFactoryPostProcessorClasses.length; i++) {
- this.beanFactoryPostProcessorClasses.add(beanFactoryPostProcessorClasses[i]);
- }
+ this.beanFactoryPostProcessorClasses.addAll(Arrays.asList(beanFactoryPostProcessorClasses));
}
/**
- * Determines by exclusion which bean post processors should be copied from the parent context. Defaults to
- * {@link BeanFactoryAware} (so any post processors that have a reference to the parent bean factory are not copied
- * into the child). Note that these classes do not themselves have to be {@link BeanPostProcessor} implementations
- * or sub-interfaces.
- *
+ * Determines, by exclusion, which bean post processors should be copied from the
+ * parent context. Defaults to {@link BeanFactoryAware} (so any post processors that
+ * have a reference to the parent bean factory are not copied into the child). Note
+ * that these classes do not themselves have to be {@link BeanPostProcessor}
+ * implementations or sub-interfaces.
* @param beanPostProcessorExcludeClasses the classes to set
*/
public void setBeanPostProcessorExcludeClasses(Class[] beanPostProcessorExcludeClasses) {
this.beanPostProcessorExcludeClasses = new ArrayList<>();
- for (int i = 0; i < beanPostProcessorExcludeClasses.length; i++) {
- this.beanPostProcessorExcludeClasses.add(beanPostProcessorExcludeClasses[i]);
- }
+ this.beanPostProcessorExcludeClasses.addAll(Arrays.asList(beanPostProcessorExcludeClasses));
}
/**
- * Protected access to the list of bean factory post processor classes that should be copied over to the context
- * from the parent.
- *
+ * Protected access to the list of bean factory post processor classes that should be
+ * copied over to the context from the parent.
* @return the classes for post processors that were nominated for copying
*/
protected final Collection> getBeanFactoryPostProcessorClasses() {
@@ -179,11 +177,11 @@ protected abstract ConfigurableApplicationContext createApplicationContext(Confi
Object... resources);
/**
- * Extension point for special subclasses that want to do more complex things with the context prior to refresh. The
- * default implementation does nothing.
- *
+ * Extension point for special subclasses that want to do more complex things with the
+ * context prior to refresh. The default implementation does nothing.
* @param parent the parent for the new application context
- * @param context the new application context before it is refreshed, but after bean factory is initialized
+ * @param context the new application context before it is refreshed but after the
+ * bean factory is initialized
*
* @see AbstractApplicationContextFactory#setBeanFactoryPostProcessorClasses(Class[])
*/
@@ -191,11 +189,10 @@ protected void prepareContext(ConfigurableApplicationContext parent, Configurabl
}
/**
- * Extension point for special subclasses that want to do more complex things with the bean factory prior to
- * refresh. The default implementation copies all configuration from the parent according to the
- * {@link #setCopyConfiguration(boolean) flag} set.
- *
- * @param parent the parent bean factory for the new context (will never be null)
+ * Extension point for special subclasses that want to do more complex things with the
+ * bean factory prior to refresh. The default implementation copies all configuration
+ * from the parent according to the {@link #setCopyConfiguration(boolean) flag} set.
+ * @param parent the parent bean factory for the new context (can never be null)
* @param beanFactory the new bean factory before bean definitions are loaded
*
* @see AbstractApplicationContextFactory#setCopyConfiguration(boolean)
@@ -204,18 +201,16 @@ protected void prepareContext(ConfigurableApplicationContext parent, Configurabl
protected void prepareBeanFactory(ConfigurableListableBeanFactory parent,
ConfigurableListableBeanFactory beanFactory) {
if (copyConfiguration && parent != null) {
- List parentPostProcessors = new ArrayList<>();
- List childPostProcessors = new ArrayList<>();
-
- childPostProcessors.addAll(beanFactory instanceof AbstractBeanFactory ? ((AbstractBeanFactory) beanFactory)
- .getBeanPostProcessors() : new ArrayList<>());
- parentPostProcessors.addAll(parent instanceof AbstractBeanFactory ? ((AbstractBeanFactory) parent)
- .getBeanPostProcessors() : new ArrayList<>());
+ List childPostProcessors = new ArrayList<>(
+ beanFactory instanceof AbstractBeanFactory factory ? factory.getBeanPostProcessors()
+ : new ArrayList<>());
+ List parentPostProcessors = new ArrayList<>(parent instanceof AbstractBeanFactory factory
+ ? factory.getBeanPostProcessors() : new ArrayList<>());
try {
- Class applicationContextAwareProcessorClass =
- ClassUtils.forName("org.springframework.context.support.ApplicationContextAwareProcessor",
- parent.getBeanClassLoader());
+ Class applicationContextAwareProcessorClass = ClassUtils.forName(
+ "org.springframework.context.support.ApplicationContextAwareProcessor",
+ parent.getBeanClassLoader());
for (BeanPostProcessor beanPostProcessor : new ArrayList<>(parentPostProcessors)) {
if (applicationContextAwareProcessorClass.isAssignableFrom(beanPostProcessor.getClass())) {
@@ -245,8 +240,8 @@ protected void prepareBeanFactory(ConfigurableListableBeanFactory parent,
beanFactory.copyConfigurationFrom(parent);
- List beanPostProcessors = beanFactory instanceof AbstractBeanFactory ? ((AbstractBeanFactory) beanFactory)
- .getBeanPostProcessors() : new ArrayList<>();
+ List beanPostProcessors = beanFactory instanceof AbstractBeanFactory abstractBeanFactory
+ ? abstractBeanFactory.getBeanPostProcessors() : new ArrayList<>();
beanPostProcessors.clear();
beanPostProcessors.addAll(aggregatedPostProcessors);
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ApplicationContextFactory.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ApplicationContextFactory.java
index 1f7506439e..343e25644d 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ApplicationContextFactory.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ApplicationContextFactory.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -16,19 +16,24 @@
package org.springframework.batch.core.configuration.support;
-import org.springframework.batch.core.Job;
+import org.jspecify.annotations.NullUnmarked;
+
+import org.springframework.batch.core.job.Job;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ConfigurableApplicationContext;
/**
- * Factory for the creation of {@link ApplicationContext}s. This interface
- * is primarily useful when creating a new {@link ApplicationContext} per
- * execution of a {@link Job}.
- *
+ * Factory for the creation of {@link ApplicationContext} instances. This interface is
+ * primarily useful when creating a new {@link ApplicationContext} for a {@link Job}.
+ *
* @author Lucas Ward
+ * @author Mahmoud Ben Hassine
+ * @deprecated since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
*/
+@NullUnmarked
+@Deprecated(since = "6.0", forRemoval = true)
public interface ApplicationContextFactory {
ConfigurableApplicationContext createApplicationContext();
-
+
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ApplicationContextJobFactory.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ApplicationContextJobFactory.java
index 9c194b4b02..33f93cc1ad 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ApplicationContextJobFactory.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ApplicationContextJobFactory.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2013 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -15,37 +15,41 @@
*/
package org.springframework.batch.core.configuration.support;
-import org.springframework.batch.core.Job;
+import org.jspecify.annotations.NullUnmarked;
+
+import org.springframework.batch.core.job.Job;
import org.springframework.batch.core.configuration.JobFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ConfigurableApplicationContext;
/**
- * A {@link JobFactory} that creates its own {@link ApplicationContext} and
- * pulls a bean out when asked to create a {@link Job}.
+ * A {@link JobFactory} that creates its own {@link ApplicationContext} and pulls a bean
+ * out when asked to create a {@link Job}.
*
* @author Dave Syer
+ * @author Mahmoud Ben Hassine
+ * @deprecated since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
*
*/
+@NullUnmarked
+@Deprecated(since = "6.0", forRemoval = true)
public class ApplicationContextJobFactory implements JobFactory {
private final Job job;
/**
- * @param jobName the id of the {@link Job} in the application context to be
- * created
- * @param applicationContextFactory a factory for an application context
- * containing a job with the job name provided
+ * @param jobName the ID of the {@link Job} in the application context to be created.
+ * @param applicationContextFactory a factory for an application context that contains
+ * a job with the job name provided.
*/
public ApplicationContextJobFactory(String jobName, ApplicationContextFactory applicationContextFactory) {
- @SuppressWarnings("resource")
ConfigurableApplicationContext context = applicationContextFactory.createApplicationContext();
this.job = context.getBean(jobName, Job.class);
}
/**
- * Create an {@link ApplicationContext} from the factory provided and pull
- * out a bean with the name given during initialization.
+ * Create an {@link ApplicationContext} from the factory provided and pull out a bean
+ * with the name given during initialization.
*
* @see org.springframework.batch.core.configuration.JobFactory#createJob()
*/
@@ -55,7 +59,7 @@ public final Job createJob() {
}
/**
- * Just return the name of instance passed in on initialization.
+ * Return the name of the instance passed in on initialization.
*
* @see JobFactory#getJobName()
*/
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/AutomaticJobRegistrar.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/AutomaticJobRegistrar.java
index 92211ada55..e5be267d1f 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/AutomaticJobRegistrar.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/AutomaticJobRegistrar.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2018 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -17,9 +17,12 @@
package org.springframework.batch.core.configuration.support;
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.Collection;
-import org.springframework.batch.core.Job;
+import org.jspecify.annotations.NullUnmarked;
+
+import org.springframework.batch.core.job.Job;
import org.springframework.batch.core.configuration.DuplicateJobException;
import org.springframework.batch.core.configuration.JobRegistry;
import org.springframework.beans.factory.InitializingBean;
@@ -32,20 +35,22 @@
import org.springframework.util.Assert;
/**
- * Loads and unloads {@link Job Jobs} when the application context is created and destroyed. Each resource provided is
- * loaded as an application context with the current context as its parent, and then all the jobs from the child context
- * are registered under their bean names. A {@link JobRegistry} is required.
+ * Loads and unloads {@link Job Jobs} when the application context is created and
+ * destroyed. Each provided resource is loaded as an application context with the current
+ * context as its parent. Then all the jobs from the child context are registered under
+ * their bean names. A {@link JobRegistry} is required.
*
* @author Lucas Ward
* @author Dave Syer
* @author Mahmoud Ben Hassine
- *
* @since 2.1
+ * @deprecated since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
*/
-public class AutomaticJobRegistrar implements Ordered, SmartLifecycle, ApplicationContextAware,
- InitializingBean {
+@NullUnmarked
+@Deprecated(since = "6.0", forRemoval = true)
+public class AutomaticJobRegistrar implements Ordered, SmartLifecycle, ApplicationContextAware, InitializingBean {
- private Collection applicationContextFactories = new ArrayList<>();
+ private final Collection applicationContextFactories = new ArrayList<>();
private JobLoader jobLoader;
@@ -57,15 +62,14 @@ public class AutomaticJobRegistrar implements Ordered, SmartLifecycle, Applicati
private boolean autoStartup = true;
- private Object lifecycleMonitor = new Object();
+ private final Object lifecycleMonitor = new Object();
private int order = Ordered.LOWEST_PRECEDENCE;
/**
- * The enclosing application context, which can be used to check if {@link ApplicationContextEvent events} come
- * from the expected source.
- *
- * @param applicationContext the enclosing application context if there is one
+ * The enclosing application context, which you can use to check whether
+ * {@link ApplicationContextEvent events} come from the expected source.
+ * @param applicationContext the enclosing application context, if there is one
* @see ApplicationContextAware#setApplicationContext(ApplicationContext)
*/
@Override
@@ -74,31 +78,30 @@ public void setApplicationContext(ApplicationContext applicationContext) {
}
/**
- * Add some factories to the set that will be used to load contexts and jobs.
- *
- * @param applicationContextFactory the {@link ApplicationContextFactory} values to use
+ * Add a single {@link ApplicationContextFactory} to the set that is used to load
+ * contexts and jobs.
+ * @param applicationContextFactory the {@link ApplicationContextFactory} values to
+ * use
*/
public void addApplicationContextFactory(ApplicationContextFactory applicationContextFactory) {
- if (applicationContextFactory instanceof ApplicationContextAware) {
- ((ApplicationContextAware) applicationContextFactory).setApplicationContext(applicationContext);
+ if (applicationContextFactory instanceof ApplicationContextAware applicationContextAware) {
+ applicationContextAware.setApplicationContext(applicationContext);
}
this.applicationContextFactories.add(applicationContextFactory);
}
/**
- * Add some factories to the set that will be used to load contexts and jobs.
- *
- * @param applicationContextFactories the {@link ApplicationContextFactory} values to use
+ * Add an array of {@link ApplicationContextFactory} instances to the set that is used
+ * to load contexts and jobs.
+ * @param applicationContextFactories the {@link ApplicationContextFactory} values to
+ * use
*/
public void setApplicationContextFactories(ApplicationContextFactory[] applicationContextFactories) {
- for (ApplicationContextFactory applicationContextFactory : applicationContextFactories) {
- this.applicationContextFactories.add(applicationContextFactory);
- }
+ this.applicationContextFactories.addAll(Arrays.asList(applicationContextFactories));
}
/**
- * The job loader that will be used to load and manage jobs.
- *
+ * The job loader that is used to load and manage jobs.
* @param jobLoader the {@link JobLoader} to set
*/
public void setJobLoader(JobLoader jobLoader) {
@@ -111,7 +114,7 @@ public int getOrder() {
}
/**
- * The order to start up and shutdown.
+ * The order in which to start up and shutdown.
* @param order the order (default {@link Ordered#LOWEST_PRECEDENCE}).
* @see Ordered
*/
@@ -142,7 +145,8 @@ public void stop() {
}
/**
- * Take all the contexts from the factories provided and pass them to the {@link JobLoader}.
+ * Take all the contexts from the factories provided and pass them to the
+ * {@link JobLoader}.
*
* @see Lifecycle#start()
*/
@@ -165,9 +169,8 @@ public void start() {
}
/**
- * Check if this component has been started.
- *
- * @return true if started successfully and not stopped
+ * Check whether this component has been started.
+ * @return {@code true} if started successfully and not stopped.
* @see Lifecycle#isRunning()
*/
@Override
@@ -183,7 +186,7 @@ public boolean isAutoStartup() {
}
/**
- * @param autoStartup true for auto start.
+ * @param autoStartup {@code true} for auto start.
* @see #isAutoStartup()
*/
public void setAutoStartup(boolean autoStartup) {
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ClassPathXmlApplicationContextFactory.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ClassPathXmlApplicationContextFactory.java
deleted file mode 100644
index 4e3db9beef..0000000000
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ClassPathXmlApplicationContextFactory.java
+++ /dev/null
@@ -1,44 +0,0 @@
-/*
- * Copyright 2006-2007 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
- *
- * http://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.core.configuration.support;
-
-import org.springframework.context.ApplicationContext;
-import org.springframework.core.io.Resource;
-
-/**
- * {@link ApplicationContextFactory} implementation that takes a parent context
- * and a path to the context to create. When createApplicationContext method is
- * called, the child {@link ApplicationContext} will be returned. The child
- * context is not re-created every time it is requested, it is lazily
- * initialized and cached. Clients should ensure that it is closed when it is no
- * longer needed. If a path is not set, the parent will always be returned.
- *
- * @deprecated use {@link GenericApplicationContextFactory} instead
- */
-@Deprecated
-public class ClassPathXmlApplicationContextFactory extends GenericApplicationContextFactory {
-
- /**
- * Create an application context factory for the resource specified.
- *
- * @param resource a resource (XML configuration file)
- */
- public ClassPathXmlApplicationContextFactory(Resource resource) {
- super(resource);
- }
-
-}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ClassPathXmlJobRegistry.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ClassPathXmlJobRegistry.java
deleted file mode 100644
index 614d33629a..0000000000
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ClassPathXmlJobRegistry.java
+++ /dev/null
@@ -1,28 +0,0 @@
-/*
- * Copyright 2008-2010 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
- *
- * http://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.core.configuration.support;
-
-/**
- * Placeholder for deprecation warning.
- *
- * @author Dave Syer
- *
- * @deprecated in version 2.1, please us {@link AutomaticJobRegistrar} instead
- */
-@Deprecated
-public abstract class ClassPathXmlJobRegistry {
-
-}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ClasspathXmlApplicationContextsFactoryBean.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ClasspathXmlApplicationContextsFactoryBean.java
index 97b5ec6d67..e2a2cad4e9 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ClasspathXmlApplicationContextsFactoryBean.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ClasspathXmlApplicationContextsFactoryBean.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2010 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -19,24 +19,31 @@
import java.util.Arrays;
import java.util.List;
+import org.jspecify.annotations.NullUnmarked;
+
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.beans.factory.config.CustomEditorConfigurer;
-import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
+import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
import org.springframework.core.io.Resource;
/**
- * A convenient factory for creating a set of {@link ApplicationContextFactory}
- * components from a set of {@link Resource resources}.
+ * A convenient factory for creating a set of {@link ApplicationContextFactory} components
+ * from a set of {@link Resource resources}.
*
* @author Dave Syer
- *
+ * @author Mahmoud Ben Hassine
+ * @deprecated since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
*/
-public class ClasspathXmlApplicationContextsFactoryBean implements FactoryBean, ApplicationContextAware {
+@NullUnmarked
+@SuppressWarnings("removal")
+@Deprecated(since = "6.0", forRemoval = true)
+public class ClasspathXmlApplicationContextsFactoryBean
+ implements FactoryBean, ApplicationContextAware {
private List resources = new ArrayList<>();
@@ -49,13 +56,11 @@ public class ClasspathXmlApplicationContextsFactoryBean implements FactoryBeanclasspath*:/config/*-context.xml).
- *
* @param resources array of resources to use
*/
public void setResources(Resource[] resources) {
@@ -63,10 +68,8 @@ public void setResources(Resource[] resources) {
}
/**
- * Flag to indicate that configuration such as bean post processors and
- * custom editors should be copied from the parent context. Defaults to
- * true.
- *
+ * Flag to indicate that configuration, such as bean post processors and custom
+ * editors, should be copied from the parent context. Defaults to {@code true}.
* @param copyConfiguration the flag value to set
*/
public void setCopyConfiguration(boolean copyConfiguration) {
@@ -74,10 +77,9 @@ public void setCopyConfiguration(boolean copyConfiguration) {
}
/**
- * Determines which bean factory post processors (like property
- * placeholders) should be copied from the parent context. Defaults to
- * {@link PropertyPlaceholderConfigurer} and {@link CustomEditorConfigurer}.
- *
+ * Determines which bean factory post processors (such as property placeholders)
+ * should be copied from the parent context. Defaults to
+ * {@link PropertySourcesPlaceholderConfigurer} and {@link CustomEditorConfigurer}.
* @param beanFactoryPostProcessorClasses post processor types to be copied
*/
@@ -87,12 +89,11 @@ public void setBeanFactoryPostProcessorClasses(
}
/**
- * Determines by exclusion which bean post processors should be copied from
- * the parent context. Defaults to {@link BeanFactoryAware} (so any post
- * processors that have a reference to the parent bean factory are not
- * copied into the child). Note that these classes do not themselves have to
- * be {@link BeanPostProcessor} implementations or sub-interfaces.
- *
+ * Determines, by exclusion, which bean post processors should be copied from the
+ * parent context. Defaults to {@link BeanFactoryAware} (so any post processors that
+ * have a reference to the parent bean factory are not copied into the child). Note
+ * that these classes do not themselves have to be {@link BeanPostProcessor}
+ * implementations or sub-interfaces.
* @param beanPostProcessorExcludeClasses the classes to set
*/
public void setBeanPostProcessorExcludeClasses(Class[] beanPostProcessorExcludeClasses) {
@@ -100,9 +101,8 @@ public void setBeanPostProcessorExcludeClasses(Class[] beanPostProcessorExclu
}
/**
- * Create an {@link ApplicationContextFactory} from each resource provided
- * in {@link #setResources(Resource[])}.
- *
+ * Create an {@link ApplicationContextFactory} from each resource provided in
+ * {@link #setResources(Resource[])}.
* @return an array of {@link ApplicationContextFactory}
* @see org.springframework.beans.factory.FactoryBean#getObject()
*/
@@ -130,9 +130,8 @@ public ApplicationContextFactory[] getObject() throws Exception {
}
/**
- * The type of object returned by this factory - an array of
+ * The type of object returned by this factory as an array of
* {@link ApplicationContextFactory}.
- *
* @return array of {@link ApplicationContextFactory}
* @see FactoryBean#getObjectType()
*/
@@ -143,7 +142,7 @@ public Class getObjectType() {
/**
* Optimization hint for bean factory.
- * @return true
+ * @return {@code true}
* @see FactoryBean#isSingleton()
*/
@Override
@@ -152,9 +151,7 @@ public boolean isSingleton() {
}
/**
- * An application context that can be used as a parent context for all the
- * factories.
- *
+ * An application context that can be used as a parent context for all the factories.
* @param applicationContext the {@link ApplicationContext} to set
* @see ApplicationContextAware#setApplicationContext(org.springframework.context.ApplicationContext)
*/
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultBatchConfiguration.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultBatchConfiguration.java
new file mode 100644
index 0000000000..6b77693105
--- /dev/null
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultBatchConfiguration.java
@@ -0,0 +1,171 @@
+/*
+ * Copyright 2012-2026 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.core.configuration.support;
+
+import io.micrometer.observation.ObservationRegistry;
+
+import org.springframework.batch.core.configuration.DuplicateJobException;
+import org.springframework.batch.core.configuration.annotation.BatchObservabilityBeanPostProcessor;
+import org.springframework.batch.core.job.Job;
+import org.springframework.batch.core.configuration.BatchConfigurationException;
+import org.springframework.batch.core.configuration.JobRegistry;
+import org.springframework.batch.core.converter.DefaultJobParametersConverter;
+import org.springframework.batch.core.converter.JobParametersConverter;
+import org.springframework.batch.core.launch.JobOperator;
+import org.springframework.batch.core.launch.support.JobOperatorFactoryBean;
+import org.springframework.batch.core.launch.support.TaskExecutorJobOperator;
+import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.batch.core.repository.support.ResourcelessJobRepository;
+import org.springframework.batch.infrastructure.support.transaction.ResourcelessTransactionManager;
+import org.springframework.beans.BeansException;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import org.springframework.core.task.SyncTaskExecutor;
+import org.springframework.core.task.TaskExecutor;
+import org.springframework.transaction.PlatformTransactionManager;
+
+/**
+ * Base {@link Configuration} class that provides common infrastructure beans for enabling
+ * and using Spring Batch.
+ *
+ * This configuration class configures and registers the following beans in the
+ * application context:
+ *
+ *
+ *
+ *
+ * Customization is possible by extending the class and overriding getters.
+ *
+ * A typical usage of this class is as follows:
+ * @Configuration
+ * public class MyJobConfiguration extends DefaultBatchConfiguration {
+ *
+ * @Bean
+ * public Job job(JobRepository jobRepository) {
+ * return new JobBuilder("myJob", jobRepository)
+ * // define job flow as needed
+ * .build();
+ * }
+ *
+ * }
+ *
+ *
+ * @author Dave Syer
+ * @author Michael Minella
+ * @author Mahmoud Ben Hassine
+ * @author Taeik Lim
+ * @author Yanming Zhou
+ * @since 5.0
+ */
+@Configuration(proxyBeanMethods = false)
+@Import({ ScopeConfiguration.class, BatchObservabilityBeanPostProcessor.class })
+public class DefaultBatchConfiguration implements ApplicationContextAware {
+
+ @SuppressWarnings("NullAway.Init")
+ protected ApplicationContext applicationContext;
+
+ @Override
+ public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
+ this.applicationContext = applicationContext;
+ }
+
+ @Bean
+ public JobRepository jobRepository() {
+ return new ResourcelessJobRepository();
+ }
+
+ @Bean
+ public JobOperator jobOperator(JobRepository jobRepository) throws BatchConfigurationException {
+ JobOperatorFactoryBean jobOperatorFactoryBean = new JobOperatorFactoryBean();
+ jobOperatorFactoryBean.setJobRepository(jobRepository);
+ jobOperatorFactoryBean.setJobRegistry(getJobRegistry());
+ jobOperatorFactoryBean.setTransactionManager(getTransactionManager());
+ jobOperatorFactoryBean.setObservationRegistry(getObservationRegistry());
+ jobOperatorFactoryBean.setJobParametersConverter(getJobParametersConverter());
+ jobOperatorFactoryBean.setTaskExecutor(getTaskExecutor());
+ try {
+ jobOperatorFactoryBean.afterPropertiesSet();
+ return jobOperatorFactoryBean.getObject();
+ }
+ catch (Exception e) {
+ throw new BatchConfigurationException("Unable to configure the default job operator", e);
+ }
+ }
+
+ // FIXME getter with side effect, see JobOperatorFactoryBean.populateJobRegistry
+ protected JobRegistry getJobRegistry() {
+ return this.applicationContext.getBeanProvider(JobRegistry.class).getIfAvailable(() -> {
+ MapJobRegistry jobRegistry = new MapJobRegistry();
+ this.applicationContext.getBeansOfType(Job.class).values().forEach(job -> {
+ try {
+ jobRegistry.register(job);
+ }
+ catch (DuplicateJobException e) {
+ throw new BatchConfigurationException(e);
+ }
+ });
+ return jobRegistry;
+ });
+ }
+
+ /**
+ * Return the {@link ObservationRegistry} to use for the job operator. Defaults to
+ * {@link ObservationRegistry#NOOP}.
+ * @return The ObservationRegistry to use for the job operator
+ * @since 6.0
+ */
+ protected ObservationRegistry getObservationRegistry() {
+ return ObservationRegistry.NOOP;
+ }
+
+ /**
+ * Return the transaction manager to use for the job operator. Defaults to
+ * {@link ResourcelessTransactionManager}.
+ * @return The transaction manager to use for the job operator
+ */
+ protected PlatformTransactionManager getTransactionManager() {
+ return new ResourcelessTransactionManager();
+ }
+
+ /**
+ * Return the {@link TaskExecutor} to use in the job operator. Defaults to
+ * {@link SyncTaskExecutor}.
+ * @return the {@link TaskExecutor} to use in the job operator.
+ */
+ protected TaskExecutor getTaskExecutor() {
+ return new SyncTaskExecutor();
+ }
+
+ /**
+ * Return the {@link JobParametersConverter} to use in the job operator. Defaults to
+ * {@link DefaultJobParametersConverter}
+ * @return the {@link JobParametersConverter} to use in the job operator.
+ * @deprecated since 6.0 with no replacement and scheduled for removal in 6.2 or
+ * later.
+ */
+ @Deprecated(since = "6.0", forRemoval = true)
+ protected JobParametersConverter getJobParametersConverter() {
+ return new DefaultJobParametersConverter();
+ }
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultJobLoader.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultJobLoader.java
index 02cc3ae1ad..455ba8ebd6 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultJobLoader.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultJobLoader.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2018 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -23,44 +23,48 @@
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.NullUnmarked;
-import org.springframework.batch.core.Job;
-import org.springframework.batch.core.Step;
+import org.springframework.batch.core.job.Job;
+import org.springframework.batch.core.step.ListableStepLocator;
+import org.springframework.batch.core.step.Step;
import org.springframework.batch.core.configuration.DuplicateJobException;
-import org.springframework.batch.core.configuration.JobFactory;
import org.springframework.batch.core.configuration.JobRegistry;
import org.springframework.batch.core.configuration.StepRegistry;
-import org.springframework.batch.core.launch.NoSuchJobException;
import org.springframework.batch.core.step.StepLocator;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ConfigurableApplicationContext;
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
import org.springframework.util.Assert;
/**
- * Default implementation of {@link JobLoader}. Uses a {@link JobRegistry} to
- * manage a population of loaded jobs and clears them up when asked. An optional
- * {@link StepRegistry} might also be set to register the step(s) available for
- * each registered job.
+ * Default implementation of {@link JobLoader}. Uses a {@link JobRegistry} to manage a
+ * population of loaded jobs and clears them up when asked. An optional
+ * {@link StepRegistry} might also be set to register the step(s) available for each
+ * registered job.
*
* @author Dave Syer
* @author Stephane Nicoll
* @author Mahmoud Ben Hassine
+ * @deprecated since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
*/
+@NullUnmarked
+@Deprecated(since = "6.0", forRemoval = true)
public class DefaultJobLoader implements JobLoader, InitializingBean {
- private static Log logger = LogFactory.getLog(DefaultJobLoader.class);
+ private static final Log logger = LogFactory.getLog(DefaultJobLoader.class);
private JobRegistry jobRegistry;
+
private StepRegistry stepRegistry;
- private Map contexts = new ConcurrentHashMap<>();
+ private final Map contexts = new ConcurrentHashMap<>();
- private Map> contextToJobNames = new ConcurrentHashMap<>();
+ private final Map> contextToJobNames = new ConcurrentHashMap<>();
/**
- * Default constructor useful for declarative configuration.
+ * Default constructor. Useful for declarative configuration.
*/
public DefaultJobLoader() {
this(null, null);
@@ -68,7 +72,6 @@ public DefaultJobLoader() {
/**
* Creates a job loader with the job registry provided.
- *
* @param jobRegistry a {@link JobRegistry}
*/
public DefaultJobLoader(JobRegistry jobRegistry) {
@@ -77,7 +80,6 @@ public DefaultJobLoader(JobRegistry jobRegistry) {
/**
* Creates a job loader with the job and step registries provided.
- *
* @param jobRegistry a {@link JobRegistry}
* @param stepRegistry a {@link StepRegistry} (can be {@code null})
*/
@@ -88,7 +90,6 @@ public DefaultJobLoader(JobRegistry jobRegistry, @Nullable StepRegistry stepRegi
/**
* The {@link JobRegistry} to use for jobs created.
- *
* @param jobRegistry the job registry
*/
public void setJobRegistry(JobRegistry jobRegistry) {
@@ -97,7 +98,6 @@ public void setJobRegistry(JobRegistry jobRegistry) {
/**
* The {@link StepRegistry} to use for the steps of created jobs.
- *
* @param stepRegistry the step registry
*/
public void setStepRegistry(StepRegistry stepRegistry) {
@@ -105,8 +105,7 @@ public void setStepRegistry(StepRegistry stepRegistry) {
}
/**
- * Unregister all the jobs and close all the contexts created by this
- * loader.
+ * Unregister all the jobs and close all the contexts created by this loader.
*
* @see JobLoader#clear()
*/
@@ -153,7 +152,6 @@ public Collection load(ApplicationContextFactory factory) throws DuplicateJ
return doLoad(factory, false);
}
- @SuppressWarnings("resource")
private Collection doLoad(ApplicationContextFactory factory, boolean unregister) throws DuplicateJobException {
Collection jobNamesBefore = jobRegistry.getJobNames();
@@ -178,7 +176,7 @@ private Collection doLoad(ApplicationContextFactory factory, boolean unregi
if (!autoRegistrationDetected) {
- Job job = (Job) context.getBean(name);
+ Job job = context.getBean(name, Job.class);
String jobName = job.getName();
// On reload try to unregister first
@@ -200,14 +198,11 @@ private Collection doLoad(ApplicationContextFactory factory, boolean unregi
Collection result = new ArrayList<>();
for (String name : jobsRegistered) {
- try {
- result.add(jobRegistry.getJob(name));
- }
- catch (NoSuchJobException e) {
- // should not happen;
- throw new IllegalStateException("Could not retrieve job that was should have been registered", e);
+ Job job = jobRegistry.getJob(name);
+ if (job == null) {
+ throw new IllegalStateException("Could not retrieve job that was should have been registered");
}
-
+ result.add(job);
}
contextToJobNames.put(context, jobsRegistered);
@@ -217,25 +212,27 @@ private Collection doLoad(ApplicationContextFactory factory, boolean unregi
}
/**
- * Returns all the {@link Step} instances defined by the specified {@link StepLocator}.
- *
- * The specified jobApplicationContext is used to collect additional steps that
- * are not exposed by the step locator
- *
+ * Returns all the {@link Step} instances defined by the specified
+ * {@link StepLocator}.
+ * The specified jobApplicationContext is used to collect additional steps
+ * that are not exposed by the step locator
* @param stepLocator the given step locator
* @param jobApplicationContext the application context of the job
* @return all the {@link Step} defined by the given step locator and context
* @see StepLocator
*/
- private Collection getSteps(final StepLocator stepLocator, final ApplicationContext jobApplicationContext) {
+ private Collection getSteps(final ListableStepLocator stepLocator,
+ final ApplicationContext jobApplicationContext) {
final Collection stepNames = stepLocator.getStepNames();
final Collection result = new ArrayList<>();
for (String stepName : stepNames) {
result.add(stepLocator.getStep(stepName));
}
- // Because some steps are referenced by name, we need to look in the context to see if there
- // are more Step instances defined. Right now they are registered as being available in the
+ // Because some steps are referenced by name, we need to look in the context to
+ // see if there
+ // are more Step instances defined. Right now they are registered as being
+ // available in the
// context of the job but we have no idea if they are linked to that Job or not.
final Map allSteps = jobApplicationContext.getBeansOfType(Step.class);
for (Map.Entry entry : allSteps.entrySet()) {
@@ -247,33 +244,30 @@ private Collection getSteps(final StepLocator stepLocator, final Applicati
}
/**
- * Registers the specified {@link Job} defined in the specified {@link ConfigurableApplicationContext}.
- *
- * Makes sure to update the {@link StepRegistry} if it is available.
- *
+ * Registers the specified {@link Job} defined in the specified
+ * {@link ConfigurableApplicationContext}.
+ * Updates the {@link StepRegistry} if it is available.
* @param context the context in which the job is defined
* @param job the job to register
* @throws DuplicateJobException if that job is already registered
*/
private void doRegister(ConfigurableApplicationContext context, Job job) throws DuplicateJobException {
- final JobFactory jobFactory = new ReferenceJobFactory(job);
- jobRegistry.register(jobFactory);
+ jobRegistry.register(job);
if (stepRegistry != null) {
- if (!(job instanceof StepLocator)) {
+ if (!(job instanceof ListableStepLocator stepLocator)) {
throw new UnsupportedOperationException("Cannot locate steps from a Job that is not a StepLocator: job="
+ job.getName() + " does not implement StepLocator");
}
- stepRegistry.register(job.getName(), getSteps((StepLocator) job, context));
+ stepRegistry.register(job.getName(), getSteps(stepLocator, context));
}
}
/**
* Unregisters the job identified by the specified jobName.
- *
* @param jobName the name of the job to unregister
*/
- private void doUnregister(String jobName) {
+ private void doUnregister(String jobName) {
jobRegistry.unregister(jobName);
if (stepRegistry != null) {
stepRegistry.unregisterStepsFromJob(jobName);
@@ -283,6 +277,7 @@ private void doUnregister(String jobName) {
@Override
public void afterPropertiesSet() {
- Assert.notNull(jobRegistry, "Job registry could not be null.");
+ Assert.state(jobRegistry != null, "Job registry could not be null.");
}
+
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GenericApplicationContextFactory.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GenericApplicationContextFactory.java
index 81fc8686eb..a4ed224613 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GenericApplicationContextFactory.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GenericApplicationContextFactory.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -33,29 +33,37 @@
import java.util.Arrays;
import java.util.List;
+import org.jspecify.annotations.NullUnmarked;
+
/**
- * {@link ApplicationContextFactory} implementation that takes a parent context and a path to the context to create.
- * When createApplicationContext method is called, the child {@link ApplicationContext} will be returned. The child
- * context is not re-created every time it is requested, it is lazily initialized and cached. Clients should ensure that
- * it is closed when it is no longer needed.
- *
+ * {@link ApplicationContextFactory} implementation that takes a parent context and a path
+ * to the context to create. When the {@code createApplicationContext} method is called,
+ * the child {@link ApplicationContext} is returned. The child context is not re-created
+ * every time it is requested. It is lazily initialized and cached. Clients should ensure
+ * that it is closed when it is no longer needed.
+ *
+ * @deprecated since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
*/
+@NullUnmarked
+@Deprecated(since = "6.0", forRemoval = true)
public class GenericApplicationContextFactory extends AbstractApplicationContextFactory {
/**
- * Create an application context factory for the resource specified. The resource can be an actual {@link Resource},
- * in which case it will be interpreted as an XML file, or it can be a @Configuration class, or a package name.
- * All types must be the same (mixing XML with a java package for example is not allowed and will result in an
+ * Create an application context factory for the specified resource. The resource can
+ * be an actual {@link Resource} (in which case, it is interpreted as an XML file), or
+ * it can be a @Configuration class or a package name. All types must be the same
+ * (mixing XML with a Java package, for example, is not allowed and results in an
* {@link java.lang.IllegalArgumentException}).
- *
- * @param resources some resources (XML configuration files, @Configuration classes or java packages to scan)
+ * @param resources some resources (XML configuration files, @Configuration
+ * classes, or Java packages to scan)
*/
public GenericApplicationContextFactory(Object... resources) {
super(resources);
}
/**
- * @see AbstractApplicationContextFactory#createApplicationContext(ConfigurableApplicationContext, Object...)
+ * @see AbstractApplicationContextFactory#createApplicationContext(ConfigurableApplicationContext,
+ * Object...)
*/
@Override
protected ConfigurableApplicationContext createApplicationContext(ConfigurableApplicationContext parent,
@@ -63,23 +71,26 @@ protected ConfigurableApplicationContext createApplicationContext(ConfigurableAp
ConfigurableApplicationContext context;
if (allObjectsOfType(resources, Resource.class)) {
- context = new ResourceXmlApplicationContext(parent, resources);
- } else if (allObjectsOfType(resources, Class.class)) {
- context = new ResourceAnnotationApplicationContext(parent, resources);
- } else if (allObjectsOfType(resources, String.class)) {
- context = new ResourceAnnotationApplicationContext(parent, resources);
- } else {
+ context = new ResourceXmlApplicationContext(parent, resources);
+ }
+ else if (allObjectsOfType(resources, Class.class)) {
+ context = new ResourceAnnotationApplicationContext(parent, resources);
+ }
+ else if (allObjectsOfType(resources, String.class)) {
+ context = new ResourceAnnotationApplicationContext(parent, resources);
+ }
+ else {
List> types = new ArrayList<>();
for (Object resource : resources) {
types.add(resource.getClass());
}
- throw new IllegalArgumentException("No application context could be created for resource types: "
- + Arrays.toString(types.toArray()));
+ throw new IllegalArgumentException(
+ "No application context could be created for resource types: " + Arrays.toString(types.toArray()));
}
return context;
}
-
+
private boolean allObjectsOfType(Object[] objects, Class type) {
for (Object object : objects) {
if (!type.isInstance(object)) {
@@ -121,7 +132,7 @@ protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) {
GenericApplicationContextFactory.this.prepareBeanFactory(parentBeanFactory, beanFactory);
for (Class cls : getBeanFactoryPostProcessorClasses()) {
for (String name : parent.getBeanNamesForType(cls)) {
- beanFactory.registerSingleton(name, (parent.getBean(name)));
+ beanFactory.registerSingleton(name, parent.getBean(name));
}
}
}
@@ -133,36 +144,36 @@ private final class ResourceXmlApplicationContext extends GenericXmlApplicationC
private final ApplicationContextHelper helper;
- /**
- * @param parent
- */
public ResourceXmlApplicationContext(ConfigurableApplicationContext parent, Object... resources) {
class ResourceXmlApplicationContextHelper extends ApplicationContextHelper {
- ResourceXmlApplicationContextHelper(ConfigurableApplicationContext parent, GenericApplicationContext context, Object... config) {
+ ResourceXmlApplicationContextHelper(ConfigurableApplicationContext parent,
+ GenericApplicationContext context, Object... config) {
super(parent, context, config);
}
@Override
protected String generateId(Object... configs) {
Resource[] resources = Arrays.copyOfRange(configs, 0, configs.length, Resource[].class);
- try {
- List uris = new ArrayList<>();
- for (Resource resource : resources) {
- uris.add(resource.getURI().toString());
- }
- return StringUtils.collectionToCommaDelimitedString(uris);
- }
- catch (IOException e) {
- return Arrays.toString(resources);
- }
+ try {
+ List uris = new ArrayList<>();
+ for (Resource resource : resources) {
+ uris.add(resource.getURI().toString());
+ }
+ return StringUtils.collectionToCommaDelimitedString(uris);
+ }
+ catch (IOException e) {
+ return Arrays.toString(resources);
+ }
}
+
@Override
protected void loadConfiguration(Object... configs) {
Resource[] resources = Arrays.copyOfRange(configs, 0, configs.length, Resource[].class);
load(resources);
}
+
}
helper = new ResourceXmlApplicationContextHelper(parent, this, resources);
refresh();
@@ -189,7 +200,8 @@ public ResourceAnnotationApplicationContext(ConfigurableApplicationContext paren
class ResourceAnnotationApplicationContextHelper extends ApplicationContextHelper {
- public ResourceAnnotationApplicationContextHelper(ConfigurableApplicationContext parent, GenericApplicationContext context, Object... config) {
+ public ResourceAnnotationApplicationContextHelper(ConfigurableApplicationContext parent,
+ GenericApplicationContext context, Object... config) {
super(parent, context, config);
}
@@ -207,6 +219,7 @@ protected String generateId(Object... configs) {
return Arrays.toString(configs);
}
}
+
@Override
protected void loadConfiguration(Object... configs) {
if (allObjectsOfType(configs, Class.class)) {
@@ -218,6 +231,7 @@ protected void loadConfiguration(Object... configs) {
scan(pkgs);
}
}
+
}
helper = new ResourceAnnotationApplicationContextHelper(parent, this, resources);
refresh();
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GroupAwareJob.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GroupAwareJob.java
index 88beaea7e0..904573538d 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GroupAwareJob.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/GroupAwareJob.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2018 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -15,22 +15,23 @@
*/
package org.springframework.batch.core.configuration.support;
-import org.springframework.batch.core.Job;
-import org.springframework.batch.core.JobExecution;
-import org.springframework.batch.core.JobParametersIncrementer;
-import org.springframework.batch.core.JobParametersValidator;
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
+
+import org.springframework.batch.core.job.Job;
+import org.springframework.batch.core.job.JobExecution;
+import org.springframework.batch.core.job.JobInterruptedException;
+import org.springframework.batch.core.job.parameters.JobParametersIncrementer;
+import org.springframework.batch.core.job.parameters.JobParametersValidator;
import org.springframework.util.ClassUtils;
/**
- * A {@link Job} that can optionally prepend a group name to another job's name,
- * to make it fit a naming convention for type or origin. E.g. the source job
- * might be overnightJob and the group
- * financeDepartment, which would result in a {@link Job} with
- * identical functionality but named financeDepartment.overnightJob
- * . The use of a "." separator for elements is deliberate, since it is a "safe"
- * character in a URL.
- *
+ * A {@link Job} that can optionally prepend a group name to another job's name, to make
+ * it fit a naming convention for type or origin. For example, the source job might be
+ * overnightJob and the group might be financeDepartment, which
+ * would result in a {@link Job} with identical functionality but named
+ * financeDepartment.overnightJob . The use of a "." separator for elements
+ * is deliberate, since it is a "safe" character in a
+ * URL.
*
* @author Dave Syer
* @author Mahmoud Ben Hassine
@@ -39,8 +40,8 @@
public class GroupAwareJob implements Job {
/**
- * The separator between group and delegate job names in the final name
- * given to this job.
+ * The separator between group and delegate job names in the final name given to this
+ * job.
*/
private static final String SEPARATOR = ".";
@@ -48,41 +49,29 @@ public class GroupAwareJob implements Job {
private final String groupName;
- /**
- * Create a new {@link Job} with the delegate and no group name.
- *
- * @param delegate a delegate for the features of a regular Job
- */
- public GroupAwareJob(Job delegate) {
- this(null, delegate);
- }
-
/**
* Create a new {@link Job} with the given group name and delegate.
- *
* @param groupName the group name to prepend (can be {@code null})
* @param delegate a delegate for the features of a regular Job
*/
- public GroupAwareJob(@Nullable String groupName, Job delegate) {
- super();
+ public GroupAwareJob(String groupName, Job delegate) {
this.groupName = groupName;
this.delegate = delegate;
}
@Override
- public void execute(JobExecution execution) {
+ public void execute(JobExecution execution) throws JobInterruptedException {
delegate.execute(execution);
}
/**
- * Concatenates the group name and the delegate job name (joining with a
- * ".").
+ * Concatenates the group name and the delegate job name (joining with a ".").
*
- * @see org.springframework.batch.core.Job#getName()
+ * @see Job#getName()
*/
@Override
public String getName() {
- return groupName==null ? delegate.getName() : groupName + SEPARATOR + delegate.getName();
+ return groupName + SEPARATOR + delegate.getName();
}
@Override
@@ -91,8 +80,7 @@ public boolean isRestartable() {
}
@Override
- @Nullable
- public JobParametersIncrementer getJobParametersIncrementer() {
+ public @Nullable JobParametersIncrementer getJobParametersIncrementer() {
return delegate.getJobParametersIncrementer();
}
@@ -101,24 +89,14 @@ public JobParametersValidator getJobParametersValidator() {
return delegate.getJobParametersValidator();
}
- /*
- * (non-Javadoc)
- *
- * @see java.lang.Object#equals(java.lang.Object)
- */
@Override
public boolean equals(Object obj) {
- if (obj instanceof GroupAwareJob) {
- return ((GroupAwareJob) obj).delegate.equals(delegate);
+ if (obj instanceof GroupAwareJob groupAwareJob) {
+ return groupAwareJob.delegate.equals(delegate);
}
return false;
}
- /*
- * (non-Javadoc)
- *
- * @see java.lang.Object#hashCode()
- */
@Override
public int hashCode() {
return delegate.hashCode();
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JdbcDefaultBatchConfiguration.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JdbcDefaultBatchConfiguration.java
new file mode 100644
index 0000000000..39ccc6302c
--- /dev/null
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JdbcDefaultBatchConfiguration.java
@@ -0,0 +1,322 @@
+/*
+ * Copyright 2012-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.
+ * 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.core.configuration.support;
+
+import org.springframework.batch.core.configuration.BatchConfigurationException;
+import org.springframework.batch.core.converter.DateToStringConverter;
+import org.springframework.batch.core.converter.LocalDateTimeToStringConverter;
+import org.springframework.batch.core.converter.LocalDateToStringConverter;
+import org.springframework.batch.core.converter.LocalTimeToStringConverter;
+import org.springframework.batch.core.converter.StringToDateConverter;
+import org.springframework.batch.core.converter.StringToLocalDateConverter;
+import org.springframework.batch.core.converter.StringToLocalDateTimeConverter;
+import org.springframework.batch.core.converter.StringToLocalTimeConverter;
+import org.springframework.batch.core.job.DefaultJobKeyGenerator;
+import org.springframework.batch.core.job.JobInstance;
+import org.springframework.batch.core.job.JobKeyGenerator;
+import org.springframework.batch.core.launch.JobOperator;
+import org.springframework.batch.core.repository.ExecutionContextSerializer;
+import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao;
+import org.springframework.batch.core.repository.dao.DefaultExecutionContextSerializer;
+import org.springframework.batch.core.repository.dao.jdbc.JdbcExecutionContextDao;
+import org.springframework.batch.core.repository.dao.jdbc.JdbcJobExecutionDao;
+import org.springframework.batch.core.repository.dao.jdbc.JdbcStepExecutionDao;
+import org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean;
+import org.springframework.batch.infrastructure.item.database.support.DataFieldMaxValueIncrementerFactory;
+import org.springframework.batch.infrastructure.item.database.support.DefaultDataFieldMaxValueIncrementerFactory;
+import org.springframework.batch.infrastructure.support.DatabaseType;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.convert.support.ConfigurableConversionService;
+import org.springframework.core.convert.support.DefaultConversionService;
+import org.springframework.jdbc.core.JdbcOperations;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.jdbc.support.MetaDataAccessException;
+import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer;
+import org.springframework.transaction.PlatformTransactionManager;
+import org.springframework.transaction.annotation.Isolation;
+
+import javax.sql.DataSource;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
+import java.sql.Types;
+
+/**
+ * Base {@link Configuration} class that provides common JDBC-based infrastructure beans
+ * for enabling and using Spring Batch.
+ *
+ * This configuration class configures and registers the following beans in the
+ * application context:
+ *
+ *
+ *
+ *
+ * Customization is possible by extending the class and overriding getters.
+ *
+ * A typical usage of this class is as follows:
+ * @Configuration
+ * public class MyJobConfiguration extends JdbcDefaultBatchConfiguration {
+ *
+ * @Bean
+ * public Job job(JobRepository jobRepository) {
+ * return new JobBuilder("myJob", jobRepository)
+ * // define job flow as needed
+ * .build();
+ * }
+ *
+ * }
+ *
+ *
+ * @author Mahmoud Ben Hassine
+ * @author Yanming Zhou
+ * @since 6.0
+ */
+@Configuration(proxyBeanMethods = false)
+public class JdbcDefaultBatchConfiguration extends DefaultBatchConfiguration {
+
+ @Bean
+ @Override
+ public JobRepository jobRepository() throws BatchConfigurationException {
+ JdbcJobRepositoryFactoryBean jobRepositoryFactoryBean = new JdbcJobRepositoryFactoryBean();
+ try {
+ jobRepositoryFactoryBean.setDataSource(getDataSource());
+ jobRepositoryFactoryBean.setTransactionManager(getTransactionManager());
+ jobRepositoryFactoryBean.setDatabaseType(getDatabaseType());
+ jobRepositoryFactoryBean.setIncrementerFactory(getIncrementerFactory());
+ jobRepositoryFactoryBean.setJobKeyGenerator(getJobKeyGenerator());
+ jobRepositoryFactoryBean.setClobType(getClobType());
+ jobRepositoryFactoryBean.setTablePrefix(getTablePrefix());
+ jobRepositoryFactoryBean.setJobInstanceIncrementerName(getJobInstanceIncrementerName());
+ jobRepositoryFactoryBean.setJobExecutionIncrementerName(getJobExecutionIncrementerName());
+ jobRepositoryFactoryBean.setStepExecutionIncrementerName(getStepExecutionIncrementerName());
+ jobRepositoryFactoryBean.setSerializer(getExecutionContextSerializer());
+ jobRepositoryFactoryBean.setConversionService(getConversionService());
+ jobRepositoryFactoryBean.setJdbcOperations(getJdbcOperations());
+ jobRepositoryFactoryBean.setCharset(getCharset());
+ jobRepositoryFactoryBean.setMaxVarCharLength(getMaxVarCharLength());
+ jobRepositoryFactoryBean.setIsolationLevelForCreateEnum(getIsolationLevelForCreate());
+ jobRepositoryFactoryBean.setValidateTransactionState(getValidateTransactionState());
+ jobRepositoryFactoryBean.afterPropertiesSet();
+ return jobRepositoryFactoryBean.getObject();
+ }
+ catch (Exception e) {
+ throw new BatchConfigurationException("Unable to configure the default job repository", e);
+ }
+ }
+
+ /*
+ * Getters to customize the configuration of infrastructure beans
+ */
+
+ /**
+ * Return the data source to use for Batch meta-data. Defaults to the bean of type
+ * {@link DataSource} and named "dataSource" in the application context.
+ * @return The data source to use for Batch meta-data
+ */
+ protected DataSource getDataSource() {
+ String errorMessage = " To use the default configuration, a data source bean named 'dataSource'"
+ + " should be defined in the application context but none was found. Override getDataSource()"
+ + " to provide the data source to use for Batch meta-data.";
+ if (this.applicationContext.getBeansOfType(DataSource.class).isEmpty()) {
+ throw new BatchConfigurationException(
+ "Unable to find a DataSource bean in the application context." + errorMessage);
+ }
+ else {
+ if (!this.applicationContext.containsBean("dataSource")) {
+ throw new BatchConfigurationException(errorMessage);
+ }
+ }
+ return this.applicationContext.getBean("dataSource", DataSource.class);
+ }
+
+ @Override
+ protected PlatformTransactionManager getTransactionManager() {
+ String errorMessage = " To use the default configuration, a PlatformTransactionManager bean named 'transactionManager'"
+ + " should be defined in the application context but none was found. Override getTransactionManager()"
+ + " to provide the transaction manager to use for the job repository.";
+ if (this.applicationContext.getBeansOfType(PlatformTransactionManager.class).isEmpty()) {
+ throw new BatchConfigurationException(
+ "Unable to find a PlatformTransactionManager bean in the application context." + errorMessage);
+ }
+ else {
+ if (!this.applicationContext.containsBean("transactionManager")) {
+ throw new BatchConfigurationException(errorMessage);
+ }
+ }
+ return this.applicationContext.getBean("transactionManager", PlatformTransactionManager.class);
+ }
+
+ /**
+ * Return the length of long string columns in database. Do not override this if you
+ * haven't modified the schema. Note this value will be used for the exit message in
+ * both {@link JdbcJobExecutionDao} and {@link JdbcStepExecutionDao} and also the
+ * short version of the execution context in {@link JdbcExecutionContextDao} . For
+ * databases with multi-byte character sets this number can be smaller (by up to a
+ * factor of 2 for 2-byte characters) than the declaration of the column length in the
+ * DDL for the tables. Defaults to
+ * {@link AbstractJdbcBatchMetadataDao#DEFAULT_EXIT_MESSAGE_LENGTH}
+ */
+ protected int getMaxVarCharLength() {
+ return AbstractJdbcBatchMetadataDao.DEFAULT_EXIT_MESSAGE_LENGTH;
+ }
+
+ /**
+ * Return the prefix of Batch meta-data tables. Defaults to
+ * {@link AbstractJdbcBatchMetadataDao#DEFAULT_TABLE_PREFIX}.
+ * @return the prefix of meta-data tables
+ */
+ protected String getTablePrefix() {
+ return AbstractJdbcBatchMetadataDao.DEFAULT_TABLE_PREFIX;
+ }
+
+ /**
+ * Return the job instance incrementer name. Defaults to
+ * {@link AbstractJdbcBatchMetadataDao#DEFAULT_JOB_INSTANCE_INCREMENTER_NAME}.
+ * @return job instance incrementer name
+ */
+ protected String getJobInstanceIncrementerName() {
+ return AbstractJdbcBatchMetadataDao.DEFAULT_JOB_INSTANCE_INCREMENTER_NAME;
+ }
+
+ /**
+ * Return the job execution incrementer name. Defaults to
+ * {@link AbstractJdbcBatchMetadataDao#DEFAULT_JOB_EXECUTION_INCREMENTER_NAME}.
+ * @return job execution incrementer name
+ */
+ protected String getJobExecutionIncrementerName() {
+ return AbstractJdbcBatchMetadataDao.DEFAULT_JOB_EXECUTION_INCREMENTER_NAME;
+ }
+
+ /**
+ * Return the step execution incrementer name. Defaults to
+ * {@link AbstractJdbcBatchMetadataDao#DEFAULT_STEP_EXECUTION_INCREMENTER_NAME}.
+ * @return step execution incrementer name
+ */
+ protected String getStepExecutionIncrementerName() {
+ return AbstractJdbcBatchMetadataDao.DEFAULT_STEP_EXECUTION_INCREMENTER_NAME;
+ }
+
+ /**
+ * Return the {@link Charset} to use when serializing/deserializing the execution
+ * context. Defaults to "UTF-8".
+ * @return the charset to use when serializing/deserializing the execution context
+ */
+ protected Charset getCharset() {
+ return StandardCharsets.UTF_8;
+ }
+
+ /**
+ * Return the {@link JdbcOperations}. If this property is not overridden, a new
+ * {@link JdbcTemplate} will be created for the configured data source by default.
+ * @return the {@link JdbcOperations} to use
+ */
+ protected JdbcOperations getJdbcOperations() {
+ return new JdbcTemplate(getDataSource());
+ }
+
+ /**
+ * A custom implementation of the {@link ExecutionContextSerializer}. The default, if
+ * not injected, is the {@link DefaultExecutionContextSerializer}.
+ * @return the serializer to use to serialize/deserialize the execution context
+ */
+ protected ExecutionContextSerializer getExecutionContextSerializer() {
+ return new DefaultExecutionContextSerializer();
+ }
+
+ /**
+ * Return the value from {@link Types} class to indicate the type to use for a CLOB
+ * @return the value from {@link Types} class to indicate the type to use for a CLOB
+ */
+ protected int getClobType() {
+ return Types.CLOB;
+ }
+
+ /**
+ * Return the factory for creating {@link DataFieldMaxValueIncrementer}
+ * implementations used to increment entity IDs in meta-data tables.
+ * @return the factory for creating {@link DataFieldMaxValueIncrementer}
+ * implementations.
+ */
+ protected DataFieldMaxValueIncrementerFactory getIncrementerFactory() {
+ return new DefaultDataFieldMaxValueIncrementerFactory(getDataSource());
+ }
+
+ /**
+ * Return the database type. The default will be introspected from the JDBC meta-data
+ * of the data source.
+ * @return the database type
+ * @throws MetaDataAccessException if an error occurs when trying to get the database
+ * type of JDBC meta-data
+ *
+ */
+ protected String getDatabaseType() throws MetaDataAccessException {
+ return DatabaseType.fromMetaData(getDataSource()).name();
+ }
+
+ /**
+ * Return the conversion service to use in the job repository and job explorer. This
+ * service is used to convert job parameters from String literal to typed values and
+ * vice versa.
+ * @return the {@link ConfigurableConversionService} to use.
+ */
+ protected ConfigurableConversionService getConversionService() {
+ DefaultConversionService conversionService = new DefaultConversionService();
+ conversionService.addConverter(new DateToStringConverter());
+ conversionService.addConverter(new StringToDateConverter());
+ conversionService.addConverter(new LocalDateToStringConverter());
+ conversionService.addConverter(new StringToLocalDateConverter());
+ conversionService.addConverter(new LocalTimeToStringConverter());
+ conversionService.addConverter(new StringToLocalTimeConverter());
+ conversionService.addConverter(new LocalDateTimeToStringConverter());
+ conversionService.addConverter(new StringToLocalDateTimeConverter());
+ return conversionService;
+ }
+
+ /**
+ * Return the value of the {@code validateTransactionState} parameter. Defaults to
+ * {@code true}.
+ * @return true if the transaction state should be validated, false otherwise
+ */
+ protected boolean getValidateTransactionState() {
+ return true;
+ }
+
+ /**
+ * Return the transaction isolation level when creating job executions. Defaults to
+ * {@link Isolation#SERIALIZABLE}.
+ * @return the transaction isolation level when creating job executions
+ */
+ protected Isolation getIsolationLevelForCreate() {
+ return Isolation.SERIALIZABLE;
+ }
+
+ /**
+ * A custom implementation of the {@link JobKeyGenerator}. The default, if not
+ * injected, is the {@link DefaultJobKeyGenerator}.
+ * @return the generator that creates the key used in identifying {@link JobInstance}
+ * objects
+ * @since 5.1
+ */
+ protected JobKeyGenerator getJobKeyGenerator() {
+ return new DefaultJobKeyGenerator();
+ }
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobFactoryRegistrationListener.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobFactoryRegistrationListener.java
index 1521a15afd..3ca71a6fb5 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobFactoryRegistrationListener.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobFactoryRegistrationListener.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2007 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -20,26 +20,28 @@
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.NullUnmarked;
+
import org.springframework.batch.core.configuration.JobFactory;
import org.springframework.batch.core.configuration.JobRegistry;
/**
- * Generic service that can bind and unbind a {@link JobFactory} in a
- * {@link JobRegistry}.
- *
+ * Generic service that can bind and unbind a {@link JobFactory} in a {@link JobRegistry}.
+ *
* @author Dave Syer
- *
+ * @author Mahmoud Ben Hassine
+ * @deprecated since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
*/
+@NullUnmarked
+@Deprecated(since = "6.0", forRemoval = true)
public class JobFactoryRegistrationListener {
- private Log logger = LogFactory.getLog(getClass());
+ private final Log logger = LogFactory.getLog(getClass());
private JobRegistry jobRegistry;
/**
- * Public setter for a {@link JobRegistry} to use for all the bind and
- * unbind events.
- *
+ * Public setter for a {@link JobRegistry} to use for all the bind and unbind events.
* @param jobRegistry {@link JobRegistry}
*/
public void setJobRegistry(JobRegistry jobRegistry) {
@@ -47,26 +49,29 @@ public void setJobRegistry(JobRegistry jobRegistry) {
}
/**
- * Take the {@link JobFactory} provided and register it with the
- * {@link JobRegistry}.
+ * Take the {@link JobFactory} provided and register it with the {@link JobRegistry}.
* @param jobFactory a {@link JobFactory}
* @param params not needed by this listener.
* @throws Exception if there is a problem
*/
public void bind(JobFactory jobFactory, Map params) throws Exception {
- logger.info("Binding JobFactory: " + jobFactory.getJobName());
- jobRegistry.register(jobFactory);
+ if (logger.isInfoEnabled()) {
+ logger.info("Binding JobFactory: " + jobFactory.getJobName());
+ }
+ jobRegistry.register(jobFactory.createJob());
}
/**
- * Take the {@link JobFactory} provided and unregister it with the
+ * Take the provided {@link JobFactory} and unregister it with the
* {@link JobRegistry}.
* @param jobFactory a {@link JobFactory}
* @param params not needed by this listener.
* @throws Exception if there is a problem
*/
public void unbind(JobFactory jobFactory, Map params) throws Exception {
- logger.info("Unbinding JobFactory: " + jobFactory.getJobName());
+ if (logger.isInfoEnabled()) {
+ logger.info("Unbinding JobFactory: " + jobFactory.getJobName());
+ }
jobRegistry.unregister(jobFactory.getJobName());
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobLoader.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobLoader.java
index 7352ed7027..879f0e768e 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobLoader.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobLoader.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2009-2013 the original author or authors.
+ * Copyright 2009-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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -17,41 +17,41 @@
import java.util.Collection;
-import org.springframework.batch.core.Job;
+import org.jspecify.annotations.NullUnmarked;
+
+import org.springframework.batch.core.job.Job;
import org.springframework.batch.core.configuration.DuplicateJobException;
/**
* @author Dave Syer
- *
+ * @author Mahmoud Ben Hassine
* @since 2.1
+ * @deprecated since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
*/
+@NullUnmarked
+@Deprecated(since = "6.0", forRemoval = true)
public interface JobLoader {
/**
* Load an application context and register all the jobs.
- *
* @param factory a factory for an application context (containing jobs)
* @return a collection of the jobs created
- *
- * @throws DuplicateJobException if a job with the same name was already
- * registered
+ * @throws DuplicateJobException if a job with the same name was already registered
*/
Collection load(ApplicationContextFactory factory) throws DuplicateJobException;
/**
- * Load an application context and register all the jobs, having first
- * unregistered them if already registered. Implementations should also take
- * care to close and clean up the application context previously created if
- * possible (either from this factory or from one with the same jobs).
- *
+ * Load an application context and register all the jobs, having first unregistered
+ * them if already registered. Implementations should also close and clean up the
+ * application context previously created (either from this factory or from one with
+ * the same jobs), if possible.
* @param factory a factory for an application context (containing jobs)
* @return a collection of the jobs created
*/
Collection reload(ApplicationContextFactory factory);
/**
- * Unregister all the jobs and close all the contexts created by this
- * loader.
+ * Unregister all the jobs and close all the contexts created by this loader.
*/
void clear();
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobRegistryBeanPostProcessor.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobRegistryBeanPostProcessor.java
deleted file mode 100644
index 3f54661b65..0000000000
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobRegistryBeanPostProcessor.java
+++ /dev/null
@@ -1,180 +0,0 @@
-/*
- * Copyright 2006-2013 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
- *
- * http://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.core.configuration.support;
-
-import java.util.Collection;
-import java.util.HashSet;
-
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-import org.springframework.batch.core.Job;
-import org.springframework.batch.core.configuration.DuplicateJobException;
-import org.springframework.batch.core.configuration.JobLocator;
-import org.springframework.batch.core.configuration.JobRegistry;
-import org.springframework.beans.BeansException;
-import org.springframework.beans.FatalBeanException;
-import org.springframework.beans.factory.BeanFactory;
-import org.springframework.beans.factory.BeanFactoryAware;
-import org.springframework.beans.factory.DisposableBean;
-import org.springframework.beans.factory.InitializingBean;
-import org.springframework.beans.factory.config.BeanDefinition;
-import org.springframework.beans.factory.config.BeanPostProcessor;
-import org.springframework.beans.factory.support.DefaultListableBeanFactory;
-import org.springframework.util.Assert;
-
-/**
- * A {@link BeanPostProcessor} that registers {@link Job} beans with a
- * {@link JobRegistry}. Include a bean of this type along with your job
- * configuration, and use the same {@link JobRegistry} as a {@link JobLocator}
- * when you need to locate a {@link Job} to launch.
- *
- * @author Dave Syer
- *
- */
-public class JobRegistryBeanPostProcessor implements BeanPostProcessor, BeanFactoryAware, InitializingBean,
-DisposableBean {
-
- private static Log logger = LogFactory.getLog(JobRegistryBeanPostProcessor.class);
-
- // It doesn't make sense for this to have a default value...
- private JobRegistry jobRegistry = null;
-
- private Collection jobNames = new HashSet<>();
-
- private String groupName = null;
-
- private DefaultListableBeanFactory beanFactory;
-
- /**
- * The group name for jobs registered by this component. Optional (defaults
- * to null, which means that jobs are registered with their bean names).
- * Useful where there is a hierarchy of application contexts all
- * contributing to the same {@link JobRegistry}: child contexts can then
- * define an instance with a unique group name to avoid clashes between job
- * names.
- *
- * @param groupName the groupName to set
- */
- public void setGroupName(String groupName) {
- this.groupName = groupName;
- }
-
- /**
- * Injection setter for {@link JobRegistry}.
- *
- * @param jobRegistry the jobConfigurationRegistry to set
- */
- public void setJobRegistry(JobRegistry jobRegistry) {
- this.jobRegistry = jobRegistry;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see
- * org.springframework.beans.factory.BeanFactoryAware#setBeanFactory(org
- * .springframework.beans.factory.BeanFactory)
- */
- @Override
- public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
- if (beanFactory instanceof DefaultListableBeanFactory) {
- this.beanFactory = (DefaultListableBeanFactory) beanFactory;
- }
- }
-
- /**
- * Make sure the registry is set before use.
- *
- * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
- */
- @Override
- public void afterPropertiesSet() throws Exception {
- Assert.notNull(jobRegistry, "JobRegistry must not be null");
- }
-
- /**
- * Unregister all the {@link Job} instances that were registered by this
- * post processor.
- * @see org.springframework.beans.factory.DisposableBean#destroy()
- */
- @Override
- public void destroy() throws Exception {
- for (String name : jobNames) {
- if (logger.isDebugEnabled()) {
- logger.debug("Unregistering job: " + name);
- }
- jobRegistry.unregister(name);
- }
- jobNames.clear();
- }
-
- /**
- * If the bean is an instance of {@link Job} then register it.
- * @throws FatalBeanException if there is a {@link DuplicateJobException}.
- *
- * @see org.springframework.beans.factory.config.BeanPostProcessor#postProcessAfterInitialization(java.lang.Object,
- * java.lang.String)
- */
- @Override
- public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
- if (bean instanceof Job) {
- Job job = (Job) bean;
- try {
- String groupName = this.groupName;
- if (beanFactory != null && beanFactory.containsBean(beanName)) {
- groupName = getGroupName(beanFactory.getBeanDefinition(beanName), job);
- }
- job = groupName==null ? job : new GroupAwareJob(groupName, job);
- ReferenceJobFactory jobFactory = new ReferenceJobFactory(job);
- String name = jobFactory.getJobName();
- if (logger.isDebugEnabled()) {
- logger.debug("Registering job: " + name);
- }
- jobRegistry.register(jobFactory);
- jobNames.add(name);
- }
- catch (DuplicateJobException e) {
- throw new FatalBeanException("Cannot register job configuration", e);
- }
- return job;
- }
- return bean;
- }
-
- /**
- * Determine a group name for the job to be registered. Default
- * implementation just returns the {@link #setGroupName(String) groupName}
- * configured. Provides an extension point for specialised subclasses.
- *
- * @param beanDefinition the bean definition for the job
- * @param job the job
- * @return a group name for the job (or null if not needed)
- */
- protected String getGroupName(BeanDefinition beanDefinition, Job job) {
- return groupName;
- }
-
- /**
- * Do nothing.
- *
- * @see org.springframework.beans.factory.config.BeanPostProcessor#postProcessBeforeInitialization(java.lang.Object,
- * java.lang.String)
- */
- @Override
- public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
- return bean;
- }
-}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobRegistrySmartInitializingSingleton.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobRegistrySmartInitializingSingleton.java
new file mode 100644
index 0000000000..195f071cea
--- /dev/null
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobRegistrySmartInitializingSingleton.java
@@ -0,0 +1,176 @@
+/*
+ * Copyright 2024-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.
+ * 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.core.configuration.support;
+
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Map;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.NullUnmarked;
+
+import org.springframework.batch.core.job.Job;
+import org.springframework.batch.core.configuration.DuplicateJobException;
+import org.springframework.batch.core.configuration.JobLocator;
+import org.springframework.batch.core.configuration.JobRegistry;
+import org.springframework.beans.BeansException;
+import org.springframework.beans.FatalBeanException;
+import org.springframework.beans.factory.BeanFactory;
+import org.springframework.beans.factory.BeanFactoryAware;
+import org.springframework.beans.factory.DisposableBean;
+import org.springframework.beans.factory.InitializingBean;
+import org.springframework.beans.factory.ListableBeanFactory;
+import org.springframework.beans.factory.SmartInitializingSingleton;
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.support.DefaultListableBeanFactory;
+import org.springframework.util.Assert;
+
+/**
+ * A {@link SmartInitializingSingleton} that registers {@link Job} beans with a
+ * {@link JobRegistry}. Include a bean of this type along with your job configuration and
+ * use the same {@link JobRegistry} as a {@link JobLocator} when you need to locate a
+ * {@link Job} to launch.
+ *
+ * @author Henning Pöttker
+ * @since 5.1.1
+ * @deprecated since 6.0 with no replacement. Register a {@link MapJobRegistry} as a bean,
+ * and it will automatically register all {@link Job} beans in the application context.
+ */
+@NullUnmarked
+@Deprecated(since = "6.0", forRemoval = true)
+public class JobRegistrySmartInitializingSingleton
+ implements SmartInitializingSingleton, BeanFactoryAware, InitializingBean, DisposableBean {
+
+ private static final Log logger = LogFactory.getLog(JobRegistrySmartInitializingSingleton.class);
+
+ // It doesn't make sense for this to have a default value...
+ private JobRegistry jobRegistry = null;
+
+ private final Collection jobNames = new HashSet<>();
+
+ private String groupName = null;
+
+ private ListableBeanFactory beanFactory;
+
+ /**
+ * Default constructor.
+ */
+ public JobRegistrySmartInitializingSingleton() {
+ }
+
+ /**
+ * Convenience constructor for setting the {@link JobRegistry}.
+ * @param jobRegistry the {@link JobRegistry} to register the {@link Job}s with
+ */
+ public JobRegistrySmartInitializingSingleton(JobRegistry jobRegistry) {
+ this.jobRegistry = jobRegistry;
+ }
+
+ /**
+ * The group name for jobs registered by this component. Optional (defaults to null,
+ * which means that jobs are registered with their bean names). Useful where there is
+ * a hierarchy of application contexts all contributing to the same
+ * {@link JobRegistry}: child contexts can then define an instance with a unique group
+ * name to avoid clashes between job names.
+ * @param groupName the groupName to set
+ */
+ public void setGroupName(String groupName) {
+ this.groupName = groupName;
+ }
+
+ /**
+ * Injection setter for {@link JobRegistry}.
+ * @param jobRegistry the {@link JobRegistry} to register the {@link Job}s with
+ */
+ public void setJobRegistry(JobRegistry jobRegistry) {
+ this.jobRegistry = jobRegistry;
+ }
+
+ @Override
+ public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
+ if (beanFactory instanceof ListableBeanFactory listableBeanFactory) {
+ this.beanFactory = listableBeanFactory;
+ }
+ }
+
+ /**
+ * Make sure the registry is set before use.
+ */
+ @Override
+ public void afterPropertiesSet() throws Exception {
+ Assert.state(jobRegistry != null, "JobRegistry must not be null");
+ }
+
+ /**
+ * Unregister all the {@link Job} instances that were registered by this smart
+ * initializing singleton.
+ */
+ @Override
+ public void destroy() throws Exception {
+ for (String name : jobNames) {
+ if (logger.isDebugEnabled()) {
+ logger.debug("Unregistering job: " + name);
+ }
+ jobRegistry.unregister(name);
+ }
+ jobNames.clear();
+ }
+
+ @Override
+ public void afterSingletonsInstantiated() {
+ if (beanFactory == null) {
+ return;
+ }
+ Map jobs = beanFactory.getBeansOfType(Job.class, false, false);
+ for (var entry : jobs.entrySet()) {
+ postProcessAfterInitialization(entry.getValue(), entry.getKey());
+ }
+ }
+
+ private void postProcessAfterInitialization(Job job, String beanName) {
+ try {
+ String groupName = this.groupName;
+ if (beanFactory instanceof DefaultListableBeanFactory defaultListableBeanFactory
+ && beanFactory.containsBean(beanName)) {
+ groupName = getGroupName(defaultListableBeanFactory.getBeanDefinition(beanName), job);
+ }
+ job = groupName == null ? job : new GroupAwareJob(groupName, job);
+ String name = job.getName();
+ if (logger.isDebugEnabled()) {
+ logger.debug("Registering job: " + name);
+ }
+ jobRegistry.register(job);
+ jobNames.add(name);
+ }
+ catch (DuplicateJobException e) {
+ throw new FatalBeanException("Cannot register job configuration", e);
+ }
+ }
+
+ /**
+ * Determine a group name for the job to be registered. The default implementation
+ * returns the {@link #setGroupName(String) groupName} configured. Provides an
+ * extension point for specialised subclasses.
+ * @param beanDefinition the bean definition for the job
+ * @param job the job
+ * @return a group name for the job (or null if not needed)
+ */
+ protected String getGroupName(BeanDefinition beanDefinition, Job job) {
+ return groupName;
+ }
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapJobRegistry.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapJobRegistry.java
index ca12a89daf..2975701db1 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapJobRegistry.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapJobRegistry.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2018 the original author or authors.
+ * Copyright 2006-present 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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -16,66 +16,92 @@
package org.springframework.batch.core.configuration.support;
import java.util.Collections;
+import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
-import org.springframework.batch.core.Job;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
+
+import org.springframework.batch.core.job.Job;
import org.springframework.batch.core.configuration.DuplicateJobException;
-import org.springframework.batch.core.configuration.JobFactory;
import org.springframework.batch.core.configuration.JobRegistry;
-import org.springframework.batch.core.launch.NoSuchJobException;
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.SmartInitializingSingleton;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
import org.springframework.util.Assert;
/**
- * Simple, thread-safe, map-based implementation of {@link JobRegistry}.
+ * Simple, thread-safe, map-based implementation of {@link JobRegistry}. This registry is
+ * a {@link SmartInitializingSingleton} that is automatically populated with all
+ * {@link Job} beans in the {@link ApplicationContext}.
*
* @author Dave Syer
* @author Robert Fischer
* @author Mahmoud Ben Hassine
*/
-public class MapJobRegistry implements JobRegistry {
+public class MapJobRegistry implements JobRegistry, SmartInitializingSingleton, ApplicationContextAware {
+
+ protected final Log logger = LogFactory.getLog(getClass());
/**
- * The map holding the registered job factories.
+ * The map holding the registered jobs.
*/
- // The "final" ensures that it is visible and initialized when the constructor resolves.
- private final ConcurrentMap map = new ConcurrentHashMap<>();
+ private final ConcurrentMap map = new ConcurrentHashMap<>();
+
+ @SuppressWarnings("NullAway.Init")
+ private ApplicationContext applicationContext;
+
+ @Override
+ public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
+ this.applicationContext = applicationContext;
+ }
@Override
- public void register(JobFactory jobFactory) throws DuplicateJobException {
- Assert.notNull(jobFactory, "jobFactory is null");
- String name = jobFactory.getJobName();
- Assert.notNull(name, "Job configuration must have a name.");
- JobFactory previousValue = map.putIfAbsent(name, jobFactory);
+ public void afterSingletonsInstantiated() {
+ Map jobBeans = this.applicationContext.getBeansOfType(Job.class);
+ for (Job job : jobBeans.values()) {
+ try {
+ register(job);
+ }
+ catch (DuplicateJobException e) {
+ throw new IllegalStateException("Unable to register job " + job.getName(), e);
+ }
+ }
+ }
+
+ @Override
+ public void register(Job job) throws DuplicateJobException {
+ Assert.notNull(job, "job must not be null");
+ String jobName = job.getName();
+ Assert.notNull(jobName, "Job name must not be null");
+ Job previousValue = this.map.putIfAbsent(jobName, job);
if (previousValue != null) {
- throw new DuplicateJobException("A job configuration with this name [" + name
- + "] was already registered");
+ throw new DuplicateJobException("A job with this name [" + jobName + "] was already registered");
}
}
@Override
public void unregister(String name) {
- Assert.notNull(name, "Job configuration must have a name.");
- map.remove(name);
+ Assert.notNull(name, "Job name must not be null");
+ this.map.remove(name);
}
+ @Nullable
@Override
- public Job getJob(String name) throws NoSuchJobException {
- JobFactory factory = map.get(name);
- if (factory == null) {
- throw new NoSuchJobException("No job configuration with the name [" + name + "] was registered");
- } else {
- return factory.createJob();
- }
+ public Job getJob(String name) {
+ return this.map.get(name);
}
/**
- * Provides an unmodifiable view of the job names.
+ * Provides an unmodifiable view of job names.
*/
@Override
public Set getJobNames() {
- return Collections.unmodifiableSet(map.keySet());
+ return Collections.unmodifiableSet(this.map.keySet());
}
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapStepRegistry.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapStepRegistry.java
index 724c861c50..f09219dda4 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapStepRegistry.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapStepRegistry.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -21,20 +21,22 @@
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
-import org.springframework.batch.core.Step;
+import org.springframework.batch.core.step.Step;
+
+import org.jspecify.annotations.Nullable;
import org.springframework.batch.core.configuration.DuplicateJobException;
import org.springframework.batch.core.configuration.StepRegistry;
-import org.springframework.batch.core.launch.NoSuchJobException;
-import org.springframework.batch.core.step.NoSuchStepException;
import org.springframework.util.Assert;
/**
* Simple map-based implementation of {@link StepRegistry}. Access to the map is
- * synchronized, guarded by an internal lock.
+ * synchronized and guarded by an internal lock.
*
* @author Sebastien Gerard
* @author Stephane Nicoll
+ * @deprecated as of 6.0 with no replacement. Scheduled for removal in 6.2.
*/
+@Deprecated(since = "6.0", forRemoval = true)
public class MapStepRegistry implements StepRegistry {
private final ConcurrentMap> map = new ConcurrentHashMap<>();
@@ -44,15 +46,14 @@ public void register(String jobName, Collection steps) throws DuplicateJob
Assert.notNull(jobName, "The job name cannot be null.");
Assert.notNull(steps, "The job steps cannot be null.");
-
final Map jobSteps = new HashMap<>();
for (Step step : steps) {
jobSteps.put(step.getName(), step);
}
final Object previousValue = map.putIfAbsent(jobName, jobSteps);
if (previousValue != null) {
- throw new DuplicateJobException("A job configuration with this name [" + jobName
- + "] was already registered");
+ throw new DuplicateJobException(
+ "A job configuration with this name [" + jobName + "] was already registered");
}
}
@@ -63,18 +64,19 @@ public void unregisterStepsFromJob(String jobName) {
}
@Override
- public Step getStep(String jobName, String stepName) throws NoSuchJobException {
+ @Nullable public Step getStep(String jobName, String stepName) {
Assert.notNull(jobName, "The job name cannot be null.");
Assert.notNull(stepName, "The step name cannot be null.");
if (!map.containsKey(jobName)) {
- throw new NoSuchJobException("No job configuration with the name [" + jobName + "] was registered");
- } else {
+ return null;
+ }
+ else {
final Map jobSteps = map.get(jobName);
if (jobSteps.containsKey(stepName)) {
return jobSteps.get(stepName);
- } else {
- throw new NoSuchStepException("The step called [" + stepName + "] does not exist in the job [" +
- jobName + "]");
+ }
+ else {
+ return null;
}
}
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MongoDefaultBatchConfiguration.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MongoDefaultBatchConfiguration.java
new file mode 100644
index 0000000000..1f28cd73eb
--- /dev/null
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MongoDefaultBatchConfiguration.java
@@ -0,0 +1,183 @@
+/*
+ * Copyright 2012-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.
+ * 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.core.configuration.support;
+
+import org.springframework.batch.core.configuration.BatchConfigurationException;
+import org.springframework.batch.core.job.DefaultJobKeyGenerator;
+import org.springframework.batch.core.job.JobInstance;
+import org.springframework.batch.core.job.JobKeyGenerator;
+import org.springframework.batch.core.launch.JobOperator;
+import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.batch.core.repository.dao.mongodb.MongoSequenceIncrementer;
+import org.springframework.batch.core.repository.support.MongoJobRepositoryFactoryBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.mongodb.MongoTransactionManager;
+import org.springframework.data.mongodb.core.MongoOperations;
+import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer;
+import org.springframework.transaction.annotation.Isolation;
+
+/**
+ * Base {@link Configuration} class that provides common MongoDB-based infrastructure
+ * beans for enabling and using Spring Batch.
+ *
+ * This configuration class configures and registers the following beans in the
+ * application context:
+ *
+ *
+ *
+ *
+ * Customization is possible by extending the class and overriding getters.
+ *
+ * A typical usage of this class is as follows:
+ * @Configuration
+ * public class MyJobConfiguration extends MongoDefaultBatchConfiguration {
+ *
+ * @Bean
+ * public Job job(JobRepository jobRepository) {
+ * return new JobBuilder("myJob", jobRepository)
+ * // define job flow as needed
+ * .build();
+ * }
+ *
+ * }
+ *
+ *
+ * @author Mahmoud Ben Hassine
+ * @since 6.0
+ */
+@Configuration(proxyBeanMethods = false)
+public class MongoDefaultBatchConfiguration extends DefaultBatchConfiguration {
+
+ @Bean
+ @Override
+ public JobRepository jobRepository() throws BatchConfigurationException {
+ MongoJobRepositoryFactoryBean jobRepositoryFactoryBean = new MongoJobRepositoryFactoryBean();
+ try {
+ jobRepositoryFactoryBean.setMongoOperations(getMongoOperations());
+ jobRepositoryFactoryBean.setTransactionManager(getTransactionManager());
+ jobRepositoryFactoryBean.setIsolationLevelForCreateEnum(getIsolationLevelForCreate());
+ jobRepositoryFactoryBean.setValidateTransactionState(getValidateTransactionState());
+ jobRepositoryFactoryBean.setJobKeyGenerator(getJobKeyGenerator());
+ jobRepositoryFactoryBean.setJobInstanceIncrementer(getJobInstanceIncrementer());
+ jobRepositoryFactoryBean.setJobExecutionIncrementer(getJobExecutionIncrementer());
+ jobRepositoryFactoryBean.setStepExecutionIncrementer(getStepExecutionIncrementer());
+ jobRepositoryFactoryBean.afterPropertiesSet();
+ return jobRepositoryFactoryBean.getObject();
+ }
+ catch (Exception e) {
+ throw new BatchConfigurationException("Unable to configure the default job repository", e);
+ }
+ }
+
+ /*
+ * Getters to customize the configuration of infrastructure beans
+ */
+
+ protected MongoOperations getMongoOperations() {
+ String errorMessage = " To use the default configuration, a MongoOperations bean named 'mongoTemplate'"
+ + " should be defined in the application context but none was found. Override getMongoOperations()"
+ + " to provide the MongoOperations for Batch meta-data.";
+ if (this.applicationContext.getBeansOfType(MongoOperations.class).isEmpty()) {
+ throw new BatchConfigurationException(
+ "Unable to find a MongoOperations bean in the application context." + errorMessage);
+ }
+ else {
+ if (!this.applicationContext.containsBean("mongoTemplate")) {
+ throw new BatchConfigurationException(errorMessage);
+ }
+ }
+ return this.applicationContext.getBean("mongoTemplate", MongoOperations.class);
+ }
+
+ @Override
+ protected MongoTransactionManager getTransactionManager() {
+ String errorMessage = " To use the default configuration, a MongoTransactionManager bean named 'transactionManager'"
+ + " should be defined in the application context but none was found. Override getTransactionManager()"
+ + " to provide the transaction manager to use for the job repository.";
+ if (this.applicationContext.getBeansOfType(MongoTransactionManager.class).isEmpty()) {
+ throw new BatchConfigurationException(
+ "Unable to find a MongoTransactionManager bean in the application context." + errorMessage);
+ }
+ else {
+ if (!this.applicationContext.containsBean("transactionManager")) {
+ throw new BatchConfigurationException(errorMessage);
+ }
+ }
+ return this.applicationContext.getBean("transactionManager", MongoTransactionManager.class);
+ }
+
+ /**
+ * Return the value of the {@code validateTransactionState} parameter. Defaults to
+ * {@code true}.
+ * @return true if the transaction state should be validated, false otherwise
+ */
+ protected boolean getValidateTransactionState() {
+ return true;
+ }
+
+ /**
+ * Return the transaction isolation level when creating job executions. Defaults to
+ * {@link Isolation#SERIALIZABLE}.
+ * @return the transaction isolation level when creating job executions
+ */
+ protected Isolation getIsolationLevelForCreate() {
+ return Isolation.SERIALIZABLE;
+ }
+
+ /**
+ * A custom implementation of the {@link JobKeyGenerator}. The default, if not
+ * injected, is the {@link DefaultJobKeyGenerator}.
+ * @return the generator that creates the key used in identifying {@link JobInstance}
+ * objects
+ * @since 5.1
+ */
+ protected JobKeyGenerator getJobKeyGenerator() {
+ return new DefaultJobKeyGenerator();
+ }
+
+ /**
+ * Return the incrementer to be used to generate ids for new job instances.
+ * @return the incrementer to be used to generate ids for new job instances
+ * @since 6.0
+ */
+ protected DataFieldMaxValueIncrementer getJobInstanceIncrementer() {
+ return new MongoSequenceIncrementer(getMongoOperations(), "BATCH_JOB_INSTANCE_SEQ");
+ }
+
+ /**
+ * Return the incrementer to be used to generate ids for new job executions.
+ * @return the incrementer to be used to generate ids for new job executions
+ * @since 6.0
+ */
+ protected DataFieldMaxValueIncrementer getJobExecutionIncrementer() {
+ return new MongoSequenceIncrementer(getMongoOperations(), "BATCH_JOB_EXECUTION_SEQ");
+ }
+
+ /**
+ * Return the incrementer to be used to generate ids for new step executions.
+ * @return the incrementer to be used to generate ids for new step executions
+ * @since 6.0
+ */
+ protected DataFieldMaxValueIncrementer getStepExecutionIncrementer() {
+ return new MongoSequenceIncrementer(getMongoOperations(), "BATCH_STEP_EXECUTION_SEQ");
+ }
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ReferenceJobFactory.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ReferenceJobFactory.java
index 0427aebe3e..273b4d5022 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ReferenceJobFactory.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ReferenceJobFactory.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2013 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -15,19 +15,24 @@
*/
package org.springframework.batch.core.configuration.support;
-import org.springframework.batch.core.Job;
+import org.jspecify.annotations.NullUnmarked;
+
+import org.springframework.batch.core.job.Job;
import org.springframework.batch.core.configuration.JobFactory;
/**
- * A {@link JobFactory} that just keeps a reference to a {@link Job}. It never
- * modifies its {@link Job}.
+ * A {@link JobFactory} that keeps a reference to a {@link Job}. It never modifies its
+ * {@link Job}.
*
* @author Dave Syer
- *
+ * @author Mahmoud Ben Hassine
+ * @deprecated since 6.0 with no replacement. Scheduled for removal in 6.2 or later.
*/
+@NullUnmarked
+@Deprecated(since = "6.0", forRemoval = true)
public class ReferenceJobFactory implements JobFactory {
- private Job job;
+ private final Job job;
/**
* @param job the {@link Job} to return from {@link #createJob()}.
@@ -37,7 +42,7 @@ public ReferenceJobFactory(Job job) {
}
/**
- * Just return the instance passed in on initialization.
+ * Return the instance that was passed in on initialization.
*
* @see JobFactory#createJob()
*/
@@ -47,7 +52,7 @@ public final Job createJob() {
}
/**
- * Just return the name of instance passed in on initialization.
+ * Return the name of the instance that was passed in on initialization.
*
* @see JobFactory#getJobName()
*/
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ScopeConfiguration.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ScopeConfiguration.java
new file mode 100644
index 0000000000..79a46bf0d0
--- /dev/null
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/ScopeConfiguration.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2021-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.core.configuration.support;
+
+import org.springframework.batch.core.scope.JobScope;
+import org.springframework.batch.core.scope.StepScope;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * {@code Configuration} class that provides {@link StepScope} and {@link JobScope}.
+ *
+ * @author Dave Syer
+ * @author Mahmoud Ben Hassine
+ */
+@Configuration(proxyBeanMethods = false)
+public class ScopeConfiguration {
+
+ private static final StepScope stepScope;
+
+ private static final JobScope jobScope;
+
+ static {
+ jobScope = new JobScope();
+ jobScope.setAutoProxy(false);
+
+ stepScope = new StepScope();
+ stepScope.setAutoProxy(false);
+ }
+
+ /**
+ * @return The instance of {@link StepScope}.
+ */
+ @Bean
+ public static StepScope stepScope() {
+ return stepScope;
+ }
+
+ /**
+ * @return The instance of {@link JobScope}.
+ */
+ @Bean
+ public static JobScope jobScope() {
+ return jobScope;
+ }
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/package-info.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/package-info.java
index ba3ed75998..1656999517 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/package-info.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/package-info.java
@@ -4,7 +4,7 @@
* @author Michael Minella
* @author Mahmoud Ben Hassine
*/
-@NonNullApi
+@NullMarked
package org.springframework.batch.core.configuration.support;
-import org.springframework.lang.NonNullApi;
+import org.jspecify.annotations.NullMarked;
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractFlowParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractFlowParser.java
index be065c187e..c378258a91 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractFlowParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractFlowParser.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2014 the original author or authors.
+ * Copyright 2006-2024 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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -42,36 +42,79 @@
* @author Dave Syer
* @author Michael Minella
* @author Chris Schaefer
+ * @author Mahmoud Ben Hassine
*
*/
public abstract class AbstractFlowParser extends AbstractSingleBeanDefinitionParser {
+ /**
+ * Establishes the ID attribute.
+ */
protected static final String ID_ATTR = "id";
+ /**
+ * Establishes a Step element.
+ */
protected static final String STEP_ELE = "step";
+ /**
+ * Establishes a Flow element.
+ */
protected static final String FLOW_ELE = "flow";
+ /**
+ * Establishes a Decision element.
+ */
protected static final String DECISION_ELE = "decision";
+ /**
+ * Establishes a Split element.
+ */
protected static final String SPLIT_ELE = "split";
+ /**
+ * Establishes a Next attribute.
+ */
protected static final String NEXT_ATTR = "next";
+ /**
+ * Establishes a Next element.
+ */
protected static final String NEXT_ELE = "next";
+ /**
+ * Establishes an End element.
+ */
protected static final String END_ELE = "end";
+ /**
+ * Establishes a Fail element.
+ */
protected static final String FAIL_ELE = "fail";
+ /**
+ * Establishes a Stop element.
+ */
protected static final String STOP_ELE = "stop";
+ /**
+ * Establishes an On element.
+ */
protected static final String ON_ATTR = "on";
+ /**
+ * Establishes a To attribute.
+ */
protected static final String TO_ATTR = "to";
+ /**
+ * Establishes a Restart attribute.
+ */
protected static final String RESTART_ATTR = "restart";
+ /**
+ * Establishes a Exit Code element.
+ */
protected static final String EXIT_CODE_ATTR = "exit-code";
private static final InlineStepParser stepParser = new InlineStepParser();
@@ -80,33 +123,31 @@ public abstract class AbstractFlowParser extends AbstractSingleBeanDefinitionPar
private static final DecisionParser decisionParser = new DecisionParser();
+ /**
+ * Used as a suffix to generate unique state names for end transitions.
+ */
// For generating unique state names for end transitions
protected static int endCounter = 0;
private String jobFactoryRef;
/**
- * Convenience method for subclasses to set the job factory reference if it
- * is available (null is fine, but the quality of error reports is better if
- * it is available).
- *
+ * Convenience method for subclasses to set the job factory reference if it is
+ * available (null is fine, but the quality of error reports is better if it is
+ * available).
* @param jobFactoryRef name of the ref
*/
protected void setJobFactoryRef(String jobFactoryRef) {
this.jobFactoryRef = jobFactoryRef;
}
- /*
- * (non-Javadoc)
- *
- * @see AbstractSingleBeanDefinitionParser#getBeanClass(Element)
- */
@Override
protected Class getBeanClass(Element element) {
return SimpleFlowFactoryBean.class;
}
/**
+ * Performs the parsing for a flow definition.
* @param element the top level element containing a flow definition
* @param parserContext the {@link ParserContext}
*/
@@ -126,25 +167,24 @@ protected void doParse(Element element, ParserContext parserContext, BeanDefinit
NodeList children = element.getChildNodes();
for (int i = 0; i < children.getLength(); i++) {
Node node = children.item(i);
- if (node instanceof Element) {
+ if (node instanceof Element child) {
String nodeName = node.getLocalName();
- Element child = (Element) node;
- if (nodeName.equals(STEP_ELE)) {
- stateTransitions.addAll(stepParser.parse(child, parserContext, jobFactoryRef));
- stepExists = true;
- }
- else if (nodeName.equals(DECISION_ELE)) {
- stateTransitions.addAll(decisionParser.parse(child, parserContext));
- }
- else if (nodeName.equals(FLOW_ELE)) {
- stateTransitions.addAll(flowParser.parse(child, parserContext));
- stepExists = true;
- }
- else if (nodeName.equals(SPLIT_ELE)) {
- stateTransitions.addAll(splitParser
- .parse(child, new ParserContext(parserContext.getReaderContext(), parserContext
- .getDelegate(), builder.getBeanDefinition())));
- stepExists = true;
+ switch (nodeName) {
+ case STEP_ELE -> {
+ stateTransitions.addAll(stepParser.parse(child, parserContext, jobFactoryRef));
+ stepExists = true;
+ }
+ case DECISION_ELE -> stateTransitions.addAll(decisionParser.parse(child, parserContext));
+ case FLOW_ELE -> {
+ stateTransitions.addAll(flowParser.parse(child, parserContext));
+ stepExists = true;
+ }
+ case SPLIT_ELE -> {
+ stateTransitions
+ .addAll(splitParser.parse(child, new ParserContext(parserContext.getReaderContext(),
+ parserContext.getDelegate(), builder.getBeanDefinition())));
+ stepExists = true;
+ }
}
if (Arrays.asList(STEP_ELE, DECISION_ELE, SPLIT_ELE, FLOW_ELE).contains(nodeName)) {
@@ -158,8 +198,8 @@ else if (nodeName.equals(SPLIT_ELE)) {
String flowName = (String) builder.getRawBeanDefinition().getAttribute("flowName");
if (!stepExists && !StringUtils.hasText(element.getAttribute("parent"))) {
- parserContext.getReaderContext().error("The flow [" + flowName + "] must contain at least one step, flow or split",
- element);
+ parserContext.getReaderContext()
+ .error("The flow [" + flowName + "] must contain at least one step, flow or split", element);
}
// Ensure that all elements are reachable
@@ -179,7 +219,6 @@ else if (nodeName.equals(SPLIT_ELE)) {
/**
* Find all of the elements that are pointed to by this element.
- *
* @param element The parent element
* @return a collection of reachable element names
*/
@@ -207,11 +246,11 @@ private Set findReachableElements(Element element) {
}
/**
- * Find all of the elements reachable from the startElement.
- *
- * @param startElement name of the element to start from
- * @param reachableElementMap Map of elements that can be reached from the startElement
- * @param accumulator a collection of reachable element names
+ * Find all of the elements that are reachable from the {@code startElement}.
+ * @param startElement Name of the element to start from
+ * @param reachableElementMap Map of elements that can be reached from the
+ * startElement
+ * @param accumulator A collection of reachable element names
*/
protected void findAllReachableElements(String startElement, Map> reachableElementMap,
Set accumulator) {
@@ -228,12 +267,11 @@ protected void findAllReachableElements(String startElement, Map getNextElements(ParserContext parserContext, BeanDefinition stateDef,
Element element) {
@@ -241,14 +279,15 @@ public static Collection getNextElements(ParserContext parserCon
}
/**
- * @param parserContext the parser context for the bean factory
- * @param stepId the id of the current state if it is a step state, null
- * otherwise
+ * Retrieve a list of
+ * {@link org.springframework.batch.core.job.flow.support.StateTransition} instances
+ * from a {@link ParserContext}.
+ * @param parserContext The parser context for the bean factory
+ * @param stepId The ID of the current state if it is a step state, null otherwise
* @param stateDef The bean definition for the current state
- * @param element the <step/gt; element to parse
+ * @param element The <step/gt; element to parse
* @return a collection of
- * {@link org.springframework.batch.core.job.flow.support.StateTransition}
- * references
+ * {@link org.springframework.batch.core.job.flow.support.StateTransition} references
*/
public static Collection getNextElements(ParserContext parserContext, String stepId,
BeanDefinition stateDef, Element element) {
@@ -283,26 +322,28 @@ public static Collection getNextElements(ParserContext parserCon
}
}
else if (hasNextAttribute) {
- parserContext.getReaderContext().error(
- "The <" + element.getNodeName() + "/> may not contain a '" + NEXT_ATTR
- + "' attribute and a transition element", element);
+ parserContext.getReaderContext()
+ .error("The <" + element.getNodeName() + "/> may not contain a '" + NEXT_ATTR
+ + "' attribute and a transition element", element);
}
return list;
}
/**
+ * Verifies that {@code transitionElement} is not in the list of state transition
+ * patterns.
* @param transitionElement The element to parse
- * @param patterns a list of patterns on state transitions for this element
- * @param element {@link Element} representing the source.
- * @param parserContext the parser context for the bean factory
+ * @param patterns A list of patterns on state transitions for this element
+ * @param element The {@link Element} representing the source.
+ * @param parserContext The parser context for the bean factory
*/
protected static void verifyUniquePattern(Element transitionElement, List patterns, Element element,
ParserContext parserContext) {
String onAttribute = transitionElement.getAttribute(ON_ATTR);
if (patterns.contains(onAttribute)) {
- parserContext.getReaderContext().error("Duplicate transition pattern found for '" + onAttribute + "'",
- element);
+ parserContext.getReaderContext()
+ .error("Duplicate transition pattern found for '" + onAttribute + "'", element);
}
patterns.add(onAttribute);
}
@@ -310,10 +351,9 @@ protected static void verifyUniquePattern(Element transitionElement, List parseTransitionElement(Element transitionElement, String stateId,
BeanDefinition stateDef, ParserContext parserContext) {
@@ -328,24 +368,24 @@ private static Collection parseTransitionElement(Element transit
boolean abandon = stateId != null && StringUtils.hasText(restartAttribute) && !restartAttribute.equals(stateId);
String exitCodeAttribute = transitionElement.getAttribute(EXIT_CODE_ATTR);
- return createTransition(status, onAttribute, nextAttribute, exitCodeAttribute, stateDef, parserContext, abandon);
+ return createTransition(status, onAttribute, nextAttribute, exitCodeAttribute, stateDef, parserContext,
+ abandon);
}
/**
* @param status The batch status that this transition will set. Use
* BatchStatus.UNKNOWN if not applicable.
- * @param on The pattern that this transition should match. Use null for
- * "no restriction" (same as "*").
+ * @param on The pattern that this transition should match. Use null for "no
+ * restriction" (same as "*").
* @param next The state to which this transition should go. Use null if not
* applicable.
- * @param exitCode The exit code that this transition will set. Use null to
- * default to batchStatus.
+ * @param exitCode The exit code that this transition will set. Use null to default to
+ * batchStatus.
* @param stateDef The bean definition for the current state
- * @param parserContext the parser context for the bean factory
- * @param abandon the abandon flag to be used by the transition.
+ * @param parserContext The parser context for the bean factory
+ * @param abandon The {@code abandon} flag to be used by the transition.
* @return a collection of
- * {@link org.springframework.batch.core.job.flow.support.StateTransition}
- * references
+ * {@link org.springframework.batch.core.job.flow.support.StateTransition} references
*/
protected static Collection createTransition(FlowExecutionStatus status, String on, String next,
String exitCode, BeanDefinition stateDef, ParserContext parserContext, boolean abandon) {
@@ -355,7 +395,7 @@ protected static Collection createTransition(FlowExecutionStatus
if (status.isEnd()) {
BeanDefinitionBuilder endBuilder = BeanDefinitionBuilder
- .genericBeanDefinition("org.springframework.batch.core.job.flow.support.state.EndState");
+ .genericBeanDefinition("org.springframework.batch.core.job.flow.support.state.EndState");
boolean exitCodeExists = StringUtils.hasText(exitCode);
@@ -364,14 +404,12 @@ protected static Collection createTransition(FlowExecutionStatus
endBuilder.addConstructorArgValue(exitCodeExists ? exitCode : status.getName());
String endName = (status == FlowExecutionStatus.STOPPED ? STOP_ELE
- : status == FlowExecutionStatus.FAILED ? FAIL_ELE : END_ELE)
- + (endCounter++);
+ : status == FlowExecutionStatus.FAILED ? FAIL_ELE : END_ELE) + endCounter++;
endBuilder.addConstructorArgValue(endName);
endBuilder.addConstructorArgValue(abandon);
- String nextOnEnd = exitCodeExists ? null : next;
- endState = getStateTransitionReference(parserContext, endBuilder.getBeanDefinition(), null, nextOnEnd);
+ endState = getStateTransitionReference(parserContext, endBuilder.getBeanDefinition(), null, next);
next = endName;
}
@@ -389,42 +427,39 @@ protected static Collection createTransition(FlowExecutionStatus
}
/**
+ * Gets the batch status from the end transition name by the element.
* @param elementName An end transition element name
- * @return the BatchStatus corresponding to the transition name
+ * @return the {@link org.springframework.batch.core.BatchStatus} corresponding to the
+ * transition name.
*/
protected static FlowExecutionStatus getBatchStatusFromEndTransitionName(String elementName) {
elementName = stripNamespace(elementName);
- if (STOP_ELE.equals(elementName)) {
- return FlowExecutionStatus.STOPPED;
- }
- else if (END_ELE.equals(elementName)) {
- return FlowExecutionStatus.COMPLETED;
- }
- else if (FAIL_ELE.equals(elementName)) {
- return FlowExecutionStatus.FAILED;
- }
- else {
- return FlowExecutionStatus.UNKNOWN;
- }
+ return switch (elementName) {
+ case STOP_ELE -> FlowExecutionStatus.STOPPED;
+ case END_ELE -> FlowExecutionStatus.COMPLETED;
+ case FAIL_ELE -> FlowExecutionStatus.FAILED;
+ default -> FlowExecutionStatus.UNKNOWN;
+ };
}
/**
- * Strip the namespace from the element name if it exists.
+ * Strip the namespace from the element name, if it exists.
*/
- private static String stripNamespace(String elementName){
- if(elementName.startsWith("batch:")){
+ private static String stripNamespace(String elementName) {
+ if (elementName.startsWith("batch:")) {
return elementName.substring(6);
}
- else{
+ else {
return elementName;
}
}
/**
- * @param parserContext the parser context
- * @param stateDefinition a reference to the state implementation
- * @param on the pattern value
- * @param next the next step id
+ * Gets a reference to the state transition.
+ * @param parserContext The parser context
+ * @param stateDefinition A reference to the state implementation
+ * @param on The pattern value
+ * @param next The next step id
* @return a bean definition for a
* {@link org.springframework.batch.core.job.flow.support.StateTransition}
*/
@@ -432,7 +467,7 @@ public static BeanDefinition getStateTransitionReference(ParserContext parserCon
BeanDefinition stateDefinition, String on, String next) {
BeanDefinitionBuilder nextBuilder = BeanDefinitionBuilder
- .genericBeanDefinition("org.springframework.batch.core.job.flow.support.StateTransition");
+ .genericBeanDefinition("org.springframework.batch.core.job.flow.support.StateTransition");
nextBuilder.addConstructorArgValue(stateDefinition);
if (StringUtils.hasText(on)) {
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractListenerParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractListenerParser.java
index e5b9e7e2a3..1ec84f6013 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractListenerParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractListenerParser.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2009-2014 the original author or authors.
+ * Copyright 2009-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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -34,6 +34,7 @@
/**
* @author Dan Garrette
+ * @author Mahmoud Ben Hassine
* @since 2.0
* @see StepListenerParser
* @see JobExecutionListenerParser
@@ -55,7 +56,8 @@ public AbstractBeanDefinition parse(Element element, ParserContext parserContext
}
public void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
- builder.addPropertyValue("delegate", parseListenerElement(element, parserContext, builder.getRawBeanDefinition()));
+ builder.addPropertyValue("delegate",
+ parseListenerElement(element, parserContext, builder.getRawBeanDefinition()));
ManagedMap metaDataMap = new ManagedMap<>();
for (String metaDataPropertyName : getMethodNameAttributes()) {
@@ -67,7 +69,8 @@ public void doParse(Element element, ParserContext parserContext, BeanDefinition
builder.addPropertyValue("metaDataMap", metaDataMap);
}
- public static BeanMetadataElement parseListenerElement(Element element, ParserContext parserContext, BeanDefinition enclosing) {
+ public static BeanMetadataElement parseListenerElement(Element element, ParserContext parserContext,
+ BeanDefinition enclosing) {
String listenerRef = element.getAttribute(REF_ATTR);
List beanElements = DomUtils.getChildElementsByTagName(element, BEAN_ELE);
List refElements = DomUtils.getChildElementsByTagName(element, REF_ELE);
@@ -79,8 +82,8 @@ public static BeanMetadataElement parseListenerElement(Element element, ParserCo
}
else if (beanElements.size() == 1) {
Element beanElement = beanElements.get(0);
- BeanDefinitionHolder beanDefinitionHolder = parserContext.getDelegate().parseBeanDefinitionElement(
- beanElement, enclosing);
+ BeanDefinitionHolder beanDefinitionHolder = parserContext.getDelegate()
+ .parseBeanDefinitionElement(beanElement, enclosing);
parserContext.getDelegate().decorateBeanDefinitionIfRequired(beanElement, beanDefinitionHolder);
return beanDefinitionHolder;
}
@@ -105,22 +108,22 @@ private static void verifyListenerAttributesAndSubelements(String listenerRef, L
found.append("<" + BEAN_ELE + "/> element, ");
}
else if (beanElements.size() > 1) {
- found.append(beanElements.size() + " <" + BEAN_ELE + "/> elements, ");
+ found.append(beanElements.size()).append(" <").append(BEAN_ELE).append("/> elements, ");
}
if (refElements.size() == 1) {
found.append("<" + REF_ELE + "/> element, ");
}
else if (refElements.size() > 1) {
- found.append(refElements.size() + " <" + REF_ELE + "/> elements, ");
+ found.append(refElements.size()).append(" <").append(REF_ELE).append("/> elements, ");
}
found.delete(found.length() - 2, found.length());
}
String id = element.getAttribute(ID_ATTR);
- parserContext.getReaderContext().error(
- "The <" + element.getTagName() + (StringUtils.hasText(id) ? " id=\"" + id + "\"" : "")
- + "/> element must have exactly one of: '" + REF_ATTR + "' attribute, <" + BEAN_ELE
- + "/> attribute, or <" + REF_ELE + "/> element. Found: " + found + ".", element);
+ parserContext.getReaderContext()
+ .error("The <" + element.getTagName() + (StringUtils.hasText(id) ? " id=\"" + id + "\"" : "")
+ + "/> element must have exactly one of: '" + REF_ATTR + "' attribute, <" + BEAN_ELE
+ + "/> attribute, or <" + REF_ELE + "/> element. Found: " + found + ".", element);
}
}
@@ -132,8 +135,17 @@ private List getMethodNameAttributes() {
return methodNameAttributes;
}
+ /**
+ * Gets the bean class.
+ * @return The {@link Class} for the implementation of
+ * {@link AbstractListenerFactoryBean}.
+ */
protected abstract Class> getBeanClass();
+ /**
+ * Gets the metadata values.
+ * @return The array of {@link ListenerMetaData}.
+ */
protected abstract ListenerMetaData[] getMetaDataValues();
-}
\ No newline at end of file
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractStepParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractStepParser.java
index 68023d8664..73ef8f82cc 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractStepParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/AbstractStepParser.java
@@ -1,300 +1,303 @@
-/*
- * Copyright 2006-2009 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
- *
- * http://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.core.configuration.xml;
-
-import org.w3c.dom.Element;
-import org.w3c.dom.Node;
-import org.w3c.dom.NodeList;
-
-import org.springframework.batch.core.listener.StepListenerMetaData;
-import org.springframework.beans.MutablePropertyValues;
-import org.springframework.beans.factory.config.BeanDefinition;
-import org.springframework.beans.factory.config.BeanDefinitionHolder;
-import org.springframework.beans.factory.config.RuntimeBeanReference;
-import org.springframework.beans.factory.config.TypedStringValue;
-import org.springframework.beans.factory.support.AbstractBeanDefinition;
-import org.springframework.beans.factory.support.BeanDefinitionBuilder;
-import org.springframework.beans.factory.support.GenericBeanDefinition;
-import org.springframework.beans.factory.xml.BeanDefinitionParserDelegate;
-import org.springframework.beans.factory.xml.ParserContext;
-import org.springframework.util.StringUtils;
-import org.springframework.util.xml.DomUtils;
-
-/**
- * Internal parser for the <step/> elements inside a job. A step element
- * references a bean definition for a
- * {@link org.springframework.batch.core.Step} and goes on to (optionally) list
- * a set of transitions from that step to others with <next on="pattern"
- * to="stepName"/>. Used by the {@link JobParser}.
- *
- * @author Dave Syer
- * @author Thomas Risberg
- * @author Josh Long
- * @see JobParser
- * @since 2.0
- */
-public abstract class AbstractStepParser {
-
- protected static final String ID_ATTR = "id";
-
- private static final String PARENT_ATTR = "parent";
-
- private static final String REF_ATTR = "ref";
-
- private static final String ALLOW_START_ATTR = "allow-start-if-complete";
-
- private static final String TASKLET_ELE = "tasklet";
-
- private static final String PARTITION_ELE = "partition";
-
- private static final String JOB_ELE = "job";
-
- private static final String JOB_PARAMS_EXTRACTOR_ATTR = "job-parameters-extractor";
-
- private static final String JOB_LAUNCHER_ATTR = "job-launcher";
-
- private static final String STEP_ATTR = "step";
-
- private static final String STEP_ELE = STEP_ATTR;
-
- private static final String PARTITIONER_ATTR = "partitioner";
-
- private static final String AGGREGATOR_ATTR = "aggregator";
-
- private static final String HANDLER_ATTR = "handler";
-
- private static final String HANDLER_ELE = "handler";
-
- private static final String TASK_EXECUTOR_ATTR = "task-executor";
-
- private static final String GRID_SIZE_ATTR = "grid-size";
-
- private static final String FLOW_ELE = "flow";
-
- private static final String JOB_REPO_ATTR = "job-repository";
-
- private static final StepListenerParser stepListenerParser = new StepListenerParser(StepListenerMetaData.stepExecutionListenerMetaData());
-
- /**
- * @param stepElement The <step/> element
- * @param parserContext instance of {@link ParserContext}.
- * @param jobFactoryRef the reference to the {@link JobParserJobFactoryBean}
- * from the enclosing tag. Use 'null' if unknown.
- * @return {@link AbstractBeanDefinition} for the stepElement.
- */
- protected AbstractBeanDefinition parseStep(Element stepElement, ParserContext parserContext, String jobFactoryRef) {
-
- BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition();
- AbstractBeanDefinition bd = builder.getRawBeanDefinition();
-
- // look at all nested elements
- NodeList children = stepElement.getChildNodes();
-
- for (int i = 0; i < children.getLength(); i++) {
- Node nd = children.item(i);
-
- if (nd instanceof Element) {
- Element nestedElement = (Element) nd;
- String name = nestedElement.getLocalName();
-
- if (TASKLET_ELE.equals(name)) {
- boolean stepUnderspecified = CoreNamespaceUtils.isUnderspecified(stepElement);
- new TaskletParser().parseTasklet(stepElement, nestedElement, bd, parserContext, stepUnderspecified);
- }
- else if (FLOW_ELE.equals(name)) {
- boolean stepUnderspecified = CoreNamespaceUtils.isUnderspecified(stepElement);
- parseFlow(stepElement, nestedElement, bd, parserContext, stepUnderspecified);
- }
- else if (PARTITION_ELE.equals(name)) {
- boolean stepUnderspecified = CoreNamespaceUtils.isUnderspecified(stepElement);
- parsePartition(stepElement, nestedElement, bd, parserContext, stepUnderspecified, jobFactoryRef);
- }
- else if (JOB_ELE.equals(name)) {
- boolean stepUnderspecified = CoreNamespaceUtils.isUnderspecified(stepElement);
- parseJob(stepElement, nestedElement, bd, parserContext, stepUnderspecified);
- }
- else if ("description".equals(name)) {
- bd.setDescription(nestedElement.getTextContent());
- }
-
- // nested bean reference/declaration
- else {
- String ns = nestedElement.getNamespaceURI();
- Object value = null;
- boolean skip = false;
-
- // Spring NS
- if ((ns == null && name.equals(BeanDefinitionParserDelegate.BEAN_ELEMENT))
- || ns.equals(BeanDefinitionParserDelegate.BEANS_NAMESPACE_URI)) {
- BeanDefinitionHolder holder = parserContext.getDelegate().parseBeanDefinitionElement(nestedElement);
- value = parserContext.getDelegate().decorateBeanDefinitionIfRequired(nestedElement, holder);
- }
- // Spring Batch transitions
- else if (ns.equals("http://www.springframework.org/schema/batch")) {
- // don't parse
- skip = true;
- }
- // Custom NS
- else {
- value = parserContext.getDelegate().parseCustomElement(nestedElement);
- }
-
- if (!skip) {
- bd.setBeanClass(StepParserStepFactoryBean.class);
- bd.setAttribute("isNamespaceStep", true);
- builder.addPropertyValue("tasklet", value);
- }
- }
- }
- }
-
- String parentRef = stepElement.getAttribute(PARENT_ATTR);
- if (StringUtils.hasText(parentRef)) {
- bd.setParentName(parentRef);
- }
-
- String isAbstract = stepElement.getAttribute("abstract");
- if (StringUtils.hasText(isAbstract)) {
- bd.setAbstract(Boolean.valueOf(isAbstract));
- }
-
- String jobRepositoryRef = stepElement.getAttribute(JOB_REPO_ATTR);
- if (StringUtils.hasText(jobRepositoryRef)) {
- builder.addPropertyReference("jobRepository", jobRepositoryRef);
- }
-
- if (StringUtils.hasText(jobFactoryRef)) {
- bd.setAttribute("jobParserJobFactoryBeanRef", jobFactoryRef);
- }
-
- //add the allow parser here
- String isAllowStart = stepElement.getAttribute(ALLOW_START_ATTR);
- if (StringUtils.hasText(isAllowStart)) {
- //check if the value is already set from an inner element
- if (!bd.getPropertyValues().contains("allowStartIfComplete")) {
- //set the value as a property
- bd.getPropertyValues().add("allowStartIfComplete", Boolean.valueOf(isAllowStart));
- }//end if
- }
-
- stepListenerParser.handleListenersElement(stepElement, bd, parserContext);
- return bd;
- }
-
- private void parsePartition(Element stepElement, Element partitionElement, AbstractBeanDefinition bd, ParserContext parserContext, boolean stepUnderspecified, String jobFactoryRef ) {
-
- bd.setBeanClass(StepParserStepFactoryBean.class);
- bd.setAttribute("isNamespaceStep", true);
- String stepRef = partitionElement.getAttribute(STEP_ATTR);
- String partitionerRef = partitionElement.getAttribute(PARTITIONER_ATTR);
- String aggregatorRef = partitionElement.getAttribute(AGGREGATOR_ATTR);
- String handlerRef = partitionElement.getAttribute(HANDLER_ATTR);
-
- if (!StringUtils.hasText(partitionerRef)) {
- parserContext.getReaderContext().error("You must specify a partitioner", partitionElement);
- return;
- }
-
- MutablePropertyValues propertyValues = bd.getPropertyValues();
-
- propertyValues.addPropertyValue("partitioner", new RuntimeBeanReference(partitionerRef));
- if (StringUtils.hasText(aggregatorRef)) {
- propertyValues.addPropertyValue("stepExecutionAggregator", new RuntimeBeanReference(aggregatorRef));
- }
-
- boolean customHandler = false;
- if (!StringUtils.hasText(handlerRef)) {
- Element handlerElement = DomUtils.getChildElementByTagName(partitionElement, HANDLER_ELE);
- if (handlerElement != null) {
- String taskExecutorRef = handlerElement.getAttribute(TASK_EXECUTOR_ATTR);
- if (StringUtils.hasText(taskExecutorRef)) {
- propertyValues.addPropertyValue("taskExecutor", new RuntimeBeanReference(taskExecutorRef));
- }
- String gridSize = handlerElement.getAttribute(GRID_SIZE_ATTR);
- if (StringUtils.hasText(gridSize)) {
- propertyValues.addPropertyValue("gridSize", new TypedStringValue(gridSize));
- }
- }
- } else {
- customHandler = true;
- BeanDefinition partitionHandler = BeanDefinitionBuilder.genericBeanDefinition().getRawBeanDefinition();
- partitionHandler.setParentName(handlerRef);
- propertyValues.addPropertyValue("partitionHandler", partitionHandler);
- }
-
- Element inlineStepElement = DomUtils.getChildElementByTagName(partitionElement, STEP_ELE);
- if (inlineStepElement == null && !StringUtils.hasText(stepRef) && !customHandler) {
- parserContext.getReaderContext().error("You must specify a step", partitionElement);
- return;
- }
-
- if (StringUtils.hasText(stepRef)) {
- propertyValues.addPropertyValue("step", new RuntimeBeanReference(stepRef));
- } else if( inlineStepElement!=null) {
- AbstractBeanDefinition stepDefinition = parseStep(inlineStepElement, parserContext, jobFactoryRef);
- stepDefinition.getPropertyValues().addPropertyValue("name", stepElement.getAttribute(ID_ATTR));
- propertyValues.addPropertyValue("step", stepDefinition );
- }
-
- }
-
- private void parseJob(Element stepElement, Element jobElement, AbstractBeanDefinition bd, ParserContext parserContext, boolean stepUnderspecified) {
-
- bd.setBeanClass(StepParserStepFactoryBean.class);
- bd.setAttribute("isNamespaceStep", true);
- String jobRef = jobElement.getAttribute(REF_ATTR);
-
- if (!StringUtils.hasText(jobRef)) {
- parserContext.getReaderContext().error("You must specify a job", jobElement);
- return;
- }
-
- MutablePropertyValues propertyValues = bd.getPropertyValues();
- propertyValues.addPropertyValue("job", new RuntimeBeanReference(jobRef));
-
- String jobParametersExtractor = jobElement.getAttribute(JOB_PARAMS_EXTRACTOR_ATTR);
- String jobLauncher = jobElement.getAttribute(JOB_LAUNCHER_ATTR);
-
- if (StringUtils.hasText(jobParametersExtractor)) {
- propertyValues.addPropertyValue("jobParametersExtractor", new RuntimeBeanReference(jobParametersExtractor));
- }
- if (StringUtils.hasText(jobLauncher)) {
- propertyValues.addPropertyValue("jobLauncher", new RuntimeBeanReference(jobLauncher));
- }
-
- }
-
-
- private void parseFlow(Element stepElement, Element flowElement, AbstractBeanDefinition bd,
- ParserContext parserContext, boolean stepUnderspecified) {
-
- bd.setBeanClass(StepParserStepFactoryBean.class);
- bd.setAttribute("isNamespaceStep", true);
- String flowRef = flowElement.getAttribute(PARENT_ATTR);
- String idAttribute = stepElement.getAttribute(ID_ATTR);
-
- BeanDefinition flowDefinition = new GenericBeanDefinition();
- flowDefinition.setParentName(flowRef);
- MutablePropertyValues propertyValues = flowDefinition.getPropertyValues();
- if (StringUtils.hasText(idAttribute)) {
- propertyValues.addPropertyValue("name", idAttribute);
- }
-
- bd.getPropertyValues().addPropertyValue("flow", flowDefinition);
-
- }
-
-}
+/*
+ * Copyright 2006-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.core.configuration.xml;
+
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+
+import org.springframework.batch.core.listener.StepListenerMetaData;
+import org.springframework.batch.core.step.Step;
+import org.springframework.beans.MutablePropertyValues;
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.config.BeanDefinitionHolder;
+import org.springframework.beans.factory.config.RuntimeBeanReference;
+import org.springframework.beans.factory.config.TypedStringValue;
+import org.springframework.beans.factory.support.AbstractBeanDefinition;
+import org.springframework.beans.factory.support.BeanDefinitionBuilder;
+import org.springframework.beans.factory.support.GenericBeanDefinition;
+import org.springframework.beans.factory.xml.BeanDefinitionParserDelegate;
+import org.springframework.beans.factory.xml.ParserContext;
+import org.springframework.util.StringUtils;
+import org.springframework.util.xml.DomUtils;
+
+/**
+ * Internal parser for the <step/> elements inside a job. A step element references
+ * a bean definition for a {@link Step} and goes on to (optionally) list a set of
+ * transitions from that step to others with <next on="pattern" to="stepName"/>.
+ * Used by the {@link JobParser}.
+ *
+ * @author Dave Syer
+ * @author Thomas Risberg
+ * @author Josh Long
+ * @author Mahmoud Ben Hassine
+ * @see JobParser
+ * @since 2.0
+ */
+public abstract class AbstractStepParser {
+
+ /**
+ * The ID attribute for the step parser.
+ */
+ protected static final String ID_ATTR = "id";
+
+ private static final String PARENT_ATTR = "parent";
+
+ private static final String REF_ATTR = "ref";
+
+ private static final String ALLOW_START_ATTR = "allow-start-if-complete";
+
+ private static final String TASKLET_ELE = "tasklet";
+
+ private static final String PARTITION_ELE = "partition";
+
+ private static final String JOB_ELE = "job";
+
+ private static final String JOB_PARAMS_EXTRACTOR_ATTR = "job-parameters-extractor";
+
+ private static final String JOB_LAUNCHER_ATTR = "job-launcher";
+
+ private static final String STEP_ATTR = "step";
+
+ private static final String STEP_ELE = STEP_ATTR;
+
+ private static final String PARTITIONER_ATTR = "partitioner";
+
+ private static final String AGGREGATOR_ATTR = "aggregator";
+
+ private static final String HANDLER_ATTR = "handler";
+
+ private static final String HANDLER_ELE = "handler";
+
+ private static final String TASK_EXECUTOR_ATTR = "task-executor";
+
+ private static final String GRID_SIZE_ATTR = "grid-size";
+
+ private static final String FLOW_ELE = "flow";
+
+ private static final String JOB_REPO_ATTR = "job-repository";
+
+ private static final StepListenerParser stepListenerParser = new StepListenerParser(
+ StepListenerMetaData.stepExecutionListenerMetaData());
+
+ /**
+ * @param stepElement The <step/> element
+ * @param parserContext instance of {@link ParserContext}.
+ * @param jobFactoryRef the reference to the {@link JobParserJobFactoryBean} from the
+ * enclosing tag. Use 'null' if unknown.
+ * @return {@link AbstractBeanDefinition} for the stepElement.
+ */
+ protected AbstractBeanDefinition parseStep(Element stepElement, ParserContext parserContext, String jobFactoryRef) {
+
+ BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition();
+ AbstractBeanDefinition bd = builder.getRawBeanDefinition();
+
+ // look at all nested elements
+ NodeList children = stepElement.getChildNodes();
+
+ for (int i = 0; i < children.getLength(); i++) {
+ Node nd = children.item(i);
+
+ if (nd instanceof Element nestedElement) {
+ String name = nestedElement.getLocalName();
+
+ if (TASKLET_ELE.equals(name)) {
+ boolean stepUnderspecified = CoreNamespaceUtils.isUnderspecified(stepElement);
+ new TaskletParser().parseTasklet(stepElement, nestedElement, bd, parserContext, stepUnderspecified);
+ }
+ else if (FLOW_ELE.equals(name)) {
+ parseFlow(stepElement, nestedElement, bd);
+ }
+ else if (PARTITION_ELE.equals(name)) {
+ parsePartition(stepElement, nestedElement, bd, parserContext, jobFactoryRef);
+ }
+ else if (JOB_ELE.equals(name)) {
+ parseJob(nestedElement, bd, parserContext);
+ }
+ else if ("description".equals(name)) {
+ bd.setDescription(nestedElement.getTextContent());
+ }
+
+ // nested bean reference/declaration
+ else {
+ String ns = nestedElement.getNamespaceURI();
+ Object value = null;
+ boolean skip = false;
+
+ // Spring NS
+ if ((ns == null && name.equals(BeanDefinitionParserDelegate.BEAN_ELEMENT))
+ || ns.equals(BeanDefinitionParserDelegate.BEANS_NAMESPACE_URI)) {
+ BeanDefinitionHolder holder = parserContext.getDelegate()
+ .parseBeanDefinitionElement(nestedElement);
+ value = parserContext.getDelegate().decorateBeanDefinitionIfRequired(nestedElement, holder);
+ }
+ // Spring Batch transitions
+ else if (ns.equals("http://www.springframework.org/schema/batch")) {
+ // don't parse
+ skip = true;
+ }
+ // Custom NS
+ else {
+ value = parserContext.getDelegate().parseCustomElement(nestedElement);
+ }
+
+ if (!skip) {
+ bd.setBeanClass(StepParserStepFactoryBean.class);
+ bd.setAttribute("isNamespaceStep", true);
+ builder.addPropertyValue("tasklet", value);
+ }
+ }
+ }
+ }
+
+ String parentRef = stepElement.getAttribute(PARENT_ATTR);
+ if (StringUtils.hasText(parentRef)) {
+ bd.setParentName(parentRef);
+ }
+
+ String isAbstract = stepElement.getAttribute("abstract");
+ if (StringUtils.hasText(isAbstract)) {
+ bd.setAbstract(Boolean.parseBoolean(isAbstract));
+ }
+
+ String jobRepositoryRef = stepElement.getAttribute(JOB_REPO_ATTR);
+ if (StringUtils.hasText(jobRepositoryRef)) {
+ builder.addPropertyReference("jobRepository", jobRepositoryRef);
+ }
+
+ if (StringUtils.hasText(jobFactoryRef)) {
+ bd.setAttribute("jobParserJobFactoryBeanRef", jobFactoryRef);
+ }
+
+ // add the allow parser here
+ String isAllowStart = stepElement.getAttribute(ALLOW_START_ATTR);
+ if (StringUtils.hasText(isAllowStart)) {
+ // check if the value is already set from an inner element
+ if (!bd.getPropertyValues().contains("allowStartIfComplete")) {
+ // set the value as a property
+ bd.getPropertyValues().add("allowStartIfComplete", Boolean.valueOf(isAllowStart));
+ } // end if
+ }
+
+ stepListenerParser.handleListenersElement(stepElement, bd, parserContext);
+ return bd;
+ }
+
+ private void parsePartition(Element stepElement, Element partitionElement, AbstractBeanDefinition bd,
+ ParserContext parserContext, String jobFactoryRef) {
+
+ bd.setBeanClass(StepParserStepFactoryBean.class);
+ bd.setAttribute("isNamespaceStep", true);
+ String stepRef = partitionElement.getAttribute(STEP_ATTR);
+ String partitionerRef = partitionElement.getAttribute(PARTITIONER_ATTR);
+ String aggregatorRef = partitionElement.getAttribute(AGGREGATOR_ATTR);
+ String handlerRef = partitionElement.getAttribute(HANDLER_ATTR);
+
+ if (!StringUtils.hasText(partitionerRef)) {
+ parserContext.getReaderContext().error("You must specify a partitioner", partitionElement);
+ return;
+ }
+
+ MutablePropertyValues propertyValues = bd.getPropertyValues();
+
+ propertyValues.addPropertyValue("partitioner", new RuntimeBeanReference(partitionerRef));
+ if (StringUtils.hasText(aggregatorRef)) {
+ propertyValues.addPropertyValue("stepExecutionAggregator", new RuntimeBeanReference(aggregatorRef));
+ }
+
+ boolean customHandler = false;
+ if (!StringUtils.hasText(handlerRef)) {
+ Element handlerElement = DomUtils.getChildElementByTagName(partitionElement, HANDLER_ELE);
+ if (handlerElement != null) {
+ String taskExecutorRef = handlerElement.getAttribute(TASK_EXECUTOR_ATTR);
+ if (StringUtils.hasText(taskExecutorRef)) {
+ propertyValues.addPropertyValue("taskExecutor", new RuntimeBeanReference(taskExecutorRef));
+ }
+ String gridSize = handlerElement.getAttribute(GRID_SIZE_ATTR);
+ if (StringUtils.hasText(gridSize)) {
+ propertyValues.addPropertyValue("gridSize", new TypedStringValue(gridSize));
+ }
+ }
+ }
+ else {
+ customHandler = true;
+ BeanDefinition partitionHandler = BeanDefinitionBuilder.genericBeanDefinition().getRawBeanDefinition();
+ partitionHandler.setParentName(handlerRef);
+ propertyValues.addPropertyValue("partitionHandler", partitionHandler);
+ }
+
+ Element inlineStepElement = DomUtils.getChildElementByTagName(partitionElement, STEP_ELE);
+ if (inlineStepElement == null && !StringUtils.hasText(stepRef) && !customHandler) {
+ parserContext.getReaderContext().error("You must specify a step", partitionElement);
+ return;
+ }
+
+ if (StringUtils.hasText(stepRef)) {
+ propertyValues.addPropertyValue("step", new RuntimeBeanReference(stepRef));
+ }
+ else if (inlineStepElement != null) {
+ AbstractBeanDefinition stepDefinition = parseStep(inlineStepElement, parserContext, jobFactoryRef);
+ stepDefinition.getPropertyValues().addPropertyValue("name", stepElement.getAttribute(ID_ATTR));
+ propertyValues.addPropertyValue("step", stepDefinition);
+ }
+
+ }
+
+ private void parseJob(Element jobElement, AbstractBeanDefinition bd, ParserContext parserContext) {
+
+ bd.setBeanClass(StepParserStepFactoryBean.class);
+ bd.setAttribute("isNamespaceStep", true);
+ String jobRef = jobElement.getAttribute(REF_ATTR);
+
+ if (!StringUtils.hasText(jobRef)) {
+ parserContext.getReaderContext().error("You must specify a job", jobElement);
+ return;
+ }
+
+ MutablePropertyValues propertyValues = bd.getPropertyValues();
+ propertyValues.addPropertyValue("job", new RuntimeBeanReference(jobRef));
+
+ String jobParametersExtractor = jobElement.getAttribute(JOB_PARAMS_EXTRACTOR_ATTR);
+ String jobLauncher = jobElement.getAttribute(JOB_LAUNCHER_ATTR);
+
+ if (StringUtils.hasText(jobParametersExtractor)) {
+ propertyValues.addPropertyValue("jobParametersExtractor", new RuntimeBeanReference(jobParametersExtractor));
+ }
+ if (StringUtils.hasText(jobLauncher)) {
+ propertyValues.addPropertyValue("jobLauncher", new RuntimeBeanReference(jobLauncher));
+ }
+
+ }
+
+ private void parseFlow(Element stepElement, Element flowElement, AbstractBeanDefinition bd) {
+
+ bd.setBeanClass(StepParserStepFactoryBean.class);
+ bd.setAttribute("isNamespaceStep", true);
+ String flowRef = flowElement.getAttribute(PARENT_ATTR);
+ String idAttribute = stepElement.getAttribute(ID_ATTR);
+
+ BeanDefinition flowDefinition = new GenericBeanDefinition();
+ flowDefinition.setParentName(flowRef);
+ MutablePropertyValues propertyValues = flowDefinition.getPropertyValues();
+ if (StringUtils.hasText(idAttribute)) {
+ propertyValues.addPropertyValue("name", idAttribute);
+ }
+
+ bd.getPropertyValues().addPropertyValue("flow", flowDefinition);
+
+ }
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/BeanDefinitionUtils.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/BeanDefinitionUtils.java
index b864f253f5..f2711b24b1 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/BeanDefinitionUtils.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/BeanDefinitionUtils.java
@@ -1,49 +1,56 @@
-/*
- * Copyright 2006-2007 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
- *
- * http://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.core.configuration.xml;
-
-import org.springframework.beans.PropertyValue;
-import org.springframework.beans.factory.BeanFactory;
-import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
-
-/**
- * @author Dan Garrette
- * @since 2.0.1
- */
-public class BeanDefinitionUtils {
-
- /**
- * @param beanName a bean definition name
- * @param propertyName the name of the property
- * @param beanFactory a {@link BeanFactory}
- * @return The {@link PropertyValue} for the property of the bean. Search
- * parent hierarchy if necessary. Return null if none is found.
- */
- public static PropertyValue getPropertyValue(String beanName, String propertyName, ConfigurableListableBeanFactory beanFactory) {
- return beanFactory.getMergedBeanDefinition(beanName).getPropertyValues().getPropertyValue(propertyName);
- }
-
- /**
- * @param beanName a bean definition name
- * @param attributeName the name of the property
- * @param beanFactory a {@link BeanFactory}
- * @return The value for the attribute of the bean. Search parent hierarchy
- * if necessary. Return null if none is found.
- */
- public static Object getAttribute(String beanName, String attributeName, ConfigurableListableBeanFactory beanFactory) {
- return beanFactory.getMergedBeanDefinition(beanName).getAttribute(attributeName);
- }
-}
+/*
+ * Copyright 2006-2024 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.core.configuration.xml;
+
+import org.springframework.beans.PropertyValue;
+import org.springframework.beans.factory.BeanFactory;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
+
+/**
+ * @author Dan Garrette
+ * @author Taeik Lim
+ * @since 2.0.1
+ */
+public abstract class BeanDefinitionUtils {
+
+ private BeanDefinitionUtils() {
+ }
+
+ /**
+ * @param beanName a bean definition name
+ * @param propertyName the name of the property
+ * @param beanFactory a {@link BeanFactory}
+ * @return The {@link PropertyValue} for the property of the bean. Search parent
+ * hierarchy if necessary. Return null if none is found.
+ */
+ public static PropertyValue getPropertyValue(String beanName, String propertyName,
+ ConfigurableListableBeanFactory beanFactory) {
+ return beanFactory.getMergedBeanDefinition(beanName).getPropertyValues().getPropertyValue(propertyName);
+ }
+
+ /**
+ * @param beanName a bean definition name
+ * @param attributeName the name of the property
+ * @param beanFactory a {@link BeanFactory}
+ * @return The value for the attribute of the bean. Search parent hierarchy if
+ * necessary. Return null if none is found.
+ */
+ public static Object getAttribute(String beanName, String attributeName,
+ ConfigurableListableBeanFactory beanFactory) {
+ return beanFactory.getMergedBeanDefinition(beanName).getAttribute(attributeName);
+ }
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ChunkElementParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ChunkElementParser.java
index c2e01e72db..8494fe6b1b 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ChunkElementParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ChunkElementParser.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2009 the original author or authors.
+ * Copyright 2006-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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -20,7 +20,8 @@
import org.w3c.dom.Element;
import org.springframework.batch.core.listener.StepListenerMetaData;
-import org.springframework.batch.repeat.policy.SimpleCompletionPolicy;
+import org.springframework.batch.infrastructure.item.adapter.AbstractMethodInvokingDelegator;
+import org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy;
import org.springframework.beans.BeanMetadataElement;
import org.springframework.beans.MutablePropertyValues;
import org.springframework.beans.factory.config.BeanDefinition;
@@ -40,8 +41,9 @@
/**
* Internal parser for the <chunk/> element inside a step.
- *
+ *
* @author Thomas Risberg
+ * @author Mahmoud Ben Hassine
* @since 2.0
*/
public class ChunkElementParser {
@@ -58,23 +60,25 @@ public class ChunkElementParser {
private static final String REF_ELE = "ref";
- private static final String ITEM_READER_ADAPTER_CLASS = "org.springframework.batch.item.adapter.ItemReaderAdapter";
+ private static final String ITEM_READER_ADAPTER_CLASS = "org.springframework.batch.infrastructure.item.adapter.ItemReaderAdapter";
- private static final String ITEM_PROCESSOR_ADAPTER_CLASS = "org.springframework.batch.item.adapter.ItemProcessorAdapter";
+ private static final String ITEM_PROCESSOR_ADAPTER_CLASS = "org.springframework.batch.infrastructure.item.adapter.ItemProcessorAdapter";
- private static final String ITEM_WRITER_ADAPTER_CLASS = "org.springframework.batch.item.adapter.ItemWriterAdapter";
+ private static final String ITEM_WRITER_ADAPTER_CLASS = "org.springframework.batch.infrastructure.item.adapter.ItemWriterAdapter";
private static final StepListenerParser stepListenerParser = new StepListenerParser(
StepListenerMetaData.itemListenerMetaData());
/**
- * @param bd {@link AbstractBeanDefinition} instance of the containing bean.
- * @param element the element to parse
- * @param parserContext the context to use
- * @param underspecified if true, a fatal error will not be raised if attribute
- * or element is missing.
+ * Do the parsing.
+ * @param bd An {@link AbstractBeanDefinition} instance of the containing bean.
+ * @param element The element to parse
+ * @param parserContext The context to use
+ * @param underspecified If true, a fatal error is not raised if the attribute or the
+ * element is missing.
*/
- protected void parse(Element element, AbstractBeanDefinition bd, ParserContext parserContext, boolean underspecified) {
+ protected void parse(Element element, AbstractBeanDefinition bd, ParserContext parserContext,
+ boolean underspecified) {
MutablePropertyValues propertyValues = bd.getPropertyValues();
@@ -92,7 +96,7 @@ protected void parse(Element element, AbstractBeanDefinition bd, ParserContext p
if (commitInterval.startsWith("#")) {
// It's a late binding expression, so we need step scope...
BeanDefinitionBuilder completionPolicy = BeanDefinitionBuilder
- .genericBeanDefinition(SimpleCompletionPolicy.class);
+ .genericBeanDefinition(SimpleCompletionPolicy.class);
completionPolicy.addConstructorArgValue(commitInterval);
completionPolicy.setScope("step");
propertyValues.addPropertyValue("chunkCompletionPolicy", completionPolicy.getBeanDefinition());
@@ -111,21 +115,21 @@ protected void parse(Element element, AbstractBeanDefinition bd, ParserContext p
if (!underspecified
&& propertyValues.contains("commitInterval") == propertyValues.contains("chunkCompletionPolicy")) {
if (propertyValues.contains("commitInterval")) {
- parserContext.getReaderContext().error(
- "The <" + element.getNodeName() + "/> element must contain either '" + COMMIT_INTERVAL_ATTR
- + "' " + "or '" + CHUNK_COMPLETION_POLICY_ATTR + "', but not both.", element);
+ parserContext.getReaderContext()
+ .error("The <" + element.getNodeName() + "/> element must contain either '" + COMMIT_INTERVAL_ATTR
+ + "' " + "or '" + CHUNK_COMPLETION_POLICY_ATTR + "', but not both.", element);
}
else {
- parserContext.getReaderContext().error(
- "The <" + element.getNodeName() + "/> element must contain either '" + COMMIT_INTERVAL_ATTR
- + "' " + "or '" + CHUNK_COMPLETION_POLICY_ATTR + "'.", element);
+ parserContext.getReaderContext()
+ .error("The <" + element.getNodeName() + "/> element must contain either '" + COMMIT_INTERVAL_ATTR
+ + "' " + "or '" + CHUNK_COMPLETION_POLICY_ATTR + "'.", element);
}
}
String skipLimit = element.getAttribute("skip-limit");
- ManagedMap skippableExceptions =
- new ExceptionElementParser().parse(element, parserContext, "skippable-exception-classes");
+ ManagedMap skippableExceptions = new ExceptionElementParser().parse(element,
+ parserContext, "skippable-exception-classes");
if (StringUtils.hasText(skipLimit)) {
if (skippableExceptions == null) {
skippableExceptions = new ManagedMap<>();
@@ -134,11 +138,12 @@ protected void parse(Element element, AbstractBeanDefinition bd, ParserContext p
propertyValues.addPropertyValue("skipLimit", skipLimit);
}
if (skippableExceptions != null) {
- List exceptionClassElements = DomUtils.getChildElementsByTagName(element, "skippable-exception-classes");
+ List exceptionClassElements = DomUtils.getChildElementsByTagName(element,
+ "skippable-exception-classes");
- if(!CollectionUtils.isEmpty(exceptionClassElements)) {
+ if (!CollectionUtils.isEmpty(exceptionClassElements)) {
skippableExceptions.setMergeEnabled(exceptionClassElements.get(0).hasAttribute(MERGE_ATTR)
- && Boolean.valueOf(exceptionClassElements.get(0).getAttribute(MERGE_ATTR)));
+ && Boolean.parseBoolean(exceptionClassElements.get(0).getAttribute(MERGE_ATTR)));
}
// Even if there is no retryLimit, we can still accept exception
// classes for an abstract parent bean definition
@@ -149,8 +154,8 @@ protected void parse(Element element, AbstractBeanDefinition bd, ParserContext p
underspecified);
String retryLimit = element.getAttribute("retry-limit");
- ManagedMap retryableExceptions =
- new ExceptionElementParser().parse(element, parserContext, "retryable-exception-classes");
+ ManagedMap retryableExceptions = new ExceptionElementParser().parse(element,
+ parserContext, "retryable-exception-classes");
if (StringUtils.hasText(retryLimit)) {
if (retryableExceptions == null) {
retryableExceptions = new ManagedMap<>();
@@ -159,11 +164,12 @@ protected void parse(Element element, AbstractBeanDefinition bd, ParserContext p
propertyValues.addPropertyValue("retryLimit", retryLimit);
}
if (retryableExceptions != null) {
- List exceptionClassElements = DomUtils.getChildElementsByTagName(element, "retryable-exception-classes");
+ List exceptionClassElements = DomUtils.getChildElementsByTagName(element,
+ "retryable-exception-classes");
- if(!CollectionUtils.isEmpty(exceptionClassElements)) {
+ if (!CollectionUtils.isEmpty(exceptionClassElements)) {
retryableExceptions.setMergeEnabled(exceptionClassElements.get(0).hasAttribute(MERGE_ATTR)
- && Boolean.valueOf(exceptionClassElements.get(0).getAttribute(MERGE_ATTR)));
+ && Boolean.parseBoolean(exceptionClassElements.get(0).getAttribute(MERGE_ATTR)));
}
// Even if there is no retryLimit, we can still accept exception
// classes for an abstract parent bean definition
@@ -197,52 +203,55 @@ protected void parse(Element element, AbstractBeanDefinition bd, ParserContext p
}
/**
- * Handle the ItemReader, ItemProcessor, and ItemWriter attributes/elements.
+ * Handle the ItemReader, ItemProcessor, and ItemWriter attributes and elements.
*/
- private void handleItemHandler(AbstractBeanDefinition enclosing, String handlerName, String propertyName, String adapterClassName, boolean required,
- Element element, ParserContext parserContext, MutablePropertyValues propertyValues, boolean underspecified) {
+ private void handleItemHandler(AbstractBeanDefinition enclosing, String handlerName, String propertyName,
+ String adapterClassName, boolean required, Element element, ParserContext parserContext,
+ MutablePropertyValues propertyValues, boolean underspecified) {
String refName = element.getAttribute(handlerName);
List children = DomUtils.getChildElementsByTagName(element, handlerName);
if (children.size() == 1) {
if (StringUtils.hasText(refName)) {
- parserContext.getReaderContext().error(
- "The <" + element.getNodeName() + "/> element may not have both a '" + handlerName
- + "' attribute and a <" + handlerName + "/> element.", element);
+ parserContext.getReaderContext()
+ .error("The <" + element.getNodeName() + "/> element may not have both a '" + handlerName
+ + "' attribute and a <" + handlerName + "/> element.", element);
}
- handleItemHandlerElement(enclosing, propertyName, adapterClassName, propertyValues, children.get(0), parserContext);
+ handleItemHandlerElement(enclosing, propertyName, adapterClassName, propertyValues, children.get(0),
+ parserContext);
}
else if (children.size() > 1) {
- parserContext.getReaderContext().error(
- "The <" + handlerName + "/> element may not appear more than once in a single <"
- + element.getNodeName() + "/>.", element);
+ parserContext.getReaderContext()
+ .error("The <" + handlerName + "/> element may not appear more than once in a single <"
+ + element.getNodeName() + "/>.", element);
}
else if (StringUtils.hasText(refName)) {
propertyValues.addPropertyValue(propertyName, new RuntimeBeanReference(refName));
}
else if (required && !underspecified) {
- parserContext.getReaderContext().error(
- "The <" + element.getNodeName() + "/> element has neither a '" + handlerName
- + "' attribute nor a <" + handlerName + "/> element.", element);
+ parserContext.getReaderContext()
+ .error("The <" + element.getNodeName() + "/> element has neither a '" + handlerName
+ + "' attribute nor a <" + handlerName + "/> element.", element);
}
}
/**
- * Handle the <reader/>, <processor/>, or <writer/> that
- * is defined within the item handler.
+ * Handle the <reader/>, <processor/>, or <writer/> that is defined
+ * within the item handler.
*/
- private void handleItemHandlerElement(AbstractBeanDefinition enclosing, String propertyName, String adapterClassName,
- MutablePropertyValues propertyValues, Element element, ParserContext parserContext) {
+ private void handleItemHandlerElement(AbstractBeanDefinition enclosing, String propertyName,
+ String adapterClassName, MutablePropertyValues propertyValues, Element element,
+ ParserContext parserContext) {
List beanElements = DomUtils.getChildElementsByTagName(element, BEAN_ELE);
List refElements = DomUtils.getChildElementsByTagName(element, REF_ELE);
if (beanElements.size() + refElements.size() != 1) {
- parserContext.getReaderContext().error(
- "The <" + element.getNodeName() + "/> must have exactly one of either a <" + BEAN_ELE
- + "/> element or a <" + REF_ELE + "/> element.", element);
+ parserContext.getReaderContext()
+ .error("The <" + element.getNodeName() + "/> must have exactly one of either a <" + BEAN_ELE
+ + "/> element or a <" + REF_ELE + "/> element.", element);
}
else if (beanElements.size() == 1) {
Element beanElement = beanElements.get(0);
- BeanDefinitionHolder beanDefinitionHolder = parserContext.getDelegate().parseBeanDefinitionElement(
- beanElement, enclosing);
+ BeanDefinitionHolder beanDefinitionHolder = parserContext.getDelegate()
+ .parseBeanDefinitionElement(beanElement, enclosing);
parserContext.getDelegate().decorateBeanDefinitionIfRequired(beanElement, beanDefinitionHolder);
propertyValues.addPropertyValue(propertyName, beanDefinitionHolder);
@@ -256,8 +265,8 @@ else if (refElements.size() == 1) {
}
/**
- * Handle the adapter-method attribute by using an
- * AbstractMethodInvokingDelegator
+ * Handle the adapter method attribute by using an
+ * {@link AbstractMethodInvokingDelegator}.
*/
private void handleAdapterMethodAttribute(String propertyName, String adapterClassName,
MutablePropertyValues stepPvs, Element element) {
@@ -289,15 +298,15 @@ private void handleRetryListenersElement(Element element, MutablePropertyValues
parserContext.pushContainingComponent(compositeDef);
ManagedList retryListenerBeans = new ManagedList<>();
retryListenerBeans.setMergeEnabled(listenersElement.hasAttribute(MERGE_ATTR)
- && Boolean.valueOf(listenersElement.getAttribute(MERGE_ATTR)));
+ && Boolean.parseBoolean(listenersElement.getAttribute(MERGE_ATTR)));
handleRetryListenerElements(parserContext, listenersElement, retryListenerBeans, enclosing);
propertyValues.addPropertyValue("retryListeners", retryListenerBeans);
parserContext.popAndRegisterContainingComponent();
}
}
- private void handleRetryListenerElements(ParserContext parserContext, Element element, ManagedList beans,
- BeanDefinition enclosing) {
+ private void handleRetryListenerElements(ParserContext parserContext, Element element,
+ ManagedList beans, BeanDefinition enclosing) {
List listenerElements = DomUtils.getChildElementsByTagName(element, "listener");
if (listenerElements != null) {
for (Element listenerElement : listenerElements) {
@@ -306,12 +315,13 @@ private void handleRetryListenerElements(ParserContext parserContext, Element el
}
}
- private void handleStreamsElement(Element element, MutablePropertyValues propertyValues, ParserContext parserContext) {
+ private void handleStreamsElement(Element element, MutablePropertyValues propertyValues,
+ ParserContext parserContext) {
Element streamsElement = DomUtils.getChildElementByTagName(element, "streams");
if (streamsElement != null) {
ManagedList streamBeans = new ManagedList<>();
streamBeans.setMergeEnabled(streamsElement.hasAttribute(MERGE_ATTR)
- && Boolean.valueOf(streamsElement.getAttribute(MERGE_ATTR)));
+ && Boolean.parseBoolean(streamsElement.getAttribute(MERGE_ATTR)));
List streamElements = DomUtils.getChildElementsByTagName(streamsElement, "stream");
if (streamElements != null) {
for (Element streamElement : streamElements) {
@@ -320,8 +330,9 @@ private void handleStreamsElement(Element element, MutablePropertyValues propert
streamBeans.add(new RuntimeBeanReference(streamRef));
}
else {
- parserContext.getReaderContext().error(
- REF_ATTR + " not specified for <" + streamElement.getTagName() + "> element", element);
+ parserContext.getReaderContext()
+ .error(REF_ATTR + " not specified for <" + streamElement.getTagName() + "> element",
+ element);
}
}
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespaceHandler.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespaceHandler.java
index 53890ac24c..6ea155c717 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespaceHandler.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespaceHandler.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2013 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -15,22 +15,28 @@
*/
package org.springframework.batch.core.configuration.xml;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
import org.springframework.beans.factory.xml.NamespaceHandler;
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
/**
- *
- *
* @author Dave Syer
+ * @author Mahmoud Ben Hassine
*
*/
public class CoreNamespaceHandler extends NamespaceHandlerSupport {
+ private static final Log LOGGER = LogFactory.getLog(CoreNamespaceHandler.class);
+
/**
* @see NamespaceHandler#init()
*/
@Override
public void init() {
+ LOGGER.info(
+ "DEPRECATION NOTE: The batch XML namespace is deprecated as of Spring Batch 6.0 and will be removed in version 7.0.");
this.registerBeanDefinitionParser("job", new JobParser());
this.registerBeanDefinitionParser("flow", new TopLevelFlowParser());
this.registerBeanDefinitionParser("step", new TopLevelStepParser());
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespacePostProcessor.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespacePostProcessor.java
index 47e2c8b3a9..cbaed045bb 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespacePostProcessor.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespacePostProcessor.java
@@ -1,153 +1,148 @@
-/*
- * Copyright 2006-2013 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
- *
- * http://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.core.configuration.xml;
-
-import org.springframework.batch.core.repository.JobRepository;
-import org.springframework.batch.core.step.AbstractStep;
-import org.springframework.beans.BeansException;
-import org.springframework.beans.MutablePropertyValues;
-import org.springframework.beans.PropertyValue;
-import org.springframework.beans.factory.config.BeanDefinition;
-import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
-import org.springframework.beans.factory.config.BeanPostProcessor;
-import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
-import org.springframework.beans.factory.config.RuntimeBeanReference;
-import org.springframework.beans.factory.support.AbstractBeanDefinition;
-import org.springframework.context.ApplicationContext;
-import org.springframework.context.ApplicationContextAware;
-import org.springframework.transaction.PlatformTransactionManager;
-
-/**
- * Post-process jobs and steps defined using the batch namespace to inject
- * dependencies.
- *
- * @author Dan Garrette
- * @since 2.0.1
- */
-public class CoreNamespacePostProcessor implements BeanPostProcessor, BeanFactoryPostProcessor, ApplicationContextAware {
-
- private static final String DEFAULT_JOB_REPOSITORY_NAME = "jobRepository";
-
- private static final String DEFAULT_TRANSACTION_MANAGER_NAME = "transactionManager";
-
- private static final String JOB_FACTORY_PROPERTY_NAME = "jobParserJobFactoryBeanRef";
-
- private static final String JOB_REPOSITORY_PROPERTY_NAME = "jobRepository";
-
- private ApplicationContext applicationContext;
-
- @Override
- public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
- for (String beanName : beanFactory.getBeanDefinitionNames()) {
- injectJobRepositoryIntoSteps(beanName, beanFactory);
- overrideStepClass(beanName, beanFactory);
- }
- }
-
- /**
- * Automatically inject job-repository from a job into its steps. Only
- * inject if the step is an AbstractStep or StepParserStepFactoryBean.
- *
- * @param beanName
- * @param beanFactory
- */
- private void injectJobRepositoryIntoSteps(String beanName, ConfigurableListableBeanFactory beanFactory) {
- BeanDefinition bd = beanFactory.getBeanDefinition(beanName);
- if (bd.hasAttribute(JOB_FACTORY_PROPERTY_NAME)) {
- MutablePropertyValues pvs = bd.getPropertyValues();
- if (beanFactory.isTypeMatch(beanName, AbstractStep.class)) {
- String jobName = (String) bd.getAttribute(JOB_FACTORY_PROPERTY_NAME);
- PropertyValue jobRepository = BeanDefinitionUtils.getPropertyValue(jobName,
- JOB_REPOSITORY_PROPERTY_NAME, beanFactory);
- if (jobRepository != null) {
- // Set the job's JobRepository onto the step
- pvs.addPropertyValue(jobRepository);
- }
- else {
- // No JobRepository found, so inject the default
- RuntimeBeanReference jobRepositoryBeanRef = new RuntimeBeanReference(DEFAULT_JOB_REPOSITORY_NAME);
- pvs.addPropertyValue(JOB_REPOSITORY_PROPERTY_NAME, jobRepositoryBeanRef);
- }
- }
- }
- }
-
- /**
- * If any of the beans in the parent hierarchy is a <step/> with a
- * <tasklet/>, then the bean class must be
- * {@link StepParserStepFactoryBean}.
- *
- * @param beanName
- * @param beanFactory
- */
- private void overrideStepClass(String beanName, ConfigurableListableBeanFactory beanFactory) {
- BeanDefinition bd = beanFactory.getBeanDefinition(beanName);
- Object isNamespaceStep = BeanDefinitionUtils
- .getAttribute(beanName, "isNamespaceStep", beanFactory);
- if (isNamespaceStep != null && (Boolean) isNamespaceStep == true) {
- ((AbstractBeanDefinition) bd).setBeanClass(StepParserStepFactoryBean.class);
- }
- }
-
- @Override
- public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
- return injectDefaults(bean);
- }
-
- /**
- * Inject defaults into factory beans.
- *
- *
- *
- * @param bean
- * @return
- */
- private Object injectDefaults(Object bean) {
- if (bean instanceof JobParserJobFactoryBean) {
- JobParserJobFactoryBean fb = (JobParserJobFactoryBean) bean;
- JobRepository jobRepository = fb.getJobRepository();
- if (jobRepository == null) {
- fb.setJobRepository((JobRepository) applicationContext.getBean(DEFAULT_JOB_REPOSITORY_NAME));
- }
- } else if (bean instanceof StepParserStepFactoryBean) {
- StepParserStepFactoryBean fb = (StepParserStepFactoryBean) bean;
- JobRepository jobRepository = fb.getJobRepository();
- if (jobRepository == null) {
- fb.setJobRepository((JobRepository) applicationContext.getBean(DEFAULT_JOB_REPOSITORY_NAME));
- }
- PlatformTransactionManager transactionManager = fb.getTransactionManager();
- if (transactionManager == null && fb.requiresTransactionManager()) {
- fb.setTransactionManager((PlatformTransactionManager) applicationContext
- .getBean(DEFAULT_TRANSACTION_MANAGER_NAME));
- }
- }
- return bean;
- }
-
- @Override
- public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
- return bean;
- }
-
- @Override
- public void setApplicationContext(ApplicationContext applicationContext) {
- this.applicationContext = applicationContext;
- }
-}
+/*
+ * 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.
+ * 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.core.configuration.xml;
+
+import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.batch.core.step.AbstractStep;
+import org.springframework.beans.BeansException;
+import org.springframework.beans.MutablePropertyValues;
+import org.springframework.beans.PropertyValue;
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
+import org.springframework.beans.factory.config.BeanPostProcessor;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
+import org.springframework.beans.factory.config.RuntimeBeanReference;
+import org.springframework.beans.factory.support.AbstractBeanDefinition;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.transaction.PlatformTransactionManager;
+
+/**
+ * Post-process jobs and steps defined using the batch namespace to inject dependencies.
+ *
+ * @author Dan Garrette
+ * @since 2.0.1
+ */
+public class CoreNamespacePostProcessor
+ implements BeanPostProcessor, BeanFactoryPostProcessor, ApplicationContextAware {
+
+ private static final String DEFAULT_JOB_REPOSITORY_NAME = "jobRepository";
+
+ private static final String DEFAULT_TRANSACTION_MANAGER_NAME = "transactionManager";
+
+ private static final String JOB_FACTORY_PROPERTY_NAME = "jobParserJobFactoryBeanRef";
+
+ private static final String JOB_REPOSITORY_PROPERTY_NAME = "jobRepository";
+
+ private ApplicationContext applicationContext;
+
+ @Override
+ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
+ for (String beanName : beanFactory.getBeanDefinitionNames()) {
+ injectJobRepositoryIntoSteps(beanName, beanFactory);
+ overrideStepClass(beanName, beanFactory);
+ }
+ }
+
+ /**
+ * Automatically inject job-repository from a job into its steps. Only inject if the
+ * step is an AbstractStep or StepParserStepFactoryBean.
+ * @param beanName the bean name
+ * @param beanFactory the bean factory
+ */
+ private void injectJobRepositoryIntoSteps(String beanName, ConfigurableListableBeanFactory beanFactory) {
+ BeanDefinition bd = beanFactory.getBeanDefinition(beanName);
+ if (bd.hasAttribute(JOB_FACTORY_PROPERTY_NAME)) {
+ MutablePropertyValues pvs = bd.getPropertyValues();
+ if (beanFactory.isTypeMatch(beanName, AbstractStep.class)) {
+ String jobName = (String) bd.getAttribute(JOB_FACTORY_PROPERTY_NAME);
+ PropertyValue jobRepository = BeanDefinitionUtils.getPropertyValue(jobName,
+ JOB_REPOSITORY_PROPERTY_NAME, beanFactory);
+ if (jobRepository != null) {
+ // Set the job's JobRepository onto the step
+ pvs.addPropertyValue(jobRepository);
+ }
+ else {
+ // No JobRepository found, so inject the default
+ RuntimeBeanReference jobRepositoryBeanRef = new RuntimeBeanReference(DEFAULT_JOB_REPOSITORY_NAME);
+ pvs.addPropertyValue(JOB_REPOSITORY_PROPERTY_NAME, jobRepositoryBeanRef);
+ }
+ }
+ }
+ }
+
+ /**
+ * If any of the beans in the parent hierarchy is a <step/> with a
+ * <tasklet/>, then the bean class must be {@link StepParserStepFactoryBean}.
+ * @param beanName the bean name
+ * @param beanFactory the bean factory
+ */
+ private void overrideStepClass(String beanName, ConfigurableListableBeanFactory beanFactory) {
+ BeanDefinition bd = beanFactory.getBeanDefinition(beanName);
+ Object isNamespaceStep = BeanDefinitionUtils.getAttribute(beanName, "isNamespaceStep", beanFactory);
+ if (isNamespaceStep != null && (Boolean) isNamespaceStep) {
+ ((AbstractBeanDefinition) bd).setBeanClass(StepParserStepFactoryBean.class);
+ }
+ }
+
+ @Override
+ public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
+ return injectDefaults(bean);
+ }
+
+ /**
+ * Inject defaults into factory beans.
+ *
+ *
+ * @param bean the bean object
+ * @return the bean with default collaborators injected into it
+ */
+ private Object injectDefaults(Object bean) {
+ if (bean instanceof JobParserJobFactoryBean fb) {
+ JobRepository jobRepository = fb.getJobRepository();
+ if (jobRepository == null) {
+ fb.setJobRepository(applicationContext.getBean(DEFAULT_JOB_REPOSITORY_NAME, JobRepository.class));
+ }
+ }
+ else if (bean instanceof StepParserStepFactoryBean fb) {
+ JobRepository jobRepository = fb.getJobRepository();
+ if (jobRepository == null) {
+ fb.setJobRepository(applicationContext.getBean(DEFAULT_JOB_REPOSITORY_NAME, JobRepository.class));
+ }
+ PlatformTransactionManager transactionManager = fb.getTransactionManager();
+ if (transactionManager == null && fb.requiresTransactionManager()) {
+ fb.setTransactionManager(
+ applicationContext.getBean(DEFAULT_TRANSACTION_MANAGER_NAME, PlatformTransactionManager.class));
+ }
+ }
+ return bean;
+ }
+
+ @Override
+ public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
+ return bean;
+ }
+
+ @Override
+ public void setApplicationContext(ApplicationContext applicationContext) {
+ this.applicationContext = applicationContext;
+ }
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespaceUtils.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespaceUtils.java
index ca37316fc0..d585b2487d 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespaceUtils.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/CoreNamespaceUtils.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2013 the original author or authors.
+ * Copyright 2006-2024 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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -32,18 +32,23 @@
import java.util.Map;
/**
- * Utility methods used in parsing of the batch core namespace
+ * Utility methods used in parsing of the batch core namespace.
*
* @author Thomas Risberg
* @author Michael Minella
+ * @author Mahmoud Ben Hassine
+ * @author Taeik Lim
*/
-public class CoreNamespaceUtils {
+public abstract class CoreNamespaceUtils {
+
+ private CoreNamespaceUtils() {
+ }
private static final String STEP_SCOPE_PROCESSOR_BEAN_NAME = "org.springframework.batch.core.scope.internalStepScope";
private static final String XML_CONFIG_STEP_SCOPE_PROCESSOR_CLASS_NAME = "org.springframework.batch.core.scope.StepScope";
- private static final String JAVA_CONFIG_SCOPE_CLASS_NAME = "org.springframework.batch.core.configuration.annotation.ScopeConfiguration";
+ private static final String JAVA_CONFIG_SCOPE_CLASS_NAME = "org.springframework.batch.core.configuration.support.ScopeConfiguration";
private static final String JOB_SCOPE_PROCESSOR_BEAN_NAME = "org.springframework.batch.core.scope.internalJobScope";
@@ -51,12 +56,17 @@ public class CoreNamespaceUtils {
private static final String CUSTOM_EDITOR_CONFIGURER_CLASS_NAME = "org.springframework.beans.factory.config.CustomEditorConfigurer";
- private static final String RANGE_ARRAY_CLASS_NAME = "org.springframework.batch.item.file.transform.Range[]";
+ private static final String RANGE_ARRAY_CLASS_NAME = "org.springframework.batch.infrastructure.item.file.transform.Range[]";
- private static final String RANGE_ARRAY_EDITOR_CLASS_NAME = "org.springframework.batch.item.file.transform.RangeArrayPropertyEditor";
+ private static final String RANGE_ARRAY_EDITOR_CLASS_NAME = "org.springframework.batch.infrastructure.item.file.transform.RangeArrayPropertyEditor";
private static final String CORE_NAMESPACE_POST_PROCESSOR_CLASS_NAME = "org.springframework.batch.core.configuration.xml.CoreNamespacePostProcessor";
+ /**
+ * Create the beans based on the content of the source.
+ * @param parserContext The parser context to be used.
+ * @param source The source for the auto registration.
+ */
public static void autoregisterBeansForNamespace(ParserContext parserContext, Object source) {
checkForStepScope(parserContext, source);
checkForJobScope(parserContext, source);
@@ -66,7 +76,8 @@ public static void autoregisterBeansForNamespace(ParserContext parserContext, Ob
}
private static void checkForStepScope(ParserContext parserContext, Object source) {
- checkForScope(parserContext, source, XML_CONFIG_STEP_SCOPE_PROCESSOR_CLASS_NAME, STEP_SCOPE_PROCESSOR_BEAN_NAME);
+ checkForScope(parserContext, source, XML_CONFIG_STEP_SCOPE_PROCESSOR_CLASS_NAME,
+ STEP_SCOPE_PROCESSOR_BEAN_NAME);
}
private static void checkForJobScope(ParserContext parserContext, Object source) {
@@ -79,14 +90,14 @@ private static void checkForScope(ParserContext parserContext, Object source, St
String[] beanNames = parserContext.getRegistry().getBeanDefinitionNames();
for (String beanName : beanNames) {
BeanDefinition bd = parserContext.getRegistry().getBeanDefinition(beanName);
- if (scopeClassName.equals(bd.getBeanClassName()) || JAVA_CONFIG_SCOPE_CLASS_NAME.equals(bd.getBeanClassName())) {
+ if (scopeClassName.equals(bd.getBeanClassName())
+ || JAVA_CONFIG_SCOPE_CLASS_NAME.equals(bd.getBeanClassName())) {
foundScope = true;
break;
}
}
if (!foundScope) {
- BeanDefinitionBuilder stepScopeBuilder = BeanDefinitionBuilder
- .genericBeanDefinition(scopeClassName);
+ BeanDefinitionBuilder stepScopeBuilder = BeanDefinitionBuilder.genericBeanDefinition(scopeClassName);
AbstractBeanDefinition abd = stepScopeBuilder.getBeanDefinition();
abd.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
abd.setSource(source);
@@ -95,16 +106,17 @@ private static void checkForScope(ParserContext parserContext, Object source, St
}
/**
- * Register a {@link Comparator} to be used to sort {@link StateTransition}s
- *
- * @param parserContext
+ * Register a {@link Comparator} to be used to sort {@link StateTransition} objects.
+ * @param parserContext the parser context
*/
private static void addStateTransitionComparator(ParserContext parserContext) {
BeanDefinitionRegistry registry = parserContext.getRegistry();
if (!stateTransitionComparatorAlreadyDefined(registry)) {
- AbstractBeanDefinition defaultStateTransitionComparator = BeanDefinitionBuilder.genericBeanDefinition(
- DefaultStateTransitionComparator.class).getBeanDefinition();
- registry.registerBeanDefinition(DefaultStateTransitionComparator.STATE_TRANSITION_COMPARATOR, defaultStateTransitionComparator);
+ AbstractBeanDefinition defaultStateTransitionComparator = BeanDefinitionBuilder
+ .genericBeanDefinition(DefaultStateTransitionComparator.class)
+ .getBeanDefinition();
+ registry.registerBeanDefinition(DefaultStateTransitionComparator.STATE_TRANSITION_COMPARATOR,
+ defaultStateTransitionComparator);
}
}
@@ -113,15 +125,15 @@ private static boolean stateTransitionComparatorAlreadyDefined(BeanDefinitionReg
}
/**
- * Register a RangePropertyEditor if one does not already exist.
- *
- * @param parserContext
+ * Register a {@code RangePropertyEditor}, if one does not already exist.
+ * @param parserContext the parser context
*/
private static void addRangePropertyEditor(ParserContext parserContext) {
BeanDefinitionRegistry registry = parserContext.getRegistry();
if (!rangeArrayEditorAlreadyDefined(registry)) {
- AbstractBeanDefinition customEditorConfigurer = BeanDefinitionBuilder.genericBeanDefinition(
- CUSTOM_EDITOR_CONFIGURER_CLASS_NAME).getBeanDefinition();
+ AbstractBeanDefinition customEditorConfigurer = BeanDefinitionBuilder
+ .genericBeanDefinition(CUSTOM_EDITOR_CONFIGURER_CLASS_NAME)
+ .getBeanDefinition();
customEditorConfigurer.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
ManagedMap editors = new ManagedMap<>();
editors.put(RANGE_ARRAY_CLASS_NAME, RANGE_ARRAY_EDITOR_CLASS_NAME);
@@ -155,13 +167,15 @@ else if (entry.getKey() instanceof String) {
}
/**
- * @param parserContext
+ * Add a core name postprocessor.
+ * @param parserContext the parser context
*/
private static void addCoreNamespacePostProcessor(ParserContext parserContext) {
BeanDefinitionRegistry registry = parserContext.getRegistry();
if (!coreNamespaceBeanPostProcessorAlreadyDefined(registry)) {
- AbstractBeanDefinition postProcessorBeanDef = BeanDefinitionBuilder.genericBeanDefinition(
- CORE_NAMESPACE_POST_PROCESSOR_CLASS_NAME).getBeanDefinition();
+ AbstractBeanDefinition postProcessorBeanDef = BeanDefinitionBuilder
+ .genericBeanDefinition(CORE_NAMESPACE_POST_PROCESSOR_CLASS_NAME)
+ .getBeanDefinition();
postProcessorBeanDef.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
registry.registerBeanDefinition(CORE_NAMESPACE_POST_PROCESSOR_CLASS_NAME, postProcessorBeanDef);
}
@@ -178,34 +192,29 @@ private static boolean coreNamespaceBeanPostProcessorAlreadyDefined(BeanDefiniti
}
/**
- * Should this element be treated as incomplete? If it has a parent or is
- * abstract, then it may not have all properties.
- *
+ * Should this element be treated as incomplete? If it has a parent or is abstract, it
+ * may not have all properties.
* @param element to be evaluated.
- * @return TRUE if the element is abstract or has a parent
+ * @return {@code true} if the element is abstract or has a parent.
*/
public static boolean isUnderspecified(Element element) {
return isAbstract(element) || StringUtils.hasText(element.getAttribute("parent"));
}
/**
- * @param element to be evaluated.
- * @return TRUE if the element is abstract
+ * @param element The element to be evaluated.
+ * @return {@code true} if the element is abstract.
*/
public static boolean isAbstract(Element element) {
String abstractAttr = element.getAttribute("abstract");
- return StringUtils.hasText(abstractAttr) && Boolean.valueOf(abstractAttr);
+ return StringUtils.hasText(abstractAttr) && Boolean.parseBoolean(abstractAttr);
}
/**
- * Check that the schema location declared in the source file being parsed
- * matches the Spring Batch version. (The old 2.0 schema is not 100%
- * compatible with the new parser, so it is an error to explicitly define
- * 2.0. It might be an error to declare spring-batch.xsd as an alias, but
- * you are only going to find that out when one of the sub parses breaks.)
- *
- * @param element the element that is to be parsed next
- * @return true if we find a schema declaration that matches
+ * Check that the schema location declared in the source file being parsed matches the
+ * Spring Batch version.
+ * @param element The element that is to be parsed next.
+ * @return {@code true} if we find a schema declaration that matches.
*/
public static boolean namespaceMatchesVersion(Element element) {
return matchesVersionInternal(element)
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/DecisionParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/DecisionParser.java
index 5fa21668c3..872ff1e07f 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/DecisionParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/DecisionParser.java
@@ -5,7 +5,7 @@
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -24,38 +24,37 @@
import org.w3c.dom.Element;
/**
- * Internal parser for the <decision/> elements inside a job. A decision
- * element references a bean definition for a
- * {@link org.springframework.batch.core.job.flow.JobExecutionDecider}
- * and goes on to list a set of transitions to other states with <next
- * on="pattern" to="stepName"/>. Used by the {@link JobParser}.
- *
+ * Internal parser for the <decision/> elements inside a job. A decision element
+ * references a bean definition for a
+ * {@link org.springframework.batch.core.job.flow.JobExecutionDecider} and goes on to list
+ * a set of transitions to other states with <next on="pattern" to="stepName"/>.
+ * Used by the {@link JobParser}.
+ *
* @see JobParser
- *
* @author Dave Syer
- *
+ *
*/
public class DecisionParser {
/**
* Parse the decision and turn it into a list of transitions.
- *
* @param element the <decision/gt; element to parse
* @param parserContext the parser context for the bean factory
- * @return a collection of bean definitions for
- * {@link org.springframework.batch.core.job.flow.support.StateTransition}
- * instances objects
+ * @return a collection of bean definitions for
+ * {@link org.springframework.batch.core.job.flow.support.StateTransition} instances
+ * objects
*/
public Collection parse(Element element, ParserContext parserContext) {
String refAttribute = element.getAttribute("decider");
String idAttribute = element.getAttribute("id");
- BeanDefinitionBuilder stateBuilder =
- BeanDefinitionBuilder.genericBeanDefinition("org.springframework.batch.core.job.flow.support.state.DecisionState");
+ BeanDefinitionBuilder stateBuilder = BeanDefinitionBuilder
+ .genericBeanDefinition("org.springframework.batch.core.job.flow.support.state.DecisionState");
stateBuilder.addConstructorArgValue(new RuntimeBeanReference(refAttribute));
stateBuilder.addConstructorArgValue(idAttribute);
return InlineFlowParser.getNextElements(parserContext, stateBuilder.getBeanDefinition(), element);
}
+
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ExceptionElementParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ExceptionElementParser.java
index 1efca6986d..3f4c5bb81f 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ExceptionElementParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/ExceptionElementParser.java
@@ -5,7 +5,7 @@
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -22,33 +22,37 @@
import org.springframework.beans.factory.support.ManagedMap;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.util.xml.DomUtils;
+
+import org.jspecify.annotations.Nullable;
import org.w3c.dom.Element;
public class ExceptionElementParser {
- public ManagedMap parse(Element element, ParserContext parserContext, String exceptionListName) {
+ public @Nullable ManagedMap parse(Element element, ParserContext parserContext,
+ String exceptionListName) {
List children = DomUtils.getChildElementsByTagName(element, exceptionListName);
if (children.size() == 1) {
ManagedMap map = new ManagedMap<>();
Element exceptionClassesElement = children.get(0);
- addExceptionClasses("include", true, exceptionClassesElement, map, parserContext);
- addExceptionClasses("exclude", false, exceptionClassesElement, map, parserContext);
+ addExceptionClasses("include", true, exceptionClassesElement, map);
+ addExceptionClasses("exclude", false, exceptionClassesElement, map);
map.put(new TypedStringValue(ForceRollbackForWriteSkipException.class.getName(), Class.class), true);
return map;
}
else if (children.size() > 1) {
- parserContext.getReaderContext().error(
- "The <" + exceptionListName + "/> element may not appear more than once in a single <"
- + element.getNodeName() + "/>.", element);
+ parserContext.getReaderContext()
+ .error("The <" + exceptionListName + "/> element may not appear more than once in a single <"
+ + element.getNodeName() + "/>.", element);
}
return null;
}
private void addExceptionClasses(String elementName, boolean include, Element exceptionClassesElement,
- ManagedMap map, ParserContext parserContext) {
+ ManagedMap map) {
for (Element child : DomUtils.getChildElementsByTagName(exceptionClassesElement, elementName)) {
String className = child.getAttribute("class");
map.put(new TypedStringValue(className, Class.class), include);
}
}
+
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/FlowElementParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/FlowElementParser.java
index de7aeef180..d9e170523c 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/FlowElementParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/FlowElementParser.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2008 the original author or authors.
+ * Copyright 2006-2022 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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -27,11 +27,10 @@
/**
* Internal parser for the <flow/> elements inside a job.
- *
+ *
* @see JobParser
- *
* @author Dave Syer
- *
+ *
*/
public class FlowElementParser {
@@ -41,12 +40,11 @@ public class FlowElementParser {
/**
* Parse the flow and turn it into a list of transitions.
- *
- * @param element the <flow/gt; element to parse
- * @param parserContext the parser context for the bean factory
+ * @param element The <flow/gt; element to parse.
+ * @param parserContext The parser context for the bean factory.
* @return a collection of bean definitions for
- * {@link org.springframework.batch.core.job.flow.support.StateTransition}
- * instances objects
+ * {@link org.springframework.batch.core.job.flow.support.StateTransition} instances
+ * objects.
*/
public Collection parse(Element element, ParserContext parserContext) {
@@ -54,7 +52,7 @@ public Collection parse(Element element, ParserContext parserCon
String idAttribute = element.getAttribute(ID_ATTR);
BeanDefinitionBuilder stateBuilder = BeanDefinitionBuilder
- .genericBeanDefinition("org.springframework.batch.core.job.flow.support.state.FlowState");
+ .genericBeanDefinition("org.springframework.batch.core.job.flow.support.state.FlowState");
AbstractBeanDefinition flowDefinition = new GenericBeanDefinition();
flowDefinition.setParentName(refAttribute);
@@ -65,4 +63,5 @@ public Collection parse(Element element, ParserContext parserCon
return InlineFlowParser.getNextElements(parserContext, stateBuilder.getBeanDefinition(), element);
}
+
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/InlineFlowParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/InlineFlowParser.java
index 911225368f..e65729e967 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/InlineFlowParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/InlineFlowParser.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2014 the original author or authors.
+ * Copyright 2006-2022 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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -28,15 +28,15 @@
*
*/
public class InlineFlowParser extends AbstractFlowParser {
+
private final String flowName;
/**
- * Construct a {@link InlineFlowParser} with the specified name and using the
- * provided job repository ref.
- *
- * @param flowName the name of the flow
- * @param jobFactoryRef the reference to the {@link JobParserJobFactoryBean}
- * from the enclosing tag
+ * Construct a {@link InlineFlowParser} with the specified name and using the provided
+ * job repository reference.
+ * @param flowName The name of the flow.
+ * @param jobFactoryRef The reference to the {@link JobParserJobFactoryBean} from the
+ * enclosing tag.
*/
public InlineFlowParser(String flowName, String jobFactoryRef) {
this.flowName = flowName;
@@ -50,17 +50,20 @@ protected boolean shouldGenerateId() {
}
/**
- * @param element the top level element containing a flow definition
- * @param parserContext the {@link ParserContext}
+ * Does the parsing.
+ * @param element The top level element containing a flow definition.
+ * @param parserContext The {@link ParserContext}.
*/
@Override
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
builder.getRawBeanDefinition().setAttribute("flowName", flowName);
builder.addPropertyValue("name", flowName);
- builder.addPropertyValue("stateTransitionComparator", new RuntimeBeanReference(DefaultStateTransitionComparator.STATE_TRANSITION_COMPARATOR));
+ builder.addPropertyValue("stateTransitionComparator",
+ new RuntimeBeanReference(DefaultStateTransitionComparator.STATE_TRANSITION_COMPARATOR));
super.doParse(element, parserContext, builder);
builder.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
parserContext.popAndRegisterContainingComponent();
}
+
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/InlineStepParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/InlineStepParser.java
index 75b4532d00..4e9123a0bc 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/InlineStepParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/InlineStepParser.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2009 the original author or authors.
+ * Copyright 2006-2022 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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -18,6 +18,7 @@
import java.util.Collection;
import org.springframework.batch.core.job.flow.support.state.StepState;
+import org.springframework.batch.core.step.Step;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.parsing.BeanComponentDefinition;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
@@ -26,14 +27,12 @@
import org.w3c.dom.Element;
/**
- * Internal parser for the <step/> elements inside a job. A step element
- * references a bean definition for a
- * {@link org.springframework.batch.core.Step} and goes on to (optionally) list
- * a set of transitions from that step to others with <next on="pattern"
- * to="stepName"/>. Used by the {@link JobParser}.
- *
+ * Internal parser for the <step/> elements inside a job. A step element references
+ * a bean definition for a {@link Step} and goes on to (optionally) list a set of
+ * transitions from that step to others with <next on="pattern" to="stepName"/>.
+ * Used by the {@link JobParser}.
+ *
* @see JobParser
- *
* @author Dave Syer
* @author Thomas Risberg
* @since 2.0
@@ -42,14 +41,13 @@ public class InlineStepParser extends AbstractStepParser {
/**
* Parse the step and turn it into a list of transitions.
- *
- * @param element the <step/gt; element to parse
- * @param parserContext the parser context for the bean factory
- * @param jobFactoryRef the reference to the {@link JobParserJobFactoryBean}
- * from the enclosing tag
+ * @param element The <step/gt; element to parse.
+ * @param parserContext The parser context for the bean factory.
+ * @param jobFactoryRef The reference to the {@link JobParserJobFactoryBean} from the
+ * enclosing tag.
* @return a collection of bean definitions for
- * {@link org.springframework.batch.core.job.flow.support.StateTransition}
- * instances objects
+ * {@link org.springframework.batch.core.job.flow.support.StateTransition} instances
+ * objects.
*/
public Collection parse(Element element, ParserContext parserContext, String jobFactoryRef) {
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobExecutionListenerParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobExecutionListenerParser.java
index be5311b64c..20b7f2c754 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobExecutionListenerParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobExecutionListenerParser.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2022 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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -22,8 +22,8 @@
import org.springframework.batch.core.listener.ListenerMetaData;
/**
- * Parser for a step listener element. Builds a {@link JobListenerFactoryBean}
- * using attributes from the configuration.
+ * Parser for a step listener element. Builds a {@link JobListenerFactoryBean} by using
+ * attributes from the configuration.
*
* @author Dan Garrette
* @since 2.0
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobParser.java
index 6853059c86..e72068c353 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobParser.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2008 the original author or authors.
+ * Copyright 2006-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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -18,6 +18,7 @@
import java.util.Arrays;
import java.util.List;
+import org.springframework.batch.core.job.Job;
import org.springframework.beans.BeanMetadataElement;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanDefinitionHolder;
@@ -29,14 +30,17 @@
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.util.StringUtils;
import org.springframework.util.xml.DomUtils;
+
+import org.jspecify.annotations.Nullable;
import org.w3c.dom.Element;
/**
- * Parser for the <job/> element in the Batch namespace. Sets up and returns
- * a bean definition for a {@link org.springframework.batch.core.Job}.
- *
+ * Parser for the <job/> element in the Batch namespace. Sets up and returns a bean
+ * definition for a {@link Job}.
+ *
* @author Dave Syer
- *
+ * @author Mahmoud Ben Hassine
+ *
*/
public class JobParser extends AbstractSingleBeanDefinitionParser {
@@ -57,9 +61,9 @@ protected Class getBeanClass(Element element) {
/**
* Create a bean definition for a
- * {@link org.springframework.batch.core.job.flow.FlowJob}. Nested step
- * elements are delegated to an {@link InlineStepParser}.
- *
+ * {@link org.springframework.batch.core.job.flow.FlowJob}. Nested step elements are
+ * delegated to an {@link InlineStepParser}.
+ *
* @see AbstractSingleBeanDefinitionParser#doParse(Element, ParserContext,
* BeanDefinitionBuilder)
*/
@@ -67,10 +71,10 @@ protected Class getBeanClass(Element element) {
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
if (!CoreNamespaceUtils.namespaceMatchesVersion(element)) {
- parserContext.getReaderContext().error(
- "You are using a version of the spring-batch XSD that is not compatible with Spring Batch 3.0." +
- " Please upgrade your schema declarations (or use the spring-batch.xsd alias if you are " +
- "feeling lucky).", element);
+ parserContext.getReaderContext()
+ .error("You are using a version of the spring-batch XSD that is not compatible with Spring Batch 3.0."
+ + " Please upgrade your schema declarations (or use the spring-batch.xsd alias if you are "
+ + "feeling lucky).", element);
return;
}
@@ -102,7 +106,7 @@ protected void doParse(Element element, ParserContext parserContext, BeanDefinit
builder.addPropertyValue("restartable", restartableAttribute);
}
- String incrementer = (element.getAttribute("incrementer"));
+ String incrementer = element.getAttribute("incrementer");
if (StringUtils.hasText(incrementer)) {
builder.addPropertyReference("jobParametersIncrementer", incrementer);
}
@@ -110,9 +114,9 @@ protected void doParse(Element element, ParserContext parserContext, BeanDefinit
if (isAbstract) {
for (String tagName : Arrays.asList("step", "decision", "split")) {
if (!DomUtils.getChildElementsByTagName(element, tagName).isEmpty()) {
- parserContext.getReaderContext().error(
- "The <" + tagName + "/> element may not appear on a listeners = new ManagedList<>();
listeners.setMergeEnabled(listenersElement.hasAttribute(MERGE_ATTR)
- && Boolean.valueOf(listenersElement.getAttribute(MERGE_ATTR)));
+ && Boolean.parseBoolean(listenersElement.getAttribute(MERGE_ATTR)));
List listenerElements = DomUtils.getChildElementsByTagName(listenersElement, "listener");
for (Element listenerElement : listenerElements) {
listeners.add(jobListenerParser.parse(listenerElement, parserContext));
@@ -144,13 +148,19 @@ protected void doParse(Element element, ParserContext parserContext, BeanDefinit
parserContext.popAndRegisterContainingComponent();
}
else if (listenersElements.size() > 1) {
- parserContext.getReaderContext().error(
- "The ' {
-
- private String name;
-
- private Boolean restartable;
-
- private JobRepository jobRepository;
-
- private JobParametersValidator jobParametersValidator;
-
- private JobExecutionListener[] jobExecutionListeners;
-
- private JobParametersIncrementer jobParametersIncrementer;
-
- private Flow flow;
-
- public JobParserJobFactoryBean(String name) {
- this.name = name;
- }
-
- @Override
- public final FlowJob getObject() throws Exception {
- Assert.isTrue(StringUtils.hasText(name), "The job must have an id.");
- FlowJob flowJob = new FlowJob(name);
-
- if (restartable != null) {
- flowJob.setRestartable(restartable);
- }
-
- if (jobRepository != null) {
- flowJob.setJobRepository(jobRepository);
- }
-
- if (jobParametersValidator != null) {
- flowJob.setJobParametersValidator(jobParametersValidator);
- }
-
- if (jobExecutionListeners != null) {
- flowJob.setJobExecutionListeners(jobExecutionListeners);
- }
-
- if (jobParametersIncrementer != null) {
- flowJob.setJobParametersIncrementer(jobParametersIncrementer);
- }
-
- if (flow != null) {
- flowJob.setFlow(flow);
- }
-
- flowJob.afterPropertiesSet();
- return flowJob;
- }
-
- public void setRestartable(Boolean restartable) {
- this.restartable = restartable;
- }
-
- public void setJobRepository(JobRepository jobRepository) {
- this.jobRepository = jobRepository;
- }
-
- public void setJobParametersValidator(JobParametersValidator jobParametersValidator) {
- this.jobParametersValidator = jobParametersValidator;
- }
-
- public JobRepository getJobRepository() {
- return this.jobRepository;
- }
-
- public void setJobExecutionListeners(JobExecutionListener[] jobExecutionListeners) {
- this.jobExecutionListeners = jobExecutionListeners;
- }
-
- public void setJobParametersIncrementer(JobParametersIncrementer jobParametersIncrementer) {
- this.jobParametersIncrementer = jobParametersIncrementer;
- }
-
- public void setFlow(Flow flow) {
- this.flow = flow;
- }
-
- @Override
- public Class getObjectType() {
- return FlowJob.class;
- }
-
- @Override
- public boolean isSingleton() {
- return true;
- }
-
- @Override
- public boolean isEagerInit() {
- return true;
- }
-
- @Override
- public boolean isPrototype() {
- return false;
- }
-
-}
+/*
+ * 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.
+ * 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.core.configuration.xml;
+
+import org.springframework.batch.core.listener.JobExecutionListener;
+import org.springframework.batch.core.job.parameters.JobParametersIncrementer;
+import org.springframework.batch.core.job.parameters.JobParametersValidator;
+import org.springframework.batch.core.job.flow.Flow;
+import org.springframework.batch.core.job.flow.FlowJob;
+import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.beans.factory.FactoryBean;
+import org.springframework.beans.factory.SmartFactoryBean;
+import org.springframework.util.Assert;
+import org.springframework.util.StringUtils;
+
+/**
+ * This {@link FactoryBean} is used by the batch namespace parser to create
+ * {@link FlowJob} objects. It stores all of the properties that are configurable on the
+ * <job/>.
+ *
+ * @author Dan Garrette
+ * @author Dave Syer
+ * @since 2.0.1
+ */
+public class JobParserJobFactoryBean implements SmartFactoryBean {
+
+ private final String name;
+
+ private Boolean restartable;
+
+ private JobRepository jobRepository;
+
+ private JobParametersValidator jobParametersValidator;
+
+ private JobExecutionListener[] jobExecutionListeners;
+
+ private JobParametersIncrementer jobParametersIncrementer;
+
+ private Flow flow;
+
+ /**
+ * Constructor for the factory bean that initializes the name.
+ * @param name The name to be used by the factory bean.
+ */
+ public JobParserJobFactoryBean(String name) {
+ this.name = name;
+ }
+
+ @Override
+ public final FlowJob getObject() throws Exception {
+ Assert.isTrue(StringUtils.hasText(name), "The job must have an id.");
+ FlowJob flowJob = new FlowJob(name);
+
+ if (restartable != null) {
+ flowJob.setRestartable(restartable);
+ }
+
+ if (jobRepository != null) {
+ flowJob.setJobRepository(jobRepository);
+ }
+
+ if (jobParametersValidator != null) {
+ flowJob.setJobParametersValidator(jobParametersValidator);
+ }
+
+ if (jobExecutionListeners != null) {
+ flowJob.setJobExecutionListeners(jobExecutionListeners);
+ }
+
+ if (jobParametersIncrementer != null) {
+ flowJob.setJobParametersIncrementer(jobParametersIncrementer);
+ }
+
+ if (flow != null) {
+ flowJob.setFlow(flow);
+ }
+
+ flowJob.afterPropertiesSet();
+ return flowJob;
+ }
+
+ /**
+ * Set the restartable flag for the factory bean.
+ * @param restartable The restartable flag to be used by the factory bean.
+ */
+ public void setRestartable(Boolean restartable) {
+ this.restartable = restartable;
+ }
+
+ /**
+ * Set the {@link JobRepository} for the factory bean.
+ * @param jobRepository The {@link JobRepository} to be used by the factory bean.
+ */
+ public void setJobRepository(JobRepository jobRepository) {
+ this.jobRepository = jobRepository;
+ }
+
+ /**
+ * Set the {@link JobParametersValidator} for the factory bean.
+ * @param jobParametersValidator The {@link JobParametersValidator} to be used by the
+ * factory bean.
+ */
+ public void setJobParametersValidator(JobParametersValidator jobParametersValidator) {
+ this.jobParametersValidator = jobParametersValidator;
+ }
+
+ /**
+ * @return The {@link JobRepository} used by the factory bean.
+ */
+ public JobRepository getJobRepository() {
+ return this.jobRepository;
+ }
+
+ public void setJobExecutionListeners(JobExecutionListener[] jobExecutionListeners) {
+ this.jobExecutionListeners = jobExecutionListeners;
+ }
+
+ /**
+ * Set the {@link JobParametersIncrementer} for the factory bean.
+ * @param jobParametersIncrementer The {@link JobParametersIncrementer} to be used by
+ * the factory bean.
+ */
+ public void setJobParametersIncrementer(JobParametersIncrementer jobParametersIncrementer) {
+ this.jobParametersIncrementer = jobParametersIncrementer;
+ }
+
+ /**
+ * Set the flow for the factory bean.
+ * @param flow The {@link Flow} to be used by the factory bean.
+ */
+ public void setFlow(Flow flow) {
+ this.flow = flow;
+ }
+
+ @Override
+ public Class getObjectType() {
+ return FlowJob.class;
+ }
+
+ @Override
+ public boolean isSingleton() {
+ return true;
+ }
+
+ @Override
+ public boolean isEagerInit() {
+ return true;
+ }
+
+ @Override
+ public boolean isPrototype() {
+ return false;
+ }
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobRepositoryParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobRepositoryParser.java
index 15f2a8c48f..730296ea77 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobRepositoryParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/JobRepositoryParser.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2008 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -15,6 +15,7 @@
*/
package org.springframework.batch.core.configuration.xml;
+import org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean;
import org.springframework.beans.factory.BeanDefinitionStoreException;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.RuntimeBeanReference;
@@ -27,10 +28,11 @@
import org.w3c.dom.Element;
/**
- * Parser for the <job-repository/> element in the Batch namespace. Sets up
- * and returns a JobRepositoryFactoryBean.
+ * Parser for the <job-repository/> element in the Batch namespace. Sets up and
+ * returns a {@link JdbcJobRepositoryFactoryBean}.
*
* @author Thomas Risberg
+ * @author Mahmoud Ben Hassine
* @since 2.0
*
*/
@@ -38,7 +40,7 @@ public class JobRepositoryParser extends AbstractSingleBeanDefinitionParser {
@Override
protected String getBeanClassName(Element element) {
- return "org.springframework.batch.core.repository.support.JobRepositoryFactoryBean";
+ return "org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean";
}
@Override
@@ -56,7 +58,7 @@ protected String resolveId(Element element, AbstractBeanDefinition definition, P
/**
* Parse and create a bean definition for a
- * {@link org.springframework.batch.core.repository.support.JobRepositoryFactoryBean}
+ * {@link org.springframework.batch.core.repository.support.JdbcJobRepositoryFactoryBean}
* .
*/
@Override
@@ -65,7 +67,7 @@ protected void doParse(Element element, ParserContext parserContext, BeanDefinit
CoreNamespaceUtils.autoregisterBeansForNamespace(parserContext, element);
String dataSource = element.getAttribute("data-source");
-
+
String jdbcOperations = element.getAttribute("jdbc-operations");
String transactionManager = element.getAttribute("transaction-manager");
@@ -76,10 +78,10 @@ protected void doParse(Element element, ParserContext parserContext, BeanDefinit
String maxVarCharLength = element.getAttribute("max-varchar-length");
- String lobHandler = element.getAttribute("lob-handler");
-
String serializer = element.getAttribute("serializer");
+ String conversionService = element.getAttribute("conversion-service");
+
RuntimeBeanReference ds = new RuntimeBeanReference(dataSource);
builder.addPropertyValue("dataSource", ds);
RuntimeBeanReference tx = new RuntimeBeanReference(transactionManager);
@@ -88,23 +90,24 @@ protected void doParse(Element element, ParserContext parserContext, BeanDefinit
builder.addPropertyReference("jdbcOperations", jdbcOperations);
}
if (StringUtils.hasText(isolationLevelForCreate)) {
- builder.addPropertyValue("isolationLevelForCreate", DefaultTransactionDefinition.PREFIX_ISOLATION
- + isolationLevelForCreate);
+ builder.addPropertyValue("isolationLevelForCreate",
+ DefaultTransactionDefinition.PREFIX_ISOLATION + isolationLevelForCreate);
}
if (StringUtils.hasText(tablePrefix)) {
builder.addPropertyValue("tablePrefix", tablePrefix);
}
- if (StringUtils.hasText(lobHandler)) {
- builder.addPropertyReference("lobHandler", lobHandler);
- }
if (StringUtils.hasText(maxVarCharLength)) {
builder.addPropertyValue("maxVarCharLength", maxVarCharLength);
}
if (StringUtils.hasText(serializer)) {
builder.addPropertyReference("serializer", serializer);
}
+ if (StringUtils.hasText(conversionService)) {
+ builder.addPropertyReference("conversionService", conversionService);
+ }
builder.setRole(BeanDefinition.ROLE_SUPPORT);
}
+
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/SimpleFlowFactoryBean.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/SimpleFlowFactoryBean.java
index 8674d04c2f..85fc80fe1d 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/SimpleFlowFactoryBean.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/SimpleFlowFactoryBean.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2012-2014 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -33,12 +33,13 @@
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.util.Assert;
+import org.springframework.util.StringUtils;
/**
- * Convenience factory for SimpleFlow instances for use in XML namespace. It
- * replaces the states in the input with proxies that have a unique name formed
- * from the flow name and the original state name (unless the name is already in
- * that form, in which case it is not modified).
+ * Convenience factory for {@link SimpleFlow} instances for use in the XML namespace. It
+ * replaces the states in the input with proxies that have a unique name formed from the
+ * flow name and the original state name (unless the name is already in that form -- in
+ * that case, it is not modified).
*
* @author Dave Syer
* @author Michael Minella
@@ -57,14 +58,14 @@ public class SimpleFlowFactoryBean implements FactoryBean, Initializ
/**
* @param stateTransitionComparator {@link Comparator} implementation that addresses
- * the ordering of state evaluation
+ * the ordering of state evaluation.
*/
public void setStateTransitionComparator(Comparator stateTransitionComparator) {
this.stateTransitionComparator = stateTransitionComparator;
}
/**
- * @param flowType Used to inject the type of flow (regular Spring Batch or JSR-352)
+ * @param flowType Used to inject the type of flow (regular Spring Batch or JSR-352).
*/
public void setFlowType(Class flowType) {
this.flowType = flowType;
@@ -72,7 +73,6 @@ public void setFlowType(Class flowType) {
/**
* The name of the flow that is created by this factory.
- *
* @param name the value of the name
*/
public void setName(String name) {
@@ -81,10 +81,8 @@ public void setName(String name) {
}
/**
- * The raw state transitions for the flow. They will be transformed into
- * proxies that have the same behavior but unique names prefixed with the
- * flow name.
- *
+ * The raw state transitions for the flow. They are transformed into proxies that have
+ * the same behavior but unique names prefixed with the flow name.
* @param stateTransitions the list of transitions
*/
public void setStateTransitions(List stateTransitions) {
@@ -93,21 +91,17 @@ public void setStateTransitions(List stateTransitions) {
/**
* Check mandatory properties (name).
- *
* @throws Exception thrown if error occurs.
*/
@Override
public void afterPropertiesSet() throws Exception {
- Assert.hasText(name, "The flow must have a name");
+ Assert.state(StringUtils.hasText(name), "The flow must have a name");
- if(flowType == null) {
+ if (flowType == null) {
flowType = SimpleFlow.class;
}
}
- /* (non-Javadoc)
- * @see org.springframework.beans.factory.FactoryBean#getObject()
- */
@Override
public SimpleFlow getObject() throws Exception {
SimpleFlow flow = flowType.getConstructor(String.class).newInstance(name);
@@ -135,12 +129,11 @@ private String getNext(String next) {
}
/**
- * Convenience method to get a state that proxies the input but with a
- * different name, appropriate to this flow. If the state is a StepState
- * then the step name is also changed.
- *
- * @param state
- * @return
+ * Convenience method to get a state that proxies the input but with a different name,
+ * appropriate to this flow. If the state is a {@link StepState}, the step name is
+ * also changed.
+ * @param state the state to proxy
+ * @return the proxy state
*/
private State getProxyState(State state) {
String oldName = state.getName();
@@ -156,15 +149,13 @@ private State getProxyState(State state) {
/**
* Provides an extension point to provide alternative {@link StepState}
- * implementations within a {@link SimpleFlow}
- *
- * @param state The state that will be used to create the StepState
- * @param oldName The name to be replaced
- * @param stateName The name for the new State
- * @return a state for the requested data
+ * implementations within a {@link SimpleFlow}.
+ * @param state The state that is used to create the {@code StepState}.
+ * @param oldName The name to be replaced.
+ * @param stateName The name for the new State.
+ * @return a state for the requested data.
*/
- protected State createNewStepState(State state, String oldName,
- String stateName) {
+ protected State createNewStepState(State state, String oldName, String stateName) {
return new StepState(stateName, ((StepState) state).getStep(oldName));
}
@@ -179,13 +170,14 @@ public boolean isSingleton() {
}
/**
- * A State that proxies a delegate and changes its name but leaves its
- * behavior unchanged.
+ * A State that proxies a delegate and changes its name but leaves its behavior
+ * unchanged.
*
* @author Dave Syer
*
*/
public static class DelegateState extends AbstractState implements FlowHolder {
+
private final State state;
private DelegateState(String name, State state) {
@@ -193,6 +185,10 @@ private DelegateState(String name, State state) {
this.state = state;
}
+ /**
+ * Gets the current state.
+ * @return The {@link State} being used by the factory bean.
+ */
public State getState() {
return this.state;
}
@@ -209,7 +205,7 @@ public FlowExecutionStatus handle(FlowExecutor executor) throws Exception {
@Override
public Collection getFlows() {
- return (state instanceof FlowHolder) ? ((FlowHolder)state).getFlows() : Collections.emptyList();
+ return (state instanceof FlowHolder flowHolder) ? flowHolder.getFlows() : Collections.emptyList();
}
}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/SplitParser.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/SplitParser.java
index da196202d2..a3bc976eda 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/SplitParser.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/SplitParser.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2008 the original author or authors.
+ * Copyright 2006-2022 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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -33,14 +33,13 @@
/**
* Internal parser for the <split/> elements inside a job. A split element
- * optionally references a bean definition for a {@link TaskExecutor} and goes
- * on to list a set of transitions to other states with <next on="pattern"
- * to="stepName"/>. Used by the {@link JobParser}.
- *
+ * optionally references a bean definition for a {@link TaskExecutor} and goes on to list
+ * a set of transitions to other states with <next on="pattern" to="stepName"/>.
+ * Used by the {@link JobParser}.
+ *
* @see JobParser
- *
* @author Dave Syer
- *
+ *
*/
public class SplitParser {
@@ -49,11 +48,10 @@ public class SplitParser {
private final String jobFactoryRef;
/**
- * Construct a {@link InlineFlowParser} using the provided job repository
- * ref.
- *
- * @param jobFactoryRef the reference to the {@link JobParserJobFactoryBean}
- * from the enclosing tag
+ * Construct a {@link InlineFlowParser} by using the provided job repository
+ * reference.
+ * @param jobFactoryRef The reference to the {@link JobParserJobFactoryBean} from the
+ * enclosing tag.
*/
public SplitParser(String jobFactoryRef) {
this.jobFactoryRef = jobFactoryRef;
@@ -61,19 +59,18 @@ public SplitParser(String jobFactoryRef) {
/**
* Parse the split and turn it into a list of transitions.
- *
- * @param element the <split/gt; element to parse
- * @param parserContext the parser context for the bean factory
+ * @param element The <split/gt; element to parse
+ * @param parserContext The parser context for the bean factory
* @return a collection of bean definitions for
- * {@link org.springframework.batch.core.job.flow.support.StateTransition}
- * instances objects
+ * {@link org.springframework.batch.core.job.flow.support.StateTransition} instances
+ * objects
*/
public Collection parse(Element element, ParserContext parserContext) {
String idAttribute = element.getAttribute("id");
BeanDefinitionBuilder stateBuilder = BeanDefinitionBuilder
- .genericBeanDefinition("org.springframework.batch.core.job.flow.support.state.SplitState");
+ .genericBeanDefinition("org.springframework.batch.core.job.flow.support.state.SplitState");
String taskExecutorBeanId = element.getAttribute("task-executor");
if (StringUtils.hasText(taskExecutorBeanId)) {
@@ -94,8 +91,8 @@ public Collection parse(Element element, ParserContext parserCon
String ref = nextElement.getAttribute(PARENT_ATTR);
if (StringUtils.hasText(ref)) {
if (nextElement.getElementsByTagName("*").getLength() > 0) {
- parserContext.getReaderContext().error(
- "A listenersElements = DomUtils.getChildElementsByTagName(stepElement, LISTENERS_ELE);
- if (listenersElements.size() == 1) {
- Element listenersElement = listenersElements.get(0);
- CompositeComponentDefinition compositeDef = new CompositeComponentDefinition(listenersElement.getTagName(),
- parserContext.extractSource(stepElement));
- parserContext.pushContainingComponent(compositeDef);
- ManagedList listenerBeans = new ManagedList<>();
- if (propertyValues.contains("listeners")) {
- listenerBeans = (ManagedList) propertyValues.getPropertyValue("listeners").getValue();
- }
- listenerBeans.setMergeEnabled(listenersElement.hasAttribute(MERGE_ATTR)
- && Boolean.valueOf(listenersElement.getAttribute(MERGE_ATTR)));
- List listenerElements = DomUtils.getChildElementsByTagName(listenersElement, "listener");
- if (listenerElements != null) {
- for (Element listenerElement : listenerElements) {
- listenerBeans.add(parse(listenerElement, parserContext));
- }
- }
- propertyValues.addPropertyValue("listeners", listenerBeans);
- parserContext.popAndRegisterContainingComponent();
- }
- }
-
-}
+/*
+ * Copyright 2006-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.core.configuration.xml;
+
+import java.util.List;
+
+import org.springframework.batch.core.listener.AbstractListenerFactoryBean;
+import org.springframework.batch.core.listener.ListenerMetaData;
+import org.springframework.batch.core.listener.StepListenerFactoryBean;
+import org.springframework.batch.core.listener.StepListenerMetaData;
+import org.springframework.beans.MutablePropertyValues;
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.parsing.CompositeComponentDefinition;
+import org.springframework.beans.factory.support.ManagedList;
+import org.springframework.beans.factory.xml.ParserContext;
+import org.springframework.util.xml.DomUtils;
+import org.w3c.dom.Element;
+
+/**
+ * Parser for a step listener element. Builds a {@link StepListenerFactoryBean} using
+ * attributes from the configuration.
+ *
+ * @author Dan Garrette
+ * @author Mahmoud Ben Hassine
+ * @since 2.0
+ * @see AbstractListenerParser
+ */
+public class StepListenerParser extends AbstractListenerParser {
+
+ private static final String LISTENERS_ELE = "listeners";
+
+ private static final String MERGE_ATTR = "merge";
+
+ private final ListenerMetaData[] listenerMetaData;
+
+ public StepListenerParser() {
+ this(StepListenerMetaData.values());
+ }
+
+ public StepListenerParser(ListenerMetaData[] listenerMetaData) {
+ this.listenerMetaData = listenerMetaData;
+ }
+
+ @Override
+ protected Class> getBeanClass() {
+ return StepListenerFactoryBean.class;
+ }
+
+ @Override
+ protected ListenerMetaData[] getMetaDataValues() {
+ return listenerMetaData;
+ }
+
+ @SuppressWarnings("unchecked")
+ public void handleListenersElement(Element stepElement, BeanDefinition beanDefinition,
+ ParserContext parserContext) {
+ MutablePropertyValues propertyValues = beanDefinition.getPropertyValues();
+ List listenersElements = DomUtils.getChildElementsByTagName(stepElement, LISTENERS_ELE);
+ if (listenersElements.size() == 1) {
+ Element listenersElement = listenersElements.get(0);
+ CompositeComponentDefinition compositeDef = new CompositeComponentDefinition(listenersElement.getTagName(),
+ parserContext.extractSource(stepElement));
+ parserContext.pushContainingComponent(compositeDef);
+ ManagedList listenerBeans = new ManagedList<>();
+ if (propertyValues.contains("listeners")) {
+ listenerBeans = (ManagedList) propertyValues.getPropertyValue("listeners").getValue();
+ }
+ listenerBeans.setMergeEnabled(listenersElement.hasAttribute(MERGE_ATTR)
+ && Boolean.parseBoolean(listenersElement.getAttribute(MERGE_ATTR)));
+ List listenerElements = DomUtils.getChildElementsByTagName(listenersElement, "listener");
+ if (listenerElements != null) {
+ for (Element listenerElement : listenerElements) {
+ listenerBeans.add(parse(listenerElement, parserContext));
+ }
+ }
+ propertyValues.addPropertyValue("listeners", listenerBeans);
+ parserContext.popAndRegisterContainingComponent();
+ }
+ }
+
+}
diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/StepParserStepFactoryBean.java b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/StepParserStepFactoryBean.java
index 4b5971a524..a99be3a800 100644
--- a/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/StepParserStepFactoryBean.java
+++ b/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/StepParserStepFactoryBean.java
@@ -1,11 +1,11 @@
/*
- * Copyright 2006-2013 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.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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,
@@ -16,48 +16,29 @@
package org.springframework.batch.core.configuration.xml;
-import java.io.Serializable;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.Map;
-import java.util.Queue;
import java.util.Set;
-import java.util.concurrent.locks.ReentrantLock;
-import javax.batch.api.chunk.listener.RetryProcessListener;
-import javax.batch.api.chunk.listener.RetryReadListener;
-import javax.batch.api.chunk.listener.RetryWriteListener;
-import javax.batch.api.chunk.listener.SkipProcessListener;
-import javax.batch.api.chunk.listener.SkipReadListener;
-import javax.batch.api.chunk.listener.SkipWriteListener;
-import javax.batch.api.partition.PartitionCollector;
-
-import org.springframework.batch.core.ChunkListener;
-import org.springframework.batch.core.ItemProcessListener;
-import org.springframework.batch.core.ItemReadListener;
-import org.springframework.batch.core.ItemWriteListener;
-import org.springframework.batch.core.Job;
-import org.springframework.batch.core.SkipListener;
-import org.springframework.batch.core.Step;
-import org.springframework.batch.core.StepExecutionListener;
-import org.springframework.batch.core.StepListener;
+
+import org.springframework.batch.core.launch.JobOperator;
+import org.springframework.batch.core.listener.ChunkListener;
+import org.springframework.batch.core.listener.ItemProcessListener;
+import org.springframework.batch.core.listener.ItemReadListener;
+import org.springframework.batch.core.listener.ItemWriteListener;
+import org.springframework.batch.core.job.Job;
+import org.springframework.batch.core.listener.SkipListener;
+import org.springframework.batch.core.step.Step;
+import org.springframework.batch.core.listener.StepExecutionListener;
+import org.springframework.batch.core.listener.StepListener;
import org.springframework.batch.core.job.flow.Flow;
-import org.springframework.batch.core.jsr.ChunkListenerAdapter;
-import org.springframework.batch.core.jsr.ItemProcessListenerAdapter;
-import org.springframework.batch.core.jsr.ItemReadListenerAdapter;
-import org.springframework.batch.core.jsr.ItemWriteListenerAdapter;
-import org.springframework.batch.core.jsr.RetryProcessListenerAdapter;
-import org.springframework.batch.core.jsr.RetryReadListenerAdapter;
-import org.springframework.batch.core.jsr.RetryWriteListenerAdapter;
-import org.springframework.batch.core.jsr.SkipListenerAdapter;
-import org.springframework.batch.core.jsr.StepListenerAdapter;
-import org.springframework.batch.core.jsr.partition.PartitionCollectorAdapter;
-import org.springframework.batch.core.launch.JobLauncher;
import org.springframework.batch.core.partition.PartitionHandler;
-import org.springframework.batch.core.partition.support.Partitioner;
-import org.springframework.batch.core.partition.support.StepExecutionAggregator;
+import org.springframework.batch.core.partition.Partitioner;
+import org.springframework.batch.core.partition.StepExecutionAggregator;
import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.batch.core.step.AbstractStep;
import org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder;
import org.springframework.batch.core.step.builder.FaultTolerantStepBuilder;
import org.springframework.batch.core.step.builder.FlowStepBuilder;
@@ -74,13 +55,12 @@
import org.springframework.batch.core.step.skip.SkipPolicy;
import org.springframework.batch.core.step.tasklet.Tasklet;
import org.springframework.batch.core.step.tasklet.TaskletStep;
-import org.springframework.batch.item.ItemProcessor;
-import org.springframework.batch.item.ItemReader;
-import org.springframework.batch.item.ItemStream;
-import org.springframework.batch.item.ItemWriter;
-import org.springframework.batch.repeat.CompletionPolicy;
-import org.springframework.batch.repeat.policy.SimpleCompletionPolicy;
-import org.springframework.batch.repeat.support.TaskExecutorRepeatTemplate;
+import org.springframework.batch.infrastructure.item.ItemProcessor;
+import org.springframework.batch.infrastructure.item.ItemReader;
+import org.springframework.batch.infrastructure.item.ItemStream;
+import org.springframework.batch.infrastructure.item.ItemWriter;
+import org.springframework.batch.infrastructure.repeat.CompletionPolicy;
+import org.springframework.batch.infrastructure.repeat.policy.SimpleCompletionPolicy;
import org.springframework.beans.factory.BeanNameAware;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.classify.BinaryExceptionClassifier;
@@ -97,14 +77,17 @@
import org.springframework.util.Assert;
/**
- * This {@link FactoryBean} is used by the batch namespace parser to create {@link Step} objects. Stores all of the
- * properties that are configurable on the <step/> (and its inner <tasklet/>). Based on which properties are
- * configured, the {@link #getObject()} method will delegate to the appropriate class for generating the {@link Step}.
+ * This {@link FactoryBean} is used by the batch namespace parser to create {@link Step}
+ * objects. It stores all of the properties that are configurable on the <step/>
+ * (and its inner <tasklet/>). Based on which properties are configured, the
+ * {@link #getObject()} method delegates to the appropriate class for generating the
+ * {@link Step}.
*
* @author Dan Garrette
* @author Josh Long
* @author Michael Minella
* @author Chris Schaefer
+ * @author Mahmoud Ben Hassine
* @see SimpleStepFactoryBean
* @see FaultTolerantStepFactoryBean
* @see TaskletStep
@@ -130,7 +113,7 @@ public class StepParserStepFactoryBean implements FactoryBean, BeanN
private PlatformTransactionManager transactionManager;
- private Set