OPEN - issue BATCH-404: FactoryBeans for step configuration

http://jira.springframework.org/browse/BATCH-404

Introduce (as temporary measure) KitchenSinkStepFactoryBean.

spring-batch-execution/src/main/java/org/springframework/batch/execution/step/support/AbstractStepFactoryBean.java

@@ -0,0 +1,173 @@
+/*
+ * Copyright 2006-2007 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.execution.step.support;
+
+import org.springframework.batch.core.domain.Step;
+import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.batch.execution.step.ItemOrientedStep;
+import org.springframework.batch.item.ItemReader;
+import org.springframework.batch.item.ItemWriter;
+import org.springframework.beans.factory.BeanNameAware;
+import org.springframework.beans.factory.config.AbstractFactoryBean;
+import org.springframework.transaction.PlatformTransactionManager;
+import org.springframework.util.Assert;
+
+/**
+ * Base class for factory beans for {@link ItemOrientedStep}. Ensures that all
+ * the mandatory properties are set, and provides basic support for the
+ * {@link Step} interface responsibilities like start limit.
+ * 
+ * @author Dave Syer
+ * 
+ */
+public abstract class AbstractStepFactoryBean extends AbstractFactoryBean implements BeanNameAware {
+
+	private String name;
+
+	private int startLimit = Integer.MAX_VALUE;
+
+	private boolean allowStartIfComplete;
+
+	private ItemReader itemReader;
+
+	private ItemWriter itemWriter;
+
+	private PlatformTransactionManager transactionManager;
+
+	private JobRepository jobRepository;
+
+	/**
+	 * 
+	 */
+	public AbstractStepFactoryBean() {
+		super();
+	}
+
+	/**
+	 * Set the bean name property, which will become the name of the
+	 * {@link Step} when it is created.
+	 * 
+	 * @see org.springframework.beans.factory.BeanNameAware#setBeanName(java.lang.String)
+	 */
+	public void setBeanName(String name) {
+		this.name = name;
+	}
+
+	/**
+	 * Public getter for the String.
+	 * @return the name
+	 */
+	public String getName() {
+		return name;
+	}
+
+	/**
+	 * Public setter for the startLimit.
+	 * 
+	 * @param startLimit the startLimit to set
+	 */
+	public void setStartLimit(int startLimit) {
+		this.startLimit = startLimit;
+	}
+
+	/**
+	 * Public setter for the shouldAllowStartIfComplete.
+	 * 
+	 * @param allowStartIfComplete the shouldAllowStartIfComplete to set
+	 */
+	public void setAllowStartIfComplete(boolean allowStartIfComplete) {
+		this.allowStartIfComplete = allowStartIfComplete;
+	}
+
+	/**
+	 * @param itemReader the itemReader to set
+	 */
+	public void setItemReader(ItemReader itemReader) {
+		this.itemReader = itemReader;
+	}
+
+	/**
+	 * @param itemWriter the itemWriter to set
+	 */
+	public void setItemWriter(ItemWriter itemWriter) {
+		this.itemWriter = itemWriter;
+	}
+
+	/**
+	 * Public setter for {@link JobRepository}.
+	 * 
+	 * @param jobRepository is a mandatory dependence (no default).
+	 */
+	public void setJobRepository(JobRepository jobRepository) {
+		this.jobRepository = jobRepository;
+	}
+
+	/**
+	 * Public setter for the {@link PlatformTransactionManager}.
+	 * 
+	 * @param transactionManager the transaction manager to set
+	 */
+	public void setTransactionManager(PlatformTransactionManager transactionManager) {
+		this.transactionManager = transactionManager;
+	}
+
+	protected Object createInstance() throws Exception {
+		ItemOrientedStep step = new ItemOrientedStep(getName());
+		applyConfiguration(step);
+		return step;
+	}
+
+	/**
+	 * @param step
+	 * 
+	 */
+	protected void applyConfiguration(ItemOrientedStep step) {
+
+		Assert.notNull(getItemReader(), "ItemReader must be provided");
+		Assert.notNull(getItemWriter(), "ItemWriter must be provided");
+		Assert.notNull(jobRepository, "JobRepository must be provided");
+		Assert.notNull(transactionManager, "TransactionManager must be provided");
+
+		step.setItemReader(getItemReader());
+		step.setItemWriter(getItemWriter());
+		step.setTransactionManager(transactionManager);
+		step.setJobRepository(jobRepository);
+		step.setStartLimit(startLimit);
+		step.setAllowStartIfComplete(allowStartIfComplete);
+
+	}
+
+	public Class getObjectType() {
+		return Step.class;
+	}
+
+	/**
+	 * Public getter for the ItemReader.
+	 * @return the itemReader
+	 */
+	public ItemReader getItemReader() {
+		return itemReader;
+	}
+
+	/**
+	 * Public getter for the ItemWriter.
+	 * @return the itemWriter
+	 */
+	public ItemWriter getItemWriter() {
+		return itemWriter;
+	}
+
+}

