Deprecated API

Contents

• Terminally Deprecated
• Interfaces
• Classes
• Annotation Interfaces
• Methods
• Constructors

Terminally Deprecated Elements

Element	Description
org.springframework.batch.core.configuration.annotation.JobBuilderFactory	Deprecated as of v5.0 and scheduled for removal in v5.2 in favor of using the JobBuilder.
org.springframework.batch.core.configuration.annotation.StepBuilderFactory	Deprecated as of v5.0 and scheduled for removal in v5.2 in favor of using the StepBuilder.
org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean.setThrottleLimit(Integer)	since 5.0, scheduled for removal in 6.0. This API is not intended for end users anyway. It is only used by the XML namespace parser.
org.springframework.batch.core.job.builder.JobBuilder(String)	use JobBuilder(String, JobRepository)
org.springframework.batch.core.job.builder.JobBuilderHelper(String)	use JobBuilderHelper(String, JobRepository)
org.springframework.batch.core.job.builder.JobBuilderHelper.repository(JobRepository)	use JobBuilderHelper(String, JobRepository)
org.springframework.batch.core.JobParameters.toProperties()	since 5.0, scheduled for removal in 5.2. Use JobParametersConverter.getProperties(JobParameters)
org.springframework.batch.core.JobParametersBuilder.addParameter(String, JobParameter<?>)	since 5.0, scheduled for removal in 5.2. Use JobParametersBuilder.addJobParameter(java.lang.String, org.springframework.batch.core.JobParameter<?>).
org.springframework.batch.core.launch.JobOperator.start(String, String)	use JobOperator.start(String, Properties) instead. Will be removed in v5.2.
org.springframework.batch.core.launch.support.JobRegistryBackgroundJobRunner	since 5.0 with no replacement. Scheduled for removal in 5.2.
org.springframework.batch.core.launch.support.SimpleJobLauncher	Since v5.0.0 for removal in v5.2.0. Use TaskExecutorJobLauncher.
org.springframework.batch.core.launch.support.SimpleJobOperator.start(String, String)
org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder.getThrottleLimit()
org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder.throttleLimit(int)	with no replacement since 5.0, scheduled for removal in 6.0. Use a custom RepeatOperations implementation (based on a TaskExecutor with a bounded task queue) and set it on the step with AbstractTaskletStepBuilder.stepOperations(RepeatOperations).
org.springframework.batch.core.step.builder.StepBuilder(String)	use StepBuilder(String, JobRepository)
org.springframework.batch.core.step.builder.StepBuilder.chunk(int)	use StepBuilder.chunk(int, PlatformTransactionManager)
org.springframework.batch.core.step.builder.StepBuilder.chunk(CompletionPolicy)	use StepBuilder.chunk(CompletionPolicy, PlatformTransactionManager)
org.springframework.batch.core.step.builder.StepBuilder.tasklet(Tasklet)	use StepBuilder.tasklet(Tasklet, PlatformTransactionManager)
org.springframework.batch.core.step.builder.StepBuilderHelper(String)	use StepBuilderHelper(String, JobRepository)
org.springframework.batch.core.step.builder.StepBuilderHelper.repository(JobRepository)	use StepBuilderHelper(String, JobRepository)
org.springframework.batch.core.step.builder.TaskletStepBuilder.tasklet(Tasklet)	use TaskletStepBuilder.tasklet(Tasklet, PlatformTransactionManager)
org.springframework.batch.core.step.factory.SimpleStepFactoryBean.setThrottleLimit(int)	since 5.0, scheduled for removal in 6.0. Use a pooled TaskExecutor implementation with a limited capacity of its task queue instead.
org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder(String)	use RemoteChunkingManagerStepBuilder(String, JobRepository)
org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder.repository(JobRepository)	use RemoteChunkingManagerStepBuilder(String, JobRepository)
org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder(String)	use RemotePartitioningManagerStepBuilder(String, JobRepository)
org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder.repository(JobRepository)	use RemotePartitioningManagerStepBuilder(String, JobRepository)
org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder(String)	use RemotePartitioningWorkerStepBuilder(String, JobRepository)
org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder.chunk(int)
org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder.chunk(CompletionPolicy)
org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder.repository(JobRepository)	use RemotePartitioningWorkerStepBuilder(String, JobRepository)
org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder.tasklet(Tasklet)
org.springframework.batch.integration.step.DelegateStep	since 5.0 with no replacement. Scheduled for removal in 5.2.
org.springframework.batch.item.data.builder.MongoItemReaderBuilder	Use MongoPagingItemReaderBuilder instead. Scheduled for removal in v5.3 or later.
org.springframework.batch.item.data.builder.MongoItemWriterBuilder.delete(boolean)	Use MongoItemWriterBuilder.mode(Mode) instead. Scheduled for removal in v5.3 or later.
org.springframework.batch.item.data.MongoItemReader	Use MongoPagingItemReader instead. Scheduled for removal in v5.3 or later.
org.springframework.batch.item.data.MongoItemWriter.setDelete(boolean)	use MongoItemWriter.setMode(Mode) instead. Scheduled for removal in v5.3 or later.
org.springframework.batch.item.database.builder.HibernateCursorItemReaderBuilder	since 5.0 for removal in 5.2. Use the JpaCursorItemReaderBuilder instead.
org.springframework.batch.item.database.builder.HibernateItemWriterBuilder	since 5.0 for removal in 5.2. Use the JpaItemWriterBuilder instead.
org.springframework.batch.item.database.builder.HibernatePagingItemReaderBuilder	since 5.0 for removal in 5.2. Use the JpaPagingItemReaderBuilder instead.
org.springframework.batch.item.database.HibernateCursorItemReader	since 5.0 for removal in 5.2. Use the JpaCursorItemReader instead.
org.springframework.batch.item.database.HibernateItemReaderHelper	since 5.0 for removal in 5.2. Use the JPA item readers instead.
org.springframework.batch.item.database.HibernateItemWriter	since 5.0 for removal in 5.2. Use the JpaItemWriter instead.
org.springframework.batch.item.database.HibernatePagingItemReader	since 5.0 for removal in 5.2. Use the JpaPagingItemReader instead.
org.springframework.batch.item.database.orm.AbstractHibernateQueryProvider
org.springframework.batch.item.database.orm.HibernateNativeQueryProvider	since 5.0 for removal in 5.2. Use the JpaNativeQueryProvider instead.
org.springframework.batch.item.database.orm.HibernateQueryProvider	since 5.0 for removal in 5.2. Use the JpaQueryProvider instead.
org.springframework.batch.item.ItemStreamSupport.close()	since 5.0 in favor of ItemStream.close(). Scheduled for removal in 5.2.
org.springframework.batch.item.ItemStreamSupport.open(ExecutionContext)	since 5.0 in favor of ItemStream.open(ExecutionContext) ()}. Scheduled for removal in 5.2.
org.springframework.batch.item.ItemStreamSupport.update(ExecutionContext)	since 5.0 in favor of ItemStream.update(ExecutionContext) ()}. Scheduled for removal in 5.2.
org.springframework.batch.repeat.support.ResultHolderResultQueue	since 5.0 with no replacement. Scheduled for removal in 6.0.
org.springframework.batch.repeat.support.TaskExecutorRepeatTemplate.setThrottleLimit(int)	since 5.0, scheduled for removal in 6.0. Use a pooled TaskExecutor implemenation with a limited capacity of its task queue instead.
org.springframework.batch.repeat.support.ThrottleLimitResultQueue	since 5.0 with no replacement. Scheduled for removal in 6.0.
org.springframework.batch.support.annotation.Classifier	since 5.0 with no replacement. Scheduled for removal in 5.2.
org.springframework.batch.test.AssertFile	since 5.0 (for removal in 5.2) in favor of test utilities provided by modern test libraries like JUnit 5, AssertJ, etc.
org.springframework.batch.test.DataSourceInitializer	since 5.0 in favor of similar utilities provided by Spring Framework. Scheduled for removal in 5.2.
org.springframework.batch.test.MetaDataInstanceFactory.createJobExecution(String, Long, Long, String)	use {MetaDataInstanceFactory.createJobExecution(String, Long, Long, JobParameters)} instead. Will be removed in v5.2

