Make MongoDB sequence incrementers configurable

Resolves #5018

Author: fmbenhassine

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

@@ -189,6 +189,22 @@ private void registerMongoJobRepository(BeanDefinitionRegistry registry,
 		if (registry.containsBeanDefinition(jobKeyGeneratorRef)) {
 			beanDefinitionBuilder.addPropertyReference("jobKeyGenerator", jobKeyGeneratorRef);
 		}
+
+		String jobInstanceIncrementerRef = mongoJobRepositoryAnnotation.jobInstanceIncrementerRef();
+		if (registry.containsBeanDefinition(jobInstanceIncrementerRef)) {
+			beanDefinitionBuilder.addPropertyReference("jobInstanceIncrementer", jobInstanceIncrementerRef);
+		}
+
+		String jobExecutionIncrementerRef = mongoJobRepositoryAnnotation.jobExecutionIncrementerRef();
+		if (registry.containsBeanDefinition(jobExecutionIncrementerRef)) {
+			beanDefinitionBuilder.addPropertyReference("jobExecutionIncrementer", jobExecutionIncrementerRef);
+		}
+
+		String stepExecutionIncrementerRef = mongoJobRepositoryAnnotation.stepExecutionIncrementerRef();
+		if (registry.containsBeanDefinition(stepExecutionIncrementerRef)) {
+			beanDefinitionBuilder.addPropertyReference("stepExecutionIncrementer", stepExecutionIncrementerRef);
+		}
+
 		beanDefinitionBuilder.addPropertyValue("validateTransactionState",
 				mongoJobRepositoryAnnotation.validateTransactionState());
 

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

@@ -77,4 +77,25 @@
 	 */
 	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";
+
 }

spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MongoDefaultBatchConfiguration.java

@@ -21,11 +21,13 @@
 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;
 
 /**
@@ -74,6 +76,9 @@ public JobRepository jobRepository() throws BatchConfigurationException {
 			jobRepositoryFactoryBean.setIsolationLevelForCreateEnum(getIsolationLevelForCreate());
 			jobRepositoryFactoryBean.setValidateTransactionState(getValidateTransactionState());
 			jobRepositoryFactoryBean.setJobKeyGenerator(getJobKeyGenerator());
+			jobRepositoryFactoryBean.setJobInstanceIncrementer(getJobInstanceIncrementer());
+			jobRepositoryFactoryBean.setJobExecutionIncrementer(getJobExecutionIncrementer());
+			jobRepositoryFactoryBean.setStepExecutionIncrementer(getStepExecutionIncrementer());
 			jobRepositoryFactoryBean.afterPropertiesSet();
 			return jobRepositoryFactoryBean.getObject();
 		}
@@ -148,4 +153,31 @@ 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");
+	}
+
 }

spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/MongoJobRepositoryFactoryBean.java

@@ -20,10 +20,12 @@
 import org.springframework.batch.core.repository.dao.mongodb.MongoExecutionContextDao;
 import org.springframework.batch.core.repository.dao.mongodb.MongoJobExecutionDao;
 import org.springframework.batch.core.repository.dao.mongodb.MongoJobInstanceDao;
+import org.springframework.batch.core.repository.dao.mongodb.MongoSequenceIncrementer;
 import org.springframework.batch.core.repository.dao.mongodb.MongoStepExecutionDao;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.data.mongodb.core.MongoOperations;
 import org.springframework.data.mongodb.core.convert.MappingMongoConverter;
+import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer;
 import org.springframework.util.Assert;
 
 /**
@@ -41,10 +43,28 @@ public class MongoJobRepositoryFactoryBean extends AbstractJobRepositoryFactoryB
 
 	private @Nullable MongoOperations mongoOperations;
 
+	private @Nullable DataFieldMaxValueIncrementer jobInstanceIncrementer;
+
+	private @Nullable DataFieldMaxValueIncrementer jobExecutionIncrementer;
+
+	private @Nullable DataFieldMaxValueIncrementer stepExecutionIncrementer;
+
 	public void setMongoOperations(MongoOperations mongoOperations) {
 		this.mongoOperations = mongoOperations;
 	}
 
+	public void setJobInstanceIncrementer(DataFieldMaxValueIncrementer jobInstanceIncrementer) {
+		this.jobInstanceIncrementer = jobInstanceIncrementer;
+	}
+
+	public void setJobExecutionIncrementer(DataFieldMaxValueIncrementer jobExecutionIncrementer) {
+		this.jobExecutionIncrementer = jobExecutionIncrementer;
+	}
+
+	public void setStepExecutionIncrementer(DataFieldMaxValueIncrementer stepExecutionIncrementer) {
+		this.stepExecutionIncrementer = stepExecutionIncrementer;
+	}
+
 	@Override
 	protected Object getTarget() throws Exception {
 		MongoJobInstanceDao jobInstanceDao = createJobInstanceDao();
@@ -60,17 +80,22 @@ protected Object getTarget() throws Exception {
 	protected MongoJobInstanceDao createJobInstanceDao() {
 		MongoJobInstanceDao mongoJobInstanceDao = new MongoJobInstanceDao(this.mongoOperations);
 		mongoJobInstanceDao.setJobKeyGenerator(this.jobKeyGenerator);
+		mongoJobInstanceDao.setJobInstanceIncrementer(this.jobInstanceIncrementer);
 		return mongoJobInstanceDao;
 	}
 
 	@Override
 	protected MongoJobExecutionDao createJobExecutionDao() {
-		return new MongoJobExecutionDao(this.mongoOperations);
+		MongoJobExecutionDao mongoJobExecutionDao = new MongoJobExecutionDao(this.mongoOperations);
+		mongoJobExecutionDao.setJobExecutionIncrementer(this.jobExecutionIncrementer);
+		return mongoJobExecutionDao;
 	}
 
 	@Override
 	protected MongoStepExecutionDao createStepExecutionDao() {
-		return new MongoStepExecutionDao(this.mongoOperations);
+		MongoStepExecutionDao mongoStepExecutionDao = new MongoStepExecutionDao(this.mongoOperations);
+		mongoStepExecutionDao.setStepExecutionIncrementer(this.stepExecutionIncrementer);
+		return mongoStepExecutionDao;
 	}
 
 	@Override
@@ -82,6 +107,17 @@ protected MongoExecutionContextDao createExecutionContextDao() {
 	public void afterPropertiesSet() throws Exception {
 		super.afterPropertiesSet();
 		Assert.notNull(this.mongoOperations, "MongoOperations must not be null.");
+		if (this.jobInstanceIncrementer == null) {
+			this.jobInstanceIncrementer = new MongoSequenceIncrementer(this.mongoOperations, "BATCH_JOB_INSTANCE_SEQ");
+		}
+		if (this.jobExecutionIncrementer == null) {
+			this.jobExecutionIncrementer = new MongoSequenceIncrementer(this.mongoOperations,
+					"BATCH_JOB_EXECUTION_SEQ");
+		}
+		if (this.stepExecutionIncrementer == null) {
+			this.stepExecutionIncrementer = new MongoSequenceIncrementer(this.mongoOperations,
+					"BATCH_STEP_EXECUTION_SEQ");
+		}
 	}
 
 }