spring-batch-execution/src/main/java/org/springframework/batch/execution/step/support/KitchenSinkStepFactoryBean.java

@@ -0,0 +1,160 @@
+/*
+ * Copyright 2006-2007 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.execution.step.support;
+
+import org.springframework.batch.core.domain.ItemSkipPolicy;
+import org.springframework.batch.execution.step.ItemOrientedStep;
+import org.springframework.batch.item.ItemKeyGenerator;
+import org.springframework.batch.repeat.RepeatOperations;
+import org.springframework.batch.repeat.exception.handler.ExceptionHandler;
+import org.springframework.batch.repeat.policy.SimpleCompletionPolicy;
+import org.springframework.batch.repeat.support.RepeatTemplate;
+import org.springframework.batch.retry.RetryPolicy;
+import org.springframework.batch.retry.callback.ItemReaderRetryCallback;
+import org.springframework.batch.retry.policy.ItemReaderRetryPolicy;
+import org.springframework.batch.retry.support.RetryTemplate;
+
+/**
+ * @author Dave Syer
+ * 
+ */
+public class KitchenSinkStepFactoryBean extends AbstractStepFactoryBean {
+
+	private int commitInterval = 0;
+
+	private Object[] listeners = new Object[0];
+
+	private ItemSkipPolicy itemSkipPolicy = new NeverSkipItemSkipPolicy();
+
+	private RepeatOperations stepOperations = new RepeatTemplate();
+
+	private RetryPolicy retryPolicy = null;
+
+	private ExceptionHandler exceptionHandler;
+
+	private ItemKeyGenerator itemKeyGenerator;
+
+	/**
+	 * Set the commit interval.
+	 * 
+	 * @param commitInterval
+	 */
+	public void setCommitInterval(int commitInterval) {
+		this.commitInterval = commitInterval;
+	}
+
+	/**
+	 * @param listeners
+	 */
+	public void setListeners(Object[] listeners) {
+		this.listeners = listeners;
+	}
+
+	/**
+	 * @param itemSkipPolicy
+	 */
+	public void setItemSkipPolicy(ItemSkipPolicy itemSkipPolicy) {
+		this.itemSkipPolicy = itemSkipPolicy;
+	}
+
+	/**
+	 * Public setter for the RepeatOperations.
+	 * @param stepOperations the stepOperations to set
+	 */
+	public void setStepOperations(RepeatOperations stepOperations) {
+		this.stepOperations = stepOperations;
+	}
+
+	/**
+	 * Public setter for the {@link RetryPolicy}.
+	 * @param retryPolicy the {@link RetryPolicy} to set
+	 */
+	public void setRetryPolicy(RetryPolicy retryPolicy) {
+		this.retryPolicy = retryPolicy;
+	}
+
+	/**
+	 * Set the {@link ExceptionHandler} for the step operations (outer loop).
+	 * @param exceptionHandler
+	 */
+	public void setExceptionHandler(ExceptionHandler exceptionHandler) {
+		this.exceptionHandler = exceptionHandler;
+	}
+
+	/**
+	 * Public setter for the {@link ItemKeyGenerator}. If it is not injected
+	 * but the reader or writer implement {@link ItemKeyGenerator}, one of
+	 * those will be used instead (preferring the reader to the writer if both
+	 * would be appropriate).
+	 * 
+	 * @param itemKeyGenerator the {@link ItemKeyGenerator} to set
+	 */
+	public void setItemKeyGenerator(ItemKeyGenerator itemKeyGenerator) {
+		this.itemKeyGenerator = itemKeyGenerator;
+	}
+
+	/**
+	 * @param step
+	 * 
+	 */
+	protected void applyConfiguration(ItemOrientedStep step) {
+		
+		super.applyConfiguration(step);
+		
+		step.setListeners(listeners);
+		step.setItemSkipPolicy(itemSkipPolicy);
+
+		if (retryPolicy != null) {
+			ItemReaderRetryCallback retryCallback = new ItemReaderRetryCallback(getItemReader(), getKeyGenerator(),
+					getItemWriter());
+			ItemReaderRetryPolicy itemProviderRetryPolicy = new ItemReaderRetryPolicy(retryPolicy);
+			RetryTemplate template = new RetryTemplate();
+			template.setRetryPolicy(itemProviderRetryPolicy);
+			step.setRetryOperations(template);
+			step.setRetryCallback(retryCallback);
+		}
+
+		if (commitInterval > 0) {
+			RepeatTemplate chunkOperations = new RepeatTemplate();
+			chunkOperations.setCompletionPolicy(new SimpleCompletionPolicy(commitInterval));
+			step.setChunkOperations(chunkOperations);
+		}
+
+		if (exceptionHandler != null && stepOperations instanceof RepeatTemplate) {
+			((RepeatTemplate) stepOperations).setExceptionHandler(exceptionHandler);
+			step.setStepOperations(stepOperations);
+		}
+	}
+
+	/**
+	 * @return an {@link ItemKeyGenerator} or null if none is found.
+	 */
+	private ItemKeyGenerator getKeyGenerator() {
+
+		if (itemKeyGenerator != null) {
+			return itemKeyGenerator;
+		}
+		if (getItemReader() instanceof ItemKeyGenerator) {
+			return (ItemKeyGenerator) getItemReader();
+		}
+		if (getItemWriter() instanceof ItemKeyGenerator) {
+			return (ItemKeyGenerator) getItemWriter();
+		}
+		return null;
+
+	}
+
+}

