de.codecentric.batch.configuration

Class BatchWebAutoConfiguration

java.lang.Object

de.codecentric.batch.configuration.BatchWebAutoConfiguration

All Implemented Interfaces:

EventListener, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>, org.springframework.core.Ordered

@Configuration
@EnableBatchProcessing(modular=true)
@PropertySource(value="classpath:spring-boot-starter-batch-web.properties")
@Import(value={WebConfig.class,TaskExecutorBatchConfigurer.class,AutomaticJobRegistrarConfiguration.class,BaseConfiguration.class,Jsr352BatchConfiguration.class,MetricsConfiguration.class,MetricsExporterConfiguration.class,TaskExecutorConfiguration.class})
public class BatchWebAutoConfiguration
extends Object
implements org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>, org.springframework.core.Ordered

This configuration class will be picked up by Spring Boot's auto configuration capabilities as soon as it's on the classpath.

It enables batch processing, imports the batch infrastructure configuration (TaskExecutorBatchConfigurer and imports the web endpoint configuration (WebConfig.
It also imports AutomaticJobRegistrarConfiguration which looks for jobs in a modular fashion, meaning that every job configuration file gets its own Child-ApplicationContext. Configuration files can be XML files in the location /META-INF/spring/batch/jobs, overridable via property batch.config.path.xml, and JavaConfig classes in the package spring.batch.jobs, overridable via property batch.config.package.javaconfig.
In addition to collecting jobs a number of default listeners is added to each job. The ProtocolListener adds a protocol to the log. It is activated by default and can be deactivated by setting the property batch.defaultprotocol.enabled to false.
LoggingListener and LoggingAfterJobListener add a log file separation per job run, are activated by default and can be deactivated by setting the property batch.logfileseparation.enabled to false. The RunningExecutionTrackerListener is needed for knowing which JobExecutions are currently running on this node.

Author:

Tobias Flohre

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
BatchWebAutoConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
AddListenerToJobService	addListenerToJobService()
int	getOrder()
LoggingAfterJobListener	loggingAfterJobListener()
LoggingListener	loggingListener()
void	onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)
ProtocolListener	protocolListener()
RunningExecutionTracker	runningExecutionTracker()
RunningExecutionTrackerListener	runningExecutionTrackerListener()

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchWebAutoConfiguration

public BatchWebAutoConfiguration()

Method Detail

loggingListener

@Bean
public LoggingListener loggingListener()

loggingAfterJobListener

@Bean
public LoggingAfterJobListener loggingAfterJobListener()

protocolListener

@Bean
public ProtocolListener protocolListener()

runningExecutionTracker

@Bean
public RunningExecutionTracker runningExecutionTracker()

runningExecutionTrackerListener

@Bean
public RunningExecutionTrackerListener runningExecutionTrackerListener()

addListenerToJobService

@Bean
public AddListenerToJobService addListenerToJobService()

onApplicationEvent

public void onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered