Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

OPEN - issue BATCH-385: Merge user attributes in StepContext with ExecutionContext

Browse Source 
http://jira.springframework.org/browse/BATCH-385

Refactored existing StepContextAware to StepListener implementations.  The BatchResourceFactoryBean is now a ProxyResource with a hint in docos and exception messages about registering with a step.
This commit is contained in:
dsyer
2008-02-29 11:31:21 +00:00
parent 42904865de
commit a53f8f6cbe
10 changed files with 320 additions and 151 deletions
Download Patch File Download Diff File Expand all files Collapse all files

179
spring-batch-execution/src/main/java/org/springframework/batch/execution/resource/BatchResourceFactoryBean.java → spring-batch-execution/src/main/java/org/springframework/batch/execution/resource/StepExecutionProxyResource.java
View File

@@ -17,18 +17,20 @@
package org.springframework.batch.execution.resource;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.URL;
import java.util.Iterator;
import java.util.Properties;
import java.util.Map.Entry;
import org.springframework.batch.core.domain.JobParameters;
import org.springframework.batch.core.domain.StepExecution;
import org.springframework.batch.core.domain.StepListener;
import org.springframework.batch.core.listener.StepListenerSupport;
import org.springframework.batch.core.runtime.JobParametersFactory;
import org.springframework.batch.execution.bootstrap.support.DefaultJobParametersFactory;
import org.springframework.batch.execution.scope.StepContext;
import org.springframework.batch.execution.scope.StepContextAware;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.config.AbstractFactoryBean;
import org.springframework.context.ResourceLoaderAware;
import org.springframework.core.io.FileSystemResourceLoader;
import org.springframework.core.io.Resource;
@@ -38,10 +40,10 @@ import org.springframework.util.StringUtils;
/**
* Strategy for locating different resources on the file system. For each unique
* step, the same file handle will be returned. A unique step is defined as
* having the same job identifier and step name. An external file mover (such as
* an EAI solution) should rename and move any input files to conform to the
* patter defined by the file pattern.<br/>
* step execution, the same file handle will be returned. A unique step is
* defined as having the same job instance and step name. An external file mover
* (such as an EAI solution) should rename and move any input files to conform
* to the pattern defined here.<br/>
*
* If no pattern is passed in, then following default is used:
*
@@ -61,17 +63,19 @@ import org.springframework.util.StringUtils;
* implementation of the Spring Core Resource abstractions, it would need to
* start with a double forward slash "//" to resolve to an absolute directory.<br/>
*
* It doesn't make much sense to use this factory unless it is step scoped, but
* note that it is thread safe only if it is step scoped and its mutators are
* not used except for configuration.
* To use this resource it must be initialised with a {@link StepExecution}.
* The best way to do that is to register it as a listener in the step that is
* going to need it. It is to enable this usage that the resource implements
* {@link StepListener}.
*
* @author Tomas Slanina
* @author Lucas Ward
* @author Dave Syer
*
* @see FactoryBean
* @see Resource
*/
public class BatchResourceFactoryBean extends AbstractFactoryBean implements ResourceLoaderAware, StepContextAware {
public class StepExecutionProxyResource extends StepListenerSupport implements Resource, ResourceLoaderAware,
StepListener {
private static final String JOB_NAME_PATTERN = "%JOB_NAME%";
@@ -81,15 +85,107 @@ public class BatchResourceFactoryBean extends AbstractFactoryBean implements Res
private String filePattern = DEFAULT_PATTERN;
private String jobName = null;
private String stepName = "";
private JobParametersFactory jobParametersFactory = new DefaultJobParametersFactory();
private ResourceLoader resourceLoader = new FileSystemResourceLoader();
private Properties properties;
private Resource delegate;
/**
* @param relativePath
* @return
* @throws IOException
* @see org.springframework.core.io.Resource#createRelative(java.lang.String)
*/
public Resource createRelative(String relativePath) throws IOException {
Assert.state(delegate != null, "The delegate resource has not been initialised. "
+ "Remember to register this object as a StepListener.");
return delegate.createRelative(relativePath);
}
/**
* @return
* @see org.springframework.core.io.Resource#exists()
*/
public boolean exists() {
Assert.state(delegate != null, "The delegate resource has not been initialised. "
+ "Remember to register this object as a StepListener.");
return delegate.exists();
}
/**
* @return
* @see org.springframework.core.io.Resource#getDescription()
*/
public String getDescription() {
Assert.state(delegate != null, "The delegate resource has not been initialised. "
+ "Remember to register this object as a StepListener.");
return delegate.getDescription();
}
/**
* @return
* @throws IOException
* @see org.springframework.core.io.Resource#getFile()
*/
public File getFile() throws IOException {
Assert.state(delegate != null, "The delegate resource has not been initialised. "
+ "Remember to register this object as a StepListener.");
return delegate.getFile();
}
/**
* @return
* @see org.springframework.core.io.Resource#getFilename()
*/
public String getFilename() {
Assert.state(delegate != null, "The delegate resource has not been initialised. "
+ "Remember to register this object as a StepListener.");
return delegate.getFilename();
}
/**
* @return
* @throws IOException
* @see org.springframework.core.io.InputStreamSource#getInputStream()
*/
public InputStream getInputStream() throws IOException {
Assert.state(delegate != null, "The delegate resource has not been initialised. "
+ "Remember to register this object as a StepListener.");
return delegate.getInputStream();
}
/**
* @return
* @throws IOException
* @see org.springframework.core.io.Resource#getURI()
*/
public URI getURI() throws IOException {
Assert.state(delegate != null, "The delegate resource has not been initialised. "
+ "Remember to register this object as a StepListener.");
return delegate.getURI();
}
/**
* @return
* @throws IOException
* @see org.springframework.core.io.Resource#getURL()
*/
public URL getURL() throws IOException {
Assert.state(delegate != null, "The delegate resource has not been initialised. "
+ "Remember to register this object as a StepListener.");
return delegate.getURL();
}
/**
* @return
* @see org.springframework.core.io.Resource#isOpen()
*/
public boolean isOpen() {
Assert.state(delegate != null, "The delegate resource has not been initialised. "
+ "Remember to register this object as a StepListener.");
return delegate.isOpen();
}
/**
* Public setter for the {@link JobParametersFactory} used to translate
@@ -119,34 +215,6 @@ public class BatchResourceFactoryBean extends AbstractFactoryBean implements Res
this.resourceLoader = resourceLoader;
}
/**
* Collect the properties of the enclosing {@link StepExecution} that will
* be needed to create a file name.
*
* @see org.springframework.batch.execution.scope.StepContextAware#setStepScopeContext(org.springframework.core.AttributeAccessor)
*/
public void setStepContext(StepContext context) {
Assert.state(context.getStepExecution() != null, "The StepContext does not have an execution.");
StepExecution execution = context.getStepExecution();
stepName = execution.getStepName();
jobName = execution.getJobExecution().getJobInstance().getJobName();
properties = jobParametersFactory.getProperties(execution.getJobExecution().getJobInstance().getJobParameters());
}
/**
* Returns the Resource representing the file defined by the file pattern.
*
* @see FactoryBean#getObject()
* @return a resource representing the file on the file system.
*/
protected Object createInstance() {
return resourceLoader.getResource(createFileName());
}
public Class getObjectType() {
return Resource.class;
}
/**
* helper method for <code>createFileName()</code>
*/
@@ -168,8 +236,11 @@ public class BatchResourceFactoryBean extends AbstractFactoryBean implements Res
*
* Deliberate package access, so that the method can be accessed by unit
* tests
* @param jobName
* @param stepName
* @param properties
*/
private String createFileName() {
private String createFileName(String jobName, String stepName, Properties properties) {
Assert.notNull(filePattern, "filename pattern is null");
String fileName = filePattern;
@@ -192,4 +263,18 @@ public class BatchResourceFactoryBean extends AbstractFactoryBean implements Res
this.filePattern = replacePattern(filePattern, "\\", File.separator);
}
/**
* Collect the properties of the enclosing {@link StepExecution} that will
* be needed to create a file name.
*
* @see org.springframework.batch.core.domain.StepListener#beforeStep(org.springframework.batch.core.domain.StepExecution)
*/
public void beforeStep(StepExecution execution) {
String stepName = execution.getStepName();
String jobName = execution.getJobExecution().getJobInstance().getJobName();
Properties properties = jobParametersFactory.getProperties(execution.getJobExecution().getJobInstance()
.getJobParameters());
delegate = resourceLoader.getResource(createFileName(jobName, stepName, properties));
}
}

2
spring-batch-execution/src/main/java/org/springframework/batch/execution/step/ItemOrientedStep.java
View File

@@ -268,8 +268,8 @@ public class ItemOrientedStep extends AbstractStep implements InitializingBean {
// Execute step level listeners *after* the execution context is
// fixed in the step. E.g. ItemStream instances need the the same
// reference to the ExecutionContext as the step execution.
listener.open(stepExecution.getExecutionContext());
listener.beforeStep(stepExecution);
listener.open(stepExecution.getExecutionContext());
status = stepOperations.iterate(new RepeatCallback() {

44
spring-batch-execution/src/test/java/org/springframework/batch/execution/resource/BatchResourceFactoryBeanTests.java → spring-batch-execution/src/test/java/org/springframework/batch/execution/resource/StepExecutionProxyResourceTests.java
View File

@@ -26,26 +26,26 @@ import org.springframework.batch.core.domain.JobInstance;
import org.springframework.batch.core.domain.JobParameters;
import org.springframework.batch.core.domain.JobParametersBuilder;
import org.springframework.batch.core.domain.Step;
import org.springframework.batch.core.domain.StepExecution;
import org.springframework.batch.execution.job.JobSupport;
import org.springframework.batch.execution.scope.SimpleStepContext;
import org.springframework.batch.execution.step.StepSupport;
import org.springframework.core.io.ByteArrayResource;
import org.springframework.core.io.DefaultResourceLoader;
import org.springframework.core.io.Resource;
/**
* Unit tests for {@link BatchResourceFactoryBean}
* Unit tests for {@link StepExecutionProxyResource}
*
* @author robert.kasanicky
* @author Lucas Ward
* @author Dave Syer
*/
public class BatchResourceFactoryBeanTests extends TestCase {
public class StepExecutionProxyResourceTests extends TestCase {
/**
* Object under test
*/
private BatchResourceFactoryBean resourceFactory = new BatchResourceFactoryBean();
private StepExecutionProxyResource resource = new StepExecutionProxyResource();
private char pathsep = File.separatorChar;
@@ -53,7 +53,7 @@ public class BatchResourceFactoryBeanTests extends TestCase {
private JobInstance jobInstance;
private Step step;
private StepExecution stepExecution;
/**
* mock step context
@@ -63,10 +63,9 @@ public class BatchResourceFactoryBeanTests extends TestCase {
jobInstance = new JobInstance(new Long(0), new JobParameters(), new JobSupport("testJob"));
JobExecution jobExecution = jobInstance.createJobExecution();
step = new StepSupport("bar");
resourceFactory.setStepContext(new SimpleStepContext(jobExecution.createStepExecution(step)));
resourceFactory.afterPropertiesSet();
Step step = new StepSupport("bar");
stepExecution = jobExecution.createStepExecution(step);
resource.beforeStep(stepExecution);
}
@@ -77,15 +76,10 @@ public class BatchResourceFactoryBeanTests extends TestCase {
doTestPathName("bar.txt", path);
}
public void testObjectType() throws Exception {
assertEquals(Resource.class, resourceFactory.getObjectType());
}
public void testNullFilePattern() throws Exception {
resourceFactory = new BatchResourceFactoryBean();
resourceFactory.setFilePattern(null);
resource.setFilePattern(null);
try {
resourceFactory.getObject();
resource.beforeStep(stepExecution);
fail("Expected IllegalArgumentException");
}
catch (IllegalArgumentException e) {
@@ -94,7 +88,8 @@ public class BatchResourceFactoryBeanTests extends TestCase {
}
public void testNonStandardFilePattern() throws Exception {
resourceFactory.setFilePattern("foo/data/%JOB_NAME%/" + "%STEP_NAME%-job");
resource.setFilePattern("foo/data/%JOB_NAME%/" + "%STEP_NAME%-job");
resource.beforeStep(stepExecution);
doTestPathName("bar-job", "foo" + pathsep + "data" + pathsep);
}
@@ -102,27 +97,24 @@ public class BatchResourceFactoryBeanTests extends TestCase {
jobInstance = new JobInstance(new Long(0), new JobParametersBuilder().addString("job.key", "spam")
.toJobParameters(), new JobSupport("testJob"));
JobExecution jobExecution = jobInstance.createJobExecution();
step = new StepSupport("bar");
resourceFactory.setStepContext(new SimpleStepContext(jobExecution.createStepExecution(step)));
resourceFactory.setFilePattern("foo/data/%JOB_NAME%/%job.key%-foo");
Step step = new StepSupport("bar");
resource.setFilePattern("foo/data/%JOB_NAME%/%job.key%-foo");
resource.beforeStep(jobExecution.createStepExecution(step));
doTestPathName("spam-foo", "foo" + pathsep + "data" + pathsep);
}
public void testResoureLoaderAware() throws Exception {
resourceFactory = new BatchResourceFactoryBean();
resourceFactory.setSingleton(false);
resourceFactory.setResourceLoader(new DefaultResourceLoader() {
resource = new StepExecutionProxyResource();
resource.setResourceLoader(new DefaultResourceLoader() {
public Resource getResource(String location) {
return new ByteArrayResource("foo".getBytes());
}
});
Resource resource = (Resource) resourceFactory.getObject();
assertNotNull(resource);
resource.beforeStep(stepExecution);
assertTrue(resource.exists());
}
private void doTestPathName(String filename, String path) throws Exception, IOException {
Resource resource = (Resource) resourceFactory.getObject();
String returnedPath = resource.getFile().getAbsolutePath();
String absolutePath = new File(path + jobInstance.getJobName() + pathsep + filename).getAbsolutePath();
assertEquals(absolutePath, returnedPath);

34
spring-batch-execution/src/test/java/org/springframework/batch/execution/step/ItemOrientedStepTests.java
View File

@@ -30,6 +30,7 @@ import org.springframework.batch.core.domain.JobInterruptedException;
import org.springframework.batch.core.domain.JobParameters;
import org.springframework.batch.core.domain.StepContribution;
import org.springframework.batch.core.domain.StepExecution;
import org.springframework.batch.core.domain.StepListener;
import org.springframework.batch.core.listener.StepListenerSupport;
import org.springframework.batch.execution.job.JobSupport;
import org.springframework.batch.execution.repository.SimpleJobRepository;
@@ -387,6 +388,20 @@ public class ItemOrientedStepTests extends TestCase {
assertEquals(2, list.size());
}
public void testListenerCalledBeforeStreamOpened() throws Exception {
itemOrientedStep.setListeners(new BatchListener[] {new MockRestartableItemReader() {
public void beforeStep(StepExecution stepExecution) {
list.add("foo");
}
public void open(ExecutionContext executionContext) throws StreamException {
assertEquals(1, list.size());
}
}});
StepExecution stepExecution = new StepExecution(itemOrientedStep, new JobExecution(jobInstance));
itemOrientedStep.execute(stepExecution);
assertEquals(1, list.size());
}
public void testDirectlyInjectedListenerOnError() throws Exception {
itemOrientedStep.setListeners(new Object[] {new StepListenerSupport() {
public ExitStatus onErrorInStep(Throwable e) {
@@ -634,7 +649,7 @@ public class ItemOrientedStepTests extends TestCase {
}
}
private class MockRestartableItemReader extends ItemStreamSupport implements ItemReader {
private class MockRestartableItemReader extends ItemStreamSupport implements ItemReader, StepListener {
private boolean getExecutionAttributesCalled = false;
@@ -663,18 +678,23 @@ public class ItemOrientedStepTests extends TestCase {
return restoreFromCalled;
}
public void open(ExecutionContext executionContext) throws StreamException {
}
public void close(ExecutionContext executionContext) throws StreamException {
}
public void mark() throws MarkFailedException {
}
public void reset() throws ResetFailedException {
}
public ExitStatus afterStep() {
return null;
}
public void beforeStep(StepExecution stepExecution) {
}
public ExitStatus onErrorInStep(Throwable e) {
return null;
}
}
}