spring-batch-execution/src/test/java/org/springframework/batch/execution/launch/SimpleJobTests.java

@@ -36,6 +36,7 @@ import org.springframework.batch.execution.repository.dao.MapJobInstanceDao;
 import org.springframework.batch.execution.repository.dao.MapStepExecutionDao;
 import org.springframework.batch.execution.step.AbstractStep;
 import org.springframework.batch.execution.step.ItemOrientedStep;
+import org.springframework.batch.execution.step.support.AbstractStepFactoryBean;
 import org.springframework.batch.execution.step.support.SimpleStepFactoryBean;
 import org.springframework.batch.item.ItemReader;
 import org.springframework.batch.item.ItemWriter;
@@ -82,7 +83,7 @@ public class SimpleJobTests extends TestCase {
 	}
 	
 	private ItemOrientedStep getStep(String[] args) throws Exception {
-		SimpleStepFactoryBean factory = new SimpleStepFactoryBean();
+		AbstractStepFactoryBean factory = new SimpleStepFactoryBean();
 		factory.setSingleton(false);
 
 		List items = TransactionAwareProxyFactory.createTransactionalList();

spring-batch-execution/src/test/java/org/springframework/batch/execution/step/support/SimpleStepFactoryBeanTests.java

@@ -25,7 +25,7 @@ import org.springframework.batch.core.domain.Step;
  */
 public class SimpleStepFactoryBeanTests extends TestCase {
 
-	private SimpleStepFactoryBean factory = new SimpleStepFactoryBean();
+	private AbstractStepFactoryBean factory = new KitchenSinkStepFactoryBean();
 	
 	public void testType() throws Exception {
 		assertEquals(Step.class, factory.getObjectType());

spring-batch-execution/src/test/resources/job-configuration.xml

@@ -29,6 +29,10 @@
 					<bean
 						class="org.springframework.batch.execution.launch.EmptyItemWriter" />
 				</property>
+				<property name="jobRepository"
+					ref="simpleJobRepository" />
+				<property name="transactionManager"
+					ref="transactionManager" />
 			</bean>
 		</property>
 	</bean>

spring-batch-execution/src/test/resources/org/springframework/batch/execution/configuration/test-context.xml

@@ -20,7 +20,7 @@
 	<bean id="test-job"
 		class="org.springframework.batch.execution.job.JobSupport">
 		<property name="steps">
-			<bean id="step1" class="org.springframework.batch.execution.step.support.SimpleStepFactoryBean">
+			<bean id="step1" class="org.springframework.batch.execution.step.support.KitchenSinkStepFactoryBean">
 				<property name="itemReader" ref="itemReader" />
 				<property name="itemWriter" ref="itemWriter" />
 				<property name="jobRepository" ref="jobRepository" />