Remove the Map based job repository/explorer and their DAOs

This commit removes the deprecated Map-based job repository
and job explorer implementations with their respective DAOs.
Using the `EnableBatchProcessing` annotation now requires a
datasource bean to be defined in the application context.
This will be reviewed as part of #3942.

This commit is a first pass that updates related tests to use
the JDBC-based job repository/explorer with an embedded database.
A second pass should be done to improve tests by caching/reusing
embedded databases if possible.

Issue #3836

Author: fmbenhassine

spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/AbstractBatchConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2018 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -51,7 +51,7 @@
 @Import(ScopeConfiguration.class)
 public abstract class AbstractBatchConfiguration implements ImportAware, InitializingBean {
 
-	@Autowired(required = false)
+	@Autowired
 	private DataSource dataSource;
 
 	private BatchConfigurer configurer;
@@ -103,22 +103,15 @@ public void afterPropertiesSet() throws Exception {
 		this.stepBuilderFactory = new StepBuilderFactory(jobRepository(), transactionManager());
 	}
 
-	protected BatchConfigurer getConfigurer(Collection<BatchConfigurer> configurers) throws Exception {
+	protected BatchConfigurer getConfigurer(Collection<BatchConfigurer> configurers) {
 		if (this.configurer != null) {
 			return this.configurer;
 		}
 		if (configurers == null || configurers.isEmpty()) {
-			if (dataSource == null) {
-				DefaultBatchConfigurer configurer = new DefaultBatchConfigurer();
-				configurer.initialize();
-				this.configurer = configurer;
-				return configurer;
-			} else {
-				DefaultBatchConfigurer configurer = new DefaultBatchConfigurer(dataSource);
-				configurer.initialize();
-				this.configurer = configurer;
-				return configurer;
-			}
+			DefaultBatchConfigurer configurer = new DefaultBatchConfigurer(this.dataSource);
+			configurer.initialize();
+			this.configurer = configurer;
+			return configurer;
 		}
 		if (configurers.size() > 1) {
 			throw new IllegalStateException(

spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/DefaultBatchConfigurer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2018 the original author or authors.
+ * Copyright 2012-2021 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,27 +18,20 @@
 import javax.annotation.PostConstruct;
 import javax.sql.DataSource;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
 import org.springframework.batch.core.configuration.BatchConfigurationException;
 import org.springframework.batch.core.explore.JobExplorer;
 import org.springframework.batch.core.explore.support.JobExplorerFactoryBean;
-import org.springframework.batch.core.explore.support.MapJobExplorerFactoryBean;
 import org.springframework.batch.core.launch.JobLauncher;
 import org.springframework.batch.core.launch.support.SimpleJobLauncher;
 import org.springframework.batch.core.repository.JobRepository;
 import org.springframework.batch.core.repository.support.JobRepositoryFactoryBean;
-import org.springframework.batch.core.repository.support.MapJobRepositoryFactoryBean;
-import org.springframework.batch.support.transaction.ResourcelessTransactionManager;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.jdbc.datasource.DataSourceTransactionManager;
 import org.springframework.stereotype.Component;
 import org.springframework.transaction.PlatformTransactionManager;
+import org.springframework.util.Assert;
 
 @Component
 public class DefaultBatchConfigurer implements BatchConfigurer {
-	private static final Log logger = LogFactory.getLog(DefaultBatchConfigurer.class);
 
 	private DataSource dataSource;
 	private PlatformTransactionManager transactionManager;
@@ -47,28 +40,39 @@ public class DefaultBatchConfigurer implements BatchConfigurer {
 	private JobExplorer jobExplorer;
 
 	/**
-	 * Sets the dataSource.  If the {@link DataSource} has been set once, all future
-	 * values are passed are ignored (to prevent {@code}@Autowired{@code} from overwriting
-	 * the value).
+	 * Sets the dataSource.
 	 *
-	 * @param dataSource The data source to use
+	 * @param dataSource The data source to use. Must not be {@code null}.
 	 */
-	@Autowired(required = false)
 	public void setDataSource(DataSource dataSource) {
-		if(this.dataSource == null) {
-			this.dataSource = dataSource;
-		}
-
-		if(getTransactionManager() == null) {
-			logger.warn("No transaction manager was provided, using a DataSourceTransactionManager");
-			this.transactionManager = new DataSourceTransactionManager(this.dataSource);
-		}
+		Assert.notNull(dataSource, "DataSource must not be null");
+		this.dataSource = dataSource;
 	}
 
-	protected DefaultBatchConfigurer() {}
+	public DataSource getDataSource() {
+		return this.dataSource;
+	}
 
+	/**
+	 * Create a new {@link DefaultBatchConfigurer} with the passed datasource. This constructor
+	 * will configure a default {@link DataSourceTransactionManager}.
+	 *
+	 * @param dataSource to use for the job repository and job explorer
+	 */
 	public DefaultBatchConfigurer(DataSource dataSource) {
-		setDataSource(dataSource);
+		this(dataSource, new DataSourceTransactionManager(dataSource));
+	}
+
+	/**
+	 * Create a new {@link DefaultBatchConfigurer} with the passed datasource and transaction manager.
+	 * @param dataSource to use for the job repository and job explorer
+	 * @param transactionManager to use for the job repository
+	 */
+	public DefaultBatchConfigurer(DataSource dataSource, PlatformTransactionManager transactionManager) {
+		Assert.notNull(dataSource, "DataSource must not be null");
+		Assert.notNull(transactionManager, "transactionManager must not be null");
+		this.dataSource = dataSource;
+		this.transactionManager = transactionManager;
 	}
 
 	@Override
@@ -94,26 +98,8 @@ public JobExplorer getJobExplorer() {
 	@PostConstruct
 	public void initialize() {
 		try {
-			if(dataSource == null) {
-				logger.warn("No datasource was provided...using a Map based JobRepository");
-
-				if(getTransactionManager() == null) {
-					logger.warn("No transaction manager was provided, using a ResourcelessTransactionManager");
-					this.transactionManager = new ResourcelessTransactionManager();
-				}
-
-				MapJobRepositoryFactoryBean jobRepositoryFactory = new MapJobRepositoryFactoryBean(getTransactionManager());
-				jobRepositoryFactory.afterPropertiesSet();
-				this.jobRepository = jobRepositoryFactory.getObject();
-
-				MapJobExplorerFactoryBean jobExplorerFactory = new MapJobExplorerFactoryBean(jobRepositoryFactory);
-				jobExplorerFactory.afterPropertiesSet();
-				this.jobExplorer = jobExplorerFactory.getObject();
-			} else {
-				this.jobRepository = createJobRepository();
-				this.jobExplorer = createJobExplorer();
-			}
-
+			this.jobRepository = createJobRepository();
+			this.jobExplorer = createJobExplorer();
 			this.jobLauncher = createJobLauncher();
 		} catch (Exception e) {
 			throw new BatchConfigurationException(e);
@@ -122,14 +108,14 @@ public void initialize() {
 
 	protected JobLauncher createJobLauncher() throws Exception {
 		SimpleJobLauncher jobLauncher = new SimpleJobLauncher();
-		jobLauncher.setJobRepository(jobRepository);
+		jobLauncher.setJobRepository(this.jobRepository);
 		jobLauncher.afterPropertiesSet();
 		return jobLauncher;
 	}
 
 	protected JobRepository createJobRepository() throws Exception {
 		JobRepositoryFactoryBean factory = new JobRepositoryFactoryBean();
-		factory.setDataSource(dataSource);
+		factory.setDataSource(this.dataSource);
 		factory.setTransactionManager(getTransactionManager());
 		factory.afterPropertiesSet();
 		return factory.getObject();

spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/EnableBatchProcessing.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2018 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -85,9 +85,7 @@
  * }
  * </pre>
  *
- * 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
+ * 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 <code>dataSource</code> will be used if any, otherwise a {@link UnsatisfiedDependencyException}
@@ -111,14 +109,8 @@
  * job repository and transaction manager into every step</li>
  * </ul>
  *
- * The transaction manager provided by this annotation will be of type:
- *
- * <ul>
- *     <li>{@link org.springframework.batch.support.transaction.ResourcelessTransactionManager}
- *     if no {@link javax.sql.DataSource} is provided within the context</li>
- *     <li>{@link org.springframework.jdbc.datasource.DataSourceTransactionManager}
- *     if a {@link javax.sql.DataSource} is provided within the context</li>
- * </ul>
+ * The transaction manager provided by this annotation will be of type {@link org.springframework.jdbc.datasource.DataSourceTransactionManager}
+ * configured with the {@link javax.sql.DataSource} provided within the context.
  *
  * In order to use a custom transaction manager, a custom {@link BatchConfigurer} should be provided. For example:
  *

spring-batch-core/src/main/java/org/springframework/batch/core/explore/support/AbstractJobExplorerFactoryBean.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2013 the original author or authors.
+ * Copyright 2006-2021 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.
@@ -29,9 +29,9 @@
  * object implementations.
  *
  * @see JobExplorerFactoryBean
- * @see MapJobExplorerFactoryBean
  *
  * @author Dave Syer
+ * @author Mahmoud Ben Hassine
  * @since 2.0
  */
 public abstract class AbstractJobExplorerFactoryBean implements FactoryBean<JobExplorer> {