Package org.springframework.batch.core.configuration.annotation

Class AbstractBatchConfiguration

java.lang.Object

org.springframework.batch.core.configuration.annotation.AbstractBatchConfiguration

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

SimpleBatchConfiguration

@Configuration(proxyBeanMethods=false)
@Import(ScopeConfiguration.class)
public abstract class AbstractBatchConfiguration
extends Object
implements org.springframework.beans.factory.InitializingBean

Base Configuration class that provides a common structure for enabling and using Spring Batch. Customization is available by implementing the BatchConfigurer interface.

Since:

2.2

Author:

Dave Syer, Michael Minella, Mahmoud Ben Hassine

See Also:

• EnableBatchProcessing

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	context

Constructor Summary

Constructors

Constructor	Description
AbstractBatchConfiguration()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected BatchConfigurer	getOrCreateConfigurer()	If a BatchConfigurer exists, return it.
JobBuilderFactory	jobBuilders()	Establish the JobBuilderFactory for the batch execution.
abstract JobExplorer	jobExplorer()	Establish the JobExplorer for the batch execution.
abstract JobLauncher	jobLauncher()	Establish the JobLauncher for the batch execution.
JobRegistry	jobRegistry()	Establish the JobRegistry for the batch execution.
abstract JobRepository	jobRepository()	Establish the JobRepository for the batch execution.
StepBuilderFactory	stepBuilders()	Establish the StepBuilderFactory for the batch execution.
abstract org.springframework.transaction.PlatformTransactionManager	transactionManager()	Establish the PlatformTransactionManager for the batch execution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

context

@Autowired
protected org.springframework.context.ApplicationContext context

Constructor Details

AbstractBatchConfiguration

public AbstractBatchConfiguration()

Method Details

jobBuilders

@Bean
public JobBuilderFactory jobBuilders()
                              throws Exception

Establish the JobBuilderFactory for the batch execution.

Returns:

The instance of the JobBuilderFactory.

Throws:

Exception - The Exception thrown if an error occurs.

stepBuilders

@Bean
public StepBuilderFactory stepBuilders()
                                throws Exception

Establish the StepBuilderFactory for the batch execution.

Returns:

The instance of the StepBuilderFactory.

Throws:

Exception - The Exception thrown if an error occurs.

jobRepository

@Bean
public abstract JobRepository jobRepository()
                                     throws Exception

Establish the JobRepository for the batch execution.

Returns:

The instance of the JobRepository.

Throws:

Exception - The Exception thrown if an error occurs.

jobLauncher

@Bean
public abstract JobLauncher jobLauncher()
                                 throws Exception

Establish the JobLauncher for the batch execution.

Returns:

The instance of the JobLauncher.

Throws:

Exception - The Exception thrown if an error occurs.

jobExplorer

@Bean
public abstract JobExplorer jobExplorer()
                                 throws Exception

Establish the JobExplorer for the batch execution.

Returns:

The instance of the JobExplorer.

Throws:

Exception - The Exception thrown if an error occurs.

jobRegistry

@Bean
public JobRegistry jobRegistry()
                        throws Exception

Establish the JobRegistry for the batch execution.

Returns:

The instance of the JobRegistry.

Throws:

Exception - The Exception thrown if an error occurs.

transactionManager

public abstract org.springframework.transaction.PlatformTransactionManager transactionManager()
                                                                                       throws Exception

Establish the PlatformTransactionManager for the batch execution.

Returns:

The instance of the PlatformTransactionManager.

Throws:

Exception - The Exception thrown if an error occurs.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getOrCreateConfigurer

protected BatchConfigurer getOrCreateConfigurer()

If a BatchConfigurer exists, return it. Otherwise, create a DefaultBatchConfigurer. If more than one configurer is present, an IllegalStateException is thrown.

Returns:

The BatchConfigurer that was in the configurers collection or the default one created.