/* * Copyright 2012-2013 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.springframework.batch.core.configuration.annotation; import org.springframework.batch.core.configuration.JobRegistry; import org.springframework.batch.core.configuration.support.MapJobRegistry; import org.springframework.batch.core.explore.JobExplorer; import org.springframework.batch.core.launch.JobLauncher; import org.springframework.batch.core.repository.JobRepository; import org.springframework.batch.core.scope.JobScope; import org.springframework.batch.core.scope.StepScope; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; import org.springframework.context.annotation.ImportAware; import org.springframework.core.annotation.AnnotationAttributes; import org.springframework.core.type.AnnotationMetadata; import org.springframework.transaction.PlatformTransactionManager; import org.springframework.util.Assert; import javax.sql.DataSource; import java.util.Collection; /** * Base {@code Configuration} class providing common structure for enabling and using Spring Batch. Customization is * available by implementing the {@link BatchConfigurer} interface. {@link BatchConfigurer}. * * @author Dave Syer * @author Michael Minella * @since 2.2 * @see EnableBatchProcessing */ @Configuration @Import(ScopeConfiguration.class) public abstract class AbstractBatchConfiguration implements ImportAware { @Autowired(required = false) private Collection<DataSource> dataSources; private BatchConfigurer configurer; @Bean public JobBuilderFactory jobBuilders() throws Exception { return new JobBuilderFactory(jobRepository()); } @Bean public StepBuilderFactory stepBuilders() throws Exception { return new StepBuilderFactory(jobRepository(), transactionManager()); } @Bean public abstract JobRepository jobRepository() throws Exception; @Bean public abstract JobLauncher jobLauncher() throws Exception; @Bean public abstract JobExplorer jobExplorer() throws Exception; @Bean public JobRegistry jobRegistry() throws Exception { return new MapJobRegistry(); } @Bean public abstract PlatformTransactionManager transactionManager() throws Exception; @Override public void setImportMetadata(AnnotationMetadata importMetadata) { AnnotationAttributes enabled = AnnotationAttributes.fromMap(importMetadata.getAnnotationAttributes( EnableBatchProcessing.class.getName(), false)); Assert.notNull(enabled, "@EnableBatchProcessing is not present on importing class " + importMetadata.getClassName()); } protected BatchConfigurer getConfigurer(Collection<BatchConfigurer> configurers) throws Exception { if (this.configurer != null) { return this.configurer; } if (configurers == null || configurers.isEmpty()) { if (dataSources == null || dataSources.isEmpty()) { DefaultBatchConfigurer configurer = new DefaultBatchConfigurer(); configurer.initialize(); this.configurer = configurer; return configurer; } else if(dataSources != null && dataSources.size() == 1) { DataSource dataSource = dataSources.iterator().next(); DefaultBatchConfigurer configurer = new DefaultBatchConfigurer(dataSource); configurer.initialize(); this.configurer = configurer; return configurer; } else { throw new IllegalStateException("To use the default BatchConfigurer the context must contain no more than" + "one DataSource, found " + dataSources.size()); } } if (configurers.size() > 1) { throw new IllegalStateException( "To use a custom BatchConfigurer the context must contain precisely one, found " + configurers.size()); } this.configurer = configurers.iterator().next(); return this.configurer; } } /** * Extract step scope configuration into a separate unit so that it can be non-static. * * @author Dave Syer * */ @Configuration class ScopeConfiguration { private StepScope stepScope = new StepScope(); private JobScope jobScope = new JobScope(); @Bean public StepScope stepScope() { stepScope.setAutoProxy(false); return stepScope; } @Bean public JobScope jobScope() { jobScope.setAutoProxy(false); return jobScope; } }