Deprecated Interfaces

Interface	Description
org.springframework.batch.item.database.orm.HibernateQueryProvider	since 5.0 for removal in 5.2. Use the JpaQueryProvider instead.

Deprecated Classes

Class	Description
org.springframework.batch.core.configuration.annotation.JobBuilderFactory	Deprecated as of v5.0 and scheduled for removal in v5.2 in favor of using the JobBuilder.
org.springframework.batch.core.configuration.annotation.StepBuilderFactory	Deprecated as of v5.0 and scheduled for removal in v5.2 in favor of using the StepBuilder.
org.springframework.batch.core.launch.support.JobRegistryBackgroundJobRunner	since 5.0 with no replacement. Scheduled for removal in 5.2.
org.springframework.batch.core.launch.support.SimpleJobLauncher	Since v5.0.0 for removal in v5.2.0. Use TaskExecutorJobLauncher.
org.springframework.batch.core.listener.ChunkListenerSupport	as of 5.0, in favor of the default methods on the ChunkListener
org.springframework.batch.core.listener.JobExecutionListenerSupport	as of 5.0, in favor of the default methods on the JobExecutionListener
org.springframework.batch.core.listener.SkipListenerSupport	as of v5.0 in favor of the default methods in SkipListener.
org.springframework.batch.core.listener.StepExecutionListenerSupport	as of 5.0, in favor of the default methods on the StepExecutionListener
org.springframework.batch.integration.step.DelegateStep	since 5.0 with no replacement. Scheduled for removal in 5.2.
org.springframework.batch.item.data.builder.MongoItemReaderBuilder	Use MongoPagingItemReaderBuilder instead. Scheduled for removal in v5.3 or later.
org.springframework.batch.item.data.builder.Neo4jItemReaderBuilder	since 5.0 in favor of the item reader builder from ...
org.springframework.batch.item.data.builder.Neo4jItemWriterBuilder	since 5.0 in favor of the item writer builder from ...
org.springframework.batch.item.data.MongoItemReader	Use MongoPagingItemReader instead. Scheduled for removal in v5.3 or later.
org.springframework.batch.item.data.Neo4jItemReader	since 5.0 in favor of the item reader from ...
org.springframework.batch.item.data.Neo4jItemWriter	since 5.0 in favor of the item writer from ...
org.springframework.batch.item.database.builder.HibernateCursorItemReaderBuilder	since 5.0 for removal in 5.2. Use the JpaCursorItemReaderBuilder instead.
org.springframework.batch.item.database.builder.HibernateItemWriterBuilder	since 5.0 for removal in 5.2. Use the JpaItemWriterBuilder instead.
org.springframework.batch.item.database.builder.HibernatePagingItemReaderBuilder	since 5.0 for removal in 5.2. Use the JpaPagingItemReaderBuilder instead.
org.springframework.batch.item.database.HibernateCursorItemReader	since 5.0 for removal in 5.2. Use the JpaCursorItemReader instead.
org.springframework.batch.item.database.HibernateItemReaderHelper	since 5.0 for removal in 5.2. Use the JPA item readers instead.
org.springframework.batch.item.database.HibernateItemWriter	since 5.0 for removal in 5.2. Use the JpaItemWriter instead.
org.springframework.batch.item.database.HibernatePagingItemReader	since 5.0 for removal in 5.2. Use the JpaPagingItemReader instead.
org.springframework.batch.item.database.orm.AbstractHibernateQueryProvider
org.springframework.batch.item.database.orm.HibernateNativeQueryProvider	since 5.0 for removal in 5.2. Use the JpaNativeQueryProvider instead.
org.springframework.batch.repeat.listener.RepeatListenerSupport	as of v5.0 in favor of the default methods in RepeatListener.
org.springframework.batch.repeat.support.ResultHolderResultQueue	since 5.0 with no replacement. Scheduled for removal in 6.0.
org.springframework.batch.repeat.support.ThrottleLimitResultQueue	since 5.0 with no replacement. Scheduled for removal in 6.0.
org.springframework.batch.test.AssertFile	since 5.0 (for removal in 5.2) in favor of test utilities provided by modern test libraries like JUnit 5, AssertJ, etc.
org.springframework.batch.test.DataSourceInitializer	since 5.0 in favor of similar utilities provided by Spring Framework. Scheduled for removal in 5.2.

