IN PROGRESS - issue BATCH-264: Dependencies among jobs

Add next= attribute to step.
This commit is contained in:
dsyer
2008-10-16 08:16:59 +00:00
parent 3a74ba0caf
commit e02092d78b
5 changed files with 131 additions and 4 deletions

View File

@@ -21,6 +21,7 @@ import java.util.List;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.job.StepTransition;
import org.springframework.beans.factory.BeanCreationException;
import org.springframework.beans.factory.config.RuntimeBeanReference;
import org.springframework.beans.factory.parsing.BeanComponentDefinition;
import org.springframework.beans.factory.support.RootBeanDefinition;
@@ -33,7 +34,7 @@ import org.w3c.dom.Element;
* Internal parser for the <step/> elements inside a job. A step element
* references a bean definition for a {@link Step} and goes on to (optionally)
* list a set of transitions from that step to others with <next on="pattern"
* to="stepName"/>. Used by the {@link JobParser}.
* to="stepName"/>. Used by the {@link JobParser}.
*
* @see JobParser
*
@@ -47,18 +48,27 @@ public class StepParser {
*
* @param element the <step/gt; element to parse
* @param parserContext the parser context for the bean factory
* @return a collection of bean definitions for {@link StepTransition} objects
* @return a collection of bean definitions for {@link StepTransition}
* objects
*/
public Collection<RuntimeBeanReference> parse(Element element, ParserContext parserContext) {
String refAttribute = element.getAttribute("name");
Collection<RuntimeBeanReference> list = new ArrayList<RuntimeBeanReference>();
String shortNextAttribute = element.getAttribute("next");
boolean hasNextAttribute = StringUtils.hasText(shortNextAttribute);
if (hasNextAttribute) {
list.add(getStepTransitionReference(parserContext, new RuntimeBeanReference(refAttribute), "*",
shortNextAttribute));
}
@SuppressWarnings("unchecked")
List<Element> nextElements = (List<Element>) DomUtils.getChildElementsByTagName(element, "next");
// If there are no next elements then this must be an end state
if (nextElements.isEmpty()) {
if (nextElements.isEmpty() && !hasNextAttribute) {
list.add(getStepTransitionReference(parserContext, new RuntimeBeanReference(refAttribute), "*", null));
}
else {
@@ -66,6 +76,10 @@ public class StepParser {
for (Element nextElement : nextElements) {
String onAttribute = nextElement.getAttribute("on");
String nextAttribute = nextElement.getAttribute("to");
if (hasNextAttribute && onAttribute.equals("*")) {
throw new BeanCreationException("Duplicate transition pattern found for '*' "
+ "(only specify one of next= attribute at step level and next element with on='*')");
}
list.add(getStepTransitionReference(parserContext, new RuntimeBeanReference(refAttribute), onAttribute,
nextAttribute));
}

View File

@@ -39,7 +39,7 @@
<xsd:annotation>
<xsd:documentation>
Defines a stage in job processing. The name attribute has to match the id of a bean definition for a
Step.
Step. The next attribute is a synonym for &lt;next on="*" .../&gt;
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
@@ -47,6 +47,7 @@
<xsd:element ref="next" minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
<xsd:attribute name="next" type="xsd:string" use="optional" />
</xsd:complexType>
</xsd:element>

View File

@@ -0,0 +1,81 @@
/*
* 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.core.configuration.xml;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.batch.core.BatchStatus;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.JobExecution;
import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.batch.core.repository.support.MapJobRepositoryFactoryBean;
import org.springframework.beans.factory.BeanDefinitionStoreException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.util.ClassUtils;
/**
* @author Dave Syer
*
*/
@ContextConfiguration
@RunWith(SpringJUnit4ClassRunner.class)
public class NextAttributeJobParserTests {
@Autowired
private Job job;
@Autowired
private JobRepository jobRepository;
@Before
public void setUp() {
MapJobRepositoryFactoryBean.clear();
}
@Test
public void testNextAttributeSunnyDay() throws Exception {
assertNotNull(job);
JobExecution jobExecution = jobRepository.createJobExecution(job.getName(), new JobParameters());
job.execute(jobExecution);
assertEquals(BatchStatus.COMPLETED, jobExecution.getStatus());
assertEquals(2, jobExecution.getStepExecutions().size());
}
@Test
public void testNextAttributeWithNestedElement() throws Exception {
try {
new ClassPathXmlApplicationContext(ClassUtils.addResourcePathToPackagePath(getClass(),
"NextAttributeFailureJobParserTests-context.xml"));
fail("Expected BeanCreationException");
}
catch (BeanDefinitionStoreException e) {
// expected
String message = e.getCause().getMessage();
assertTrue("Wrong message; " + message, message.startsWith("Duplicate transition pattern"));
}
}
}

View File

@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns="http://www.springframework.org/schema/batch" xmlns:beans="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/batch http://www.springframework.org/schema/batch/spring-batch-2.0.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
<beans:import resource="common-context.xml" />
<job id="job">
<step name="step1" next="step3">
<next on="*" to="step2" />
</step>
<step name="step2" />
<step name="step3" />
</job>
</beans:beans>

View File

@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns="http://www.springframework.org/schema/batch" xmlns:beans="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/batch http://www.springframework.org/schema/batch/spring-batch-2.0.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
<beans:import resource="common-context.xml" />
<job id="job">
<step name="step1" next="step2"/>
<step name="step2" />
</job>
</beans:beans>