From b846c685509d737f8bd079f3f33997040960333e Mon Sep 17 00:00:00 2001
From: lucasward <lucasward@2e8e966d-6415-0410-94b9-dc4e65435d03>
Date: Wed, 27 Feb 2008 03:27:49 +0000
Subject: [PATCH] BATCH-392:removed saveExecutionContext from step (it's
 handled at a lower level now)

---
 .../src/main/resources/jobs/parallelJob.xml   |   2 -
 .../resources/simple-container-definition.xml |   4 +-
 .../sample/AbstractBatchLauncherTests.java    |   3 +-
 .../batch/sample/DefaultJobLoader.java        |   3 +-
 .../sample/dao/JdbcJobRepositoryTests.java    |   2 +-
 .../item/reader/StagingItemReaderTests.java   |   4 +-
 .../writer/StagingItemProcessorTests.java     |   4 +-
 .../batch/sample/tasklet/JobSupport.java      | 146 ++++++++++++++++++
 .../batch/sample/tasklet/StepSupport.java     | 117 ++++++++++++++
 9 files changed, 271 insertions(+), 14 deletions(-)
 create mode 100644 spring-batch-samples/src/test/java/org/springframework/batch/sample/tasklet/JobSupport.java
 create mode 100644 spring-batch-samples/src/test/java/org/springframework/batch/sample/tasklet/StepSupport.java

diff --git a/spring-batch-samples/src/main/resources/jobs/parallelJob.xml b/spring-batch-samples/src/main/resources/jobs/parallelJob.xml
index 9b23d98b9..c1ea3eb5a 100644
--- a/spring-batch-samples/src/main/resources/jobs/parallelJob.xml
+++ b/spring-batch-samples/src/main/resources/jobs/parallelJob.xml
@@ -42,8 +42,6 @@
 					</property>
 					<property name="commitInterval" value="2" />
 					<property name="startLimit" value="100" />
-					<property name="saveExecutionContext"
-						value="true" />
 					<property name="allowStartIfComplete" value="false" />
 				</bean>
 				<bean id="loading" parent="simpleStep">
diff --git a/spring-batch-samples/src/main/resources/simple-container-definition.xml b/spring-batch-samples/src/main/resources/simple-container-definition.xml
index 81b34e2d4..61f55281f 100644
--- a/spring-batch-samples/src/main/resources/simple-container-definition.xml
+++ b/spring-batch-samples/src/main/resources/simple-container-definition.xml
@@ -82,7 +82,7 @@
 	</bean>
 
 	<bean id="simpleJob"
-		class="org.springframework.batch.execution.job.simple.SimpleJob"
+		class="org.springframework.batch.execution.job.SimpleJob"
 		abstract="true">
 		<property name="jobRepository" ref="jobRepository" />
 		<property name="restartable" value="true" />
@@ -93,7 +93,6 @@
 		abstract="true">
 		<property name="jobRepository" ref="jobRepository" />
 		<property name="allowStartIfComplete" value="true" />
-		<property name="saveExecutionContext" value="true" />
 	</bean>
 
 	<bean id="simpleStep"
@@ -103,7 +102,6 @@
 		<property name="transactionManager" ref="transactionManager" />
 		<property name="jobRepository" ref="jobRepository" />
 		<property name="allowStartIfComplete" value="true" />
-		<property name="saveExecutionContext" value="true" />
 
 		<property name="exceptionHandler">
 			<bean
diff --git a/spring-batch-samples/src/test/java/org/springframework/batch/sample/AbstractBatchLauncherTests.java b/spring-batch-samples/src/test/java/org/springframework/batch/sample/AbstractBatchLauncherTests.java
index 3920789bf..ec5c27f97 100644
--- a/spring-batch-samples/src/test/java/org/springframework/batch/sample/AbstractBatchLauncherTests.java
+++ b/spring-batch-samples/src/test/java/org/springframework/batch/sample/AbstractBatchLauncherTests.java
@@ -17,7 +17,6 @@
 package org.springframework.batch.sample;
 
 import org.springframework.batch.core.domain.Job;
-import org.springframework.batch.core.domain.JobSupport;
 import org.springframework.batch.core.domain.JobParameters;
 import org.springframework.batch.execution.launch.JobLauncher;
 import org.springframework.context.ApplicationContext;
@@ -59,7 +58,7 @@ public abstract class AbstractBatchLauncherTests extends
 	}
 
 	/**
-	 * Public setter for the {@link JobSupport} property.
+	 * Public setter for the {@link Job} property.
 	 * 
 	 * @param job the job to set
 	 */