Deprecated Annotation Interfaces

Annotation Interface	Description
org.springframework.batch.support.annotation.Classifier	since 5.0 with no replacement. Scheduled for removal in 5.2.

Deprecated Methods

Method	Description
org.springframework.batch.core.configuration.xml.StepParserStepFactoryBean.setThrottleLimit(Integer)	since 5.0, scheduled for removal in 6.0. This API is not intended for end users anyway. It is only used by the XML namespace parser.
org.springframework.batch.core.job.builder.JobBuilderHelper.repository(JobRepository)	use JobBuilderHelper(String, JobRepository)
org.springframework.batch.core.JobParameters.toProperties()	since 5.0, scheduled for removal in 5.2. Use JobParametersConverter.getProperties(JobParameters)
org.springframework.batch.core.JobParametersBuilder.addParameter(String, JobParameter<?>)	since 5.0, scheduled for removal in 5.2. Use JobParametersBuilder.addJobParameter(java.lang.String, org.springframework.batch.core.JobParameter<?>).
org.springframework.batch.core.launch.JobOperator.start(String, String)	use JobOperator.start(String, Properties) instead. Will be removed in v5.2.
org.springframework.batch.core.launch.support.SimpleJobOperator.start(String, String)
org.springframework.batch.core.repository.dao.JdbcJobInstanceDao.setJobIncrementer(DataFieldMaxValueIncrementer)	as of v5.0 in favor of using the JdbcJobInstanceDao.setJobInstanceIncrementer(org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer)
org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder.getThrottleLimit()
org.springframework.batch.core.step.builder.AbstractTaskletStepBuilder.throttleLimit(int)	with no replacement since 5.0, scheduled for removal in 6.0. Use a custom RepeatOperations implementation (based on a TaskExecutor with a bounded task queue) and set it on the step with AbstractTaskletStepBuilder.stepOperations(RepeatOperations).
org.springframework.batch.core.step.builder.StepBuilder.chunk(int)	use StepBuilder.chunk(int, PlatformTransactionManager)
org.springframework.batch.core.step.builder.StepBuilder.chunk(CompletionPolicy)	use StepBuilder.chunk(CompletionPolicy, PlatformTransactionManager)
org.springframework.batch.core.step.builder.StepBuilder.tasklet(Tasklet)	use StepBuilder.tasklet(Tasklet, PlatformTransactionManager)
org.springframework.batch.core.step.builder.StepBuilderHelper.repository(JobRepository)	use StepBuilderHelper(String, JobRepository)
org.springframework.batch.core.step.builder.TaskletStepBuilder.tasklet(Tasklet)	use TaskletStepBuilder.tasklet(Tasklet, PlatformTransactionManager)
org.springframework.batch.core.step.factory.SimpleStepFactoryBean.setThrottleLimit(int)	since 5.0, scheduled for removal in 6.0. Use a pooled TaskExecutor implementation with a limited capacity of its task queue instead.
org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder.repository(JobRepository)	use RemoteChunkingManagerStepBuilder(String, JobRepository)
org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder.repository(JobRepository)	use RemotePartitioningManagerStepBuilder(String, JobRepository)
org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder.chunk(int)
org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder.chunk(CompletionPolicy)
org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder.repository(JobRepository)	use RemotePartitioningWorkerStepBuilder(String, JobRepository)
org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder.tasklet(Tasklet)
org.springframework.batch.item.data.builder.MongoItemWriterBuilder.delete(boolean)	Use MongoItemWriterBuilder.mode(Mode) instead. Scheduled for removal in v5.3 or later.
org.springframework.batch.item.data.MongoItemWriter.setDelete(boolean)	use MongoItemWriter.setMode(Mode) instead. Scheduled for removal in v5.3 or later.
org.springframework.batch.item.database.support.SqlPagingQueryUtils.generateLimitGroupedSqlQuery(AbstractSqlPagingQueryProvider, boolean, String)	as of v5.0 in favor of SqlPagingQueryUtils.generateLimitGroupedSqlQuery(AbstractSqlPagingQueryProvider, java.lang.String)
org.springframework.batch.item.ItemStreamSupport.close()	since 5.0 in favor of ItemStream.close(). Scheduled for removal in 5.2.
org.springframework.batch.item.ItemStreamSupport.open(ExecutionContext)	since 5.0 in favor of ItemStream.open(ExecutionContext) ()}. Scheduled for removal in 5.2.
org.springframework.batch.item.ItemStreamSupport.update(ExecutionContext)	since 5.0 in favor of ItemStream.update(ExecutionContext) ()}. Scheduled for removal in 5.2.
org.springframework.batch.repeat.support.TaskExecutorRepeatTemplate.setThrottleLimit(int)	since 5.0, scheduled for removal in 6.0. Use a pooled TaskExecutor implemenation with a limited capacity of its task queue instead.
org.springframework.batch.test.MetaDataInstanceFactory.createJobExecution(String, Long, Long, String)	use {MetaDataInstanceFactory.createJobExecution(String, Long, Long, JobParameters)} instead. Will be removed in v5.2

Deprecated Constructors

Constructor	Description
org.springframework.batch.core.job.builder.JobBuilder(String)	use JobBuilder(String, JobRepository)
org.springframework.batch.core.job.builder.JobBuilderHelper(String)	use JobBuilderHelper(String, JobRepository)
org.springframework.batch.core.step.builder.StepBuilder(String)	use StepBuilder(String, JobRepository)
org.springframework.batch.core.step.builder.StepBuilderHelper(String)	use StepBuilderHelper(String, JobRepository)
org.springframework.batch.integration.chunk.RemoteChunkingManagerStepBuilder(String)	use RemoteChunkingManagerStepBuilder(String, JobRepository)
org.springframework.batch.integration.partition.RemotePartitioningManagerStepBuilder(String)	use RemotePartitioningManagerStepBuilder(String, JobRepository)
org.springframework.batch.integration.partition.RemotePartitioningWorkerStepBuilder(String)	use RemotePartitioningWorkerStepBuilder(String, JobRepository)