org.springframework.boot.autoconfigure.batch

Class BatchAutoConfiguration

java.lang.Object

org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration

@Configuration
 @ConditionalOnClass(value={org.springframework.batch.core.launch.JobLauncher.class,javax.sql.DataSource.class,org.springframework.jdbc.core.JdbcOperations.class})
 @ConditionalOnBean(value=org.springframework.batch.core.launch.JobLauncher.class)
 @EnableConfigurationProperties(value=BatchProperties.class)
public class BatchAutoConfiguration
extends Object

Auto-configuration for Spring Batch. By default a Runner will be created and all jobs in the context will be executed on startup.

Disable this behavior with spring.batch.job.enabled=false).

Alternatively, discrete Job names to execute on startup can be supplied by the User with a comma-delimited list: spring.batch.job.names=job1,job2. In this case the Runner will first find jobs registered as Beans, then those in the existing JobRegistry.

Since:

1.0.0

Author:

Dave Syer, Eddú Meléndez, Kazuki Shimizu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BatchAutoConfiguration.JpaBatchConfiguration

Constructor Summary

Constructors

Constructor and Description
BatchAutoConfiguration(BatchProperties properties, ObjectProvider<org.springframework.batch.core.converter.JobParametersConverter> jobParametersConverter)

Method Summary

Modifier and Type	Method and Description
BatchDatabaseInitializer	batchDatabaseInitializer(DataSource dataSource, ResourceLoader resourceLoader)
JobExecutionExitCodeGenerator	jobExecutionExitCodeGenerator()
org.springframework.batch.core.explore.JobExplorer	jobExplorer(DataSource dataSource)
JobLauncherCommandLineRunner	jobLauncherCommandLineRunner(org.springframework.batch.core.launch.JobLauncher jobLauncher, org.springframework.batch.core.explore.JobExplorer jobExplorer)
org.springframework.batch.core.launch.support.SimpleJobOperator	jobOperator(org.springframework.batch.core.explore.JobExplorer jobExplorer, org.springframework.batch.core.launch.JobLauncher jobLauncher, org.springframework.batch.core.configuration.ListableJobLocator jobRegistry, org.springframework.batch.core.repository.JobRepository jobRepository)

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchAutoConfiguration

public BatchAutoConfiguration(BatchProperties properties,
                              ObjectProvider<org.springframework.batch.core.converter.JobParametersConverter> jobParametersConverter)

Method Detail

batchDatabaseInitializer

@Bean
 @ConditionalOnMissingBean
 @ConditionalOnBean(value=javax.sql.DataSource.class)
public BatchDatabaseInitializer batchDatabaseInitializer(DataSource dataSource,
                                                                                                                                                ResourceLoader resourceLoader)

jobLauncherCommandLineRunner

@Bean
 @ConditionalOnMissingBean
 @ConditionalOnProperty(prefix="spring.batch.job",
                       name="enabled",
                       havingValue="true",
                       matchIfMissing=true)
public JobLauncherCommandLineRunner jobLauncherCommandLineRunner(org.springframework.batch.core.launch.JobLauncher jobLauncher,
                                                                                                                                                                                                                                                                                   org.springframework.batch.core.explore.JobExplorer jobExplorer)

jobExecutionExitCodeGenerator

@Bean
 @ConditionalOnMissingBean(value=ExitCodeGenerator.class)
public JobExecutionExitCodeGenerator jobExecutionExitCodeGenerator()

jobExplorer

@Bean
 @ConditionalOnMissingBean
 @ConditionalOnBean(value=javax.sql.DataSource.class)
public org.springframework.batch.core.explore.JobExplorer jobExplorer(DataSource dataSource)
                                                                                                                                                      throws Exception

Throws:

Exception

jobOperator

@Bean
 @ConditionalOnMissingBean(value=org.springframework.batch.core.launch.JobOperator.class)
public org.springframework.batch.core.launch.support.SimpleJobOperator jobOperator(org.springframework.batch.core.explore.JobExplorer jobExplorer,
                                                                                                                                                                                   org.springframework.batch.core.launch.JobLauncher jobLauncher,
                                                                                                                                                                                   org.springframework.batch.core.configuration.ListableJobLocator jobRegistry,
                                                                                                                                                                                   org.springframework.batch.core.repository.JobRepository jobRepository)
                                                                                                                                                                            throws Exception

Throws:

Exception