diff --git a/spring-batch-samples/src/test/java/org/springframework/batch/sample/DefaultJobLoader.java b/spring-batch-samples/src/test/java/org/springframework/batch/sample/DefaultJobLoader.java
index 527c93f6d..4c5f27a3c 100644
--- a/spring-batch-samples/src/test/java/org/springframework/batch/sample/DefaultJobLoader.java
+++ b/spring-batch-samples/src/test/java/org/springframework/batch/sample/DefaultJobLoader.java
@@ -8,7 +8,6 @@ import java.util.Iterator;
 import java.util.Map;
 
 import org.springframework.batch.core.domain.Job;
-import org.springframework.batch.core.domain.JobSupport;
 import org.springframework.batch.core.repository.ListableJobRegistry;
 import org.springframework.batch.core.repository.NoSuchJobException;
 import org.springframework.beans.BeanWrapperImpl;
@@ -51,7 +50,7 @@ public class DefaultJobLoader implements JobLoader,
 	public void loadResource(String path) {
 		ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(
 				new String[] { path }, applicationContext);
-		String[] names = context.getBeanNamesForType(JobSupport.class);
+		String[] names = context.getBeanNamesForType(Job.class);
 		for (int i = 0; i < names.length; i++) {
 			String name = names[i];
 			configurations.put(name, path);
diff --git a/spring-batch-samples/src/test/java/org/springframework/batch/sample/dao/JdbcJobRepositoryTests.java b/spring-batch-samples/src/test/java/org/springframework/batch/sample/dao/JdbcJobRepositoryTests.java
index c71cef0d3..b8fc5fa59 100644
--- a/spring-batch-samples/src/test/java/org/springframework/batch/sample/dao/JdbcJobRepositoryTests.java
+++ b/spring-batch-samples/src/test/java/org/springframework/batch/sample/dao/JdbcJobRepositoryTests.java
@@ -10,9 +10,9 @@ import java.util.Set;
 import org.springframework.batch.core.domain.BatchStatus;
 import org.springframework.batch.core.domain.JobExecution;
 import org.springframework.batch.core.domain.JobParameters;
-import org.springframework.batch.core.domain.JobSupport;
 import org.springframework.batch.core.repository.JobExecutionAlreadyRunningException;
 import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.batch.sample.tasklet.JobSupport;
 import org.springframework.test.AbstractTransactionalDataSourceSpringContextTests;
 import org.springframework.transaction.support.TransactionCallback;
 import org.springframework.transaction.support.TransactionTemplate;
diff --git a/spring-batch-samples/src/test/java/org/springframework/batch/sample/item/reader/StagingItemReaderTests.java b/spring-batch-samples/src/test/java/org/springframework/batch/sample/item/reader/StagingItemReaderTests.java
index 6d8fcab67..88ce57a3f 100644
--- a/spring-batch-samples/src/test/java/org/springframework/batch/sample/item/reader/StagingItemReaderTests.java
+++ b/spring-batch-samples/src/test/java/org/springframework/batch/sample/item/reader/StagingItemReaderTests.java
@@ -3,9 +3,7 @@ package org.springframework.batch.sample.item.reader;
 import org.springframework.batch.core.domain.JobExecution;
 import org.springframework.batch.core.domain.JobInstance;
 import org.springframework.batch.core.domain.JobParameters;
-import org.springframework.batch.core.domain.JobSupport;
 import org.springframework.batch.core.domain.StepExecution;
-import org.springframework.batch.core.domain.StepSupport;
 import org.springframework.batch.execution.scope.SimpleStepContext;
 import org.springframework.batch.execution.scope.StepContext;
 import org.springframework.batch.execution.scope.StepSynchronizationManager;
@@ -13,6 +11,8 @@ import org.springframework.batch.item.ExecutionContext;
 import org.springframework.batch.repeat.context.RepeatContextSupport;
 import org.springframework.batch.repeat.synch.RepeatSynchronizationManager;
 import org.springframework.batch.sample.item.writer.StagingItemWriter;
+import org.springframework.batch.sample.tasklet.JobSupport;
+import org.springframework.batch.sample.tasklet.StepSupport;
 import org.springframework.test.AbstractTransactionalDataSourceSpringContextTests;
 import org.springframework.util.ClassUtils;
 
diff --git a/spring-batch-samples/src/test/java/org/springframework/batch/sample/item/writer/StagingItemProcessorTests.java b/spring-batch-samples/src/test/java/org/springframework/batch/sample/item/writer/StagingItemProcessorTests.java
index b196d9048..80d4ffc67 100644
--- a/spring-batch-samples/src/test/java/org/springframework/batch/sample/item/writer/StagingItemProcessorTests.java
+++ b/spring-batch-samples/src/test/java/org/springframework/batch/sample/item/writer/StagingItemProcessorTests.java
@@ -3,11 +3,11 @@ package org.springframework.batch.sample.item.writer;
 import org.springframework.batch.core.domain.JobExecution;
 import org.springframework.batch.core.domain.JobInstance;
 import org.springframework.batch.core.domain.JobParameters;
-import org.springframework.batch.core.domain.JobSupport;
 import org.springframework.batch.core.domain.StepExecution;
-import org.springframework.batch.core.domain.StepSupport;
 import org.springframework.batch.execution.scope.SimpleStepContext;
 import org.springframework.batch.execution.scope.StepSynchronizationManager;
+import org.springframework.batch.sample.tasklet.JobSupport;
+import org.springframework.batch.sample.tasklet.StepSupport;
 import org.springframework.test.AbstractTransactionalDataSourceSpringContextTests;
 import org.springframework.util.ClassUtils;
 
diff --git a/spring-batch-samples/src/test/java/org/springframework/batch/sample/tasklet/JobSupport.java b/spring-batch-samples/src/test/java/org/springframework/batch/sample/tasklet/JobSupport.java
new file mode 100644
index 000000000..a7b03ebf5
--- /dev/null
+++ b/spring-batch-samples/src/test/java/org/springframework/batch/sample/tasklet/JobSupport.java
@@ -0,0 +1,146 @@
+/*
+ * 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.sample.tasklet;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.springframework.batch.core.domain.Job;
+import org.springframework.batch.core.domain.JobExecution;
+import org.springframework.batch.core.domain.Step;
+import org.springframework.batch.io.exception.BatchCriticalException;
+import org.springframework.beans.factory.BeanNameAware;
+import org.springframework.util.ClassUtils;
+
+/**
+ * Batch domain object representing a job. Job is an explicit abstraction
+ * representing the configuration of a job specified by a developer. It should
+ * be noted that restart policy is applied to the job as a whole and not to a
+ * step.
+ * 
+ * @author Lucas Ward
+ * @author Dave Syer
+ */
+public class JobSupport implements BeanNameAware, Job {
+
+	private List steps = new ArrayList();
+
+	private String name;
+
+	private boolean restartable = false;
+
+	private int startLimit = Integer.MAX_VALUE;
+
+	/**
+	 * Default constructor.
+	 */
+	public JobSupport() {
+		super();
+	}
+
+	/**
+	 * Convenience constructor to immediately add name (which is mandatory but
+	 * not final).
+	 * 
+	 * @param name
+	 */
+	public JobSupport(String name) {
+		super();
+		this.name = name;
+	}
+
+	/**
+	 * Set the name property if it is not already set. Because of the order of
+	 * the callbacks in a Spring container the name property will be set first
+	 * if it is present. Care is needed with bean definition inheritance - if a
+	 * parent bean has a name, then its children need an explicit name as well,
+	 * otherwise they will not be unique.
+	 * 
+	 * @see org.springframework.beans.factory.BeanNameAware#setBeanName(java.lang.String)
+	 */
+	public void setBeanName(String name) {
+		if (this.name == null) {
+			this.name = name;
+		}
+	}
+
+	/**
+	 * Set the name property. Always overrides the default value if this object
+	 * is a Spring bean.
+	 * 
+	 * @see #setBeanName(java.lang.String)
+	 */
+	public void setName(String name) {
+		this.name = name;
+	}
+
+	/* (non-Javadoc)
+	 * @see org.springframework.batch.core.domain.IJob#getName()
+	 */
+	public String getName() {
+		return name;
+	}
+
+	/* (non-Javadoc)
+	 * @see org.springframework.batch.core.domain.IJob#getSteps()
+	 */
+	public List getSteps() {
+		return steps;
+	}
+
+	public void setSteps(List steps) {
+		this.steps.clear();
+		this.steps.addAll(steps);
+	}
+
+	public void addStep(Step step) {
+		this.steps.add(step);
+	}
+
+	/* (non-Javadoc)
+	 * @see org.springframework.batch.core.domain.IJob#getStartLimit()
+	 */
+	public int getStartLimit() {
+		return startLimit;
+	}
+
+	public void setStartLimit(int startLimit) {
+		this.startLimit = startLimit;
+	}
+
+	public void setRestartable(boolean restartable) {
+		this.restartable = restartable;
+	}
+
+	/* (non-Javadoc)
+	 * @see org.springframework.batch.core.domain.IJob#isRestartable()
+	 */
+	public boolean isRestartable() {
+		return restartable;
+	}
+	
+	/* (non-Javadoc)
+	 * @see org.springframework.batch.core.domain.Job#run(org.springframework.batch.core.domain.JobExecution)
+	 */
+	public void execute(JobExecution execution) throws BatchCriticalException {
+		throw new UnsupportedOperationException("JobSupport does not provide an implementation of run().  Use a smarter subclass.");
+	}
+
+	public String toString() {
+		return ClassUtils.getShortName(getClass()) + ": [name=" + name + "]";
+	}
+}
diff --git a/spring-batch-samples/src/test/java/org/springframework/batch/sample/tasklet/StepSupport.java b/spring-batch-samples/src/test/java/org/springframework/batch/sample/tasklet/StepSupport.java
new file mode 100644
index 000000000..eb8b9f9b2
--- /dev/null
+++ b/spring-batch-samples/src/test/java/org/springframework/batch/sample/tasklet/StepSupport.java
@@ -0,0 +1,117 @@
+/*
+ * 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.sample.tasklet;
+
+import org.springframework.batch.core.domain.JobInterruptedException;
+import org.springframework.batch.core.domain.Step;
+import org.springframework.batch.core.domain.StepExecution;
+import org.springframework.batch.io.exception.BatchCriticalException;
+import org.springframework.beans.factory.BeanNameAware;
+
+/**
+ * Basic no-op support implementation for use as base class for {@link Step}. Implements {@link BeanNameAware} so that
+ * if no name is provided explicitly it will be inferred from the bean definition in Spring configuration.
+ * 
+ * @author Dave Syer
+ * 
+ */
+public class StepSupport implements Step, BeanNameAware {
+
+	private String name;
+
+	private int startLimit = Integer.MAX_VALUE;
+
+	private boolean allowStartIfComplete;
+
+	/**
+	 * Default constructor for {@link StepSupport}.
+	 */
+	public StepSupport() {
+		super();
+	}
+
+	/**
+	 * @param string
+	 */
+	public StepSupport(String string) {
+		super();
+		this.name = string;
+	}
+
+	public String getName() {
+		return this.name;
+	}
+
+	/**
+	 * Set the name property if it is not already set. Because of the order of the callbacks in a Spring container the
+	 * name property will be set first if it is present. Care is needed with bean definition inheritance - if a parent
+	 * bean has a name, then its children need an explicit name as well, otherwise they will not be unique.
+	 * 
+	 * @see org.springframework.beans.factory.BeanNameAware#setBeanName(java.lang.String)
+	 */
+	public void setBeanName(String name) {
+		if (this.name == null) {
+			this.name = name;
+		}
+	}
+
+	/**
+	 * Set the name property. Always overrides the default value if this object is a Spring bean.
+	 * 
+	 * @see #setBeanName(java.lang.String)
+	 */
+	public void setName(String name) {
+		this.name = name;
+	}
+
+	public int getStartLimit() {
+		return this.startLimit;
+	}
+
+	/**
+	 * Public setter for the startLimit.
+	 * 
+	 * @param startLimit the startLimit to set
+	 */
+	public void setStartLimit(int startLimit) {
+		this.startLimit = startLimit;
+	}
+
+	public boolean isAllowStartIfComplete() {
+		return this.allowStartIfComplete;
+	}
+
+	/**
+	 * Public setter for the shouldAllowStartIfComplete.
+	 * 
+	 * @param allowStartIfComplete the shouldAllowStartIfComplete to set
+	 */
+	public void setAllowStartIfComplete(boolean allowStartIfComplete) {
+		this.allowStartIfComplete = allowStartIfComplete;
+	}
+
+	/**
+	 * Not supported but provided so that tests can easily create a step.
+	 * 
+	 * @throws UnsupportedOperationException always
+	 * 
+	 * @see org.springframework.batch.core.domain.Step#execute(org.springframework.batch.core.domain.StepExecution)
+	 */
+	public void execute(StepExecution stepExecution) throws JobInterruptedException, BatchCriticalException {
+		throw new UnsupportedOperationException(
+		        "Cannot process a StepExecution.  Use a smarter subclass of StepSupport.");
+	}
+}