BATCH-63: added <listeners> element to <simple-task>

Author: trisberg

spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/StepParser.java

@@ -191,6 +191,37 @@ public static RuntimeBeanReference getStateTransitionReference(ParserContext par
 
 	}
 
+	/**
+	 * @param element
+	 * @param parserContext
+	 * @return the TaskletStep bean
+	 */
+	protected RootBeanDefinition parseSimpleTask(Element element, ParserContext parserContext) {
+
+    	RootBeanDefinition bd = new RootBeanDefinition("org.springframework.batch.core.step.tasklet.TaskletStep", null, null);
+
+        String taskletBeanId = element.getAttribute("tasklet");
+        if (StringUtils.hasText(taskletBeanId)) {
+            RuntimeBeanReference taskletRef = new RuntimeBeanReference(taskletBeanId);
+            bd.getPropertyValues().addPropertyValue("tasklet", taskletRef);
+        }
+
+        String jobRepository = element.getAttribute("job-repository");
+        RuntimeBeanReference jobRepositoryRef = new RuntimeBeanReference(jobRepository);
+        bd.getPropertyValues().addPropertyValue("jobRepository", jobRepositoryRef);
+
+        String transactionManager = element.getAttribute("transaction-manager");
+        RuntimeBeanReference tx = new RuntimeBeanReference(transactionManager);
+        bd.getPropertyValues().addPropertyValue("transactionManager", tx);
+		
+        handleListenersElement(element, bd, parserContext, "stepExecutionListeners");
+        
+        bd.setRole(BeanDefinition.ROLE_SUPPORT);
+        
+        return bd;
+
+    }
+
 	/**
 	 * @param element
 	 * @param parserContext
@@ -301,7 +332,7 @@ protected RootBeanDefinition parseProcessTask(Element element, ParserContext par
 
         handleExceptionElement(element, bd, "fatal-exception-classes", "fatalExceptionClasses", isFaultTolerant);
 
-        handleListenersElement(element, bd, parserContext);
+        handleListenersElement(element, bd, parserContext, "listeners");
 
         handleRetryListenersElement(element, bd, parserContext);
 
@@ -352,7 +383,7 @@ private void handleExceptionElement(Element element, RootBeanDefinition bd,
 	}
 
 	@SuppressWarnings("unchecked")
-	private void handleListenersElement(Element element, RootBeanDefinition bd, ParserContext parserContext) {
+	private void handleListenersElement(Element element, RootBeanDefinition bd, ParserContext parserContext, String property) {
 		Element listenersElement = 
         	DomUtils.getChildElementByTagName(element, "listeners");
 		if (listenersElement != null) {
@@ -361,7 +392,7 @@ private void handleListenersElement(Element element, RootBeanDefinition bd, Pars
 					listenerBeans);
 	        ManagedList arguments = new ManagedList();
 	        arguments.addAll(listenerBeans);
-        	bd.getPropertyValues().addPropertyValue("listeners", arguments);
+        	bd.getPropertyValues().addPropertyValue(property, arguments);
 		}
 	}
 
@@ -448,33 +479,4 @@ private void handleStreamsElement(Element element, RootBeanDefinition bd, Parser
 		}
 	}
 
-	/**
-	 * @param element
-	 * @param parserContext
-	 * @return the TaskletStep bean
-	 */
-	protected RootBeanDefinition parseSimpleTask(Element element, ParserContext parserContext) {
-
-    	RootBeanDefinition bd = new RootBeanDefinition("org.springframework.batch.core.step.tasklet.TaskletStep", null, null);
-
-        String taskletBeanId = element.getAttribute("tasklet");
-        if (StringUtils.hasText(taskletBeanId)) {
-            RuntimeBeanReference taskletRef = new RuntimeBeanReference(taskletBeanId);
-            bd.getPropertyValues().addPropertyValue("tasklet", taskletRef);
-        }
-
-        String jobRepository = element.getAttribute("job-repository");
-        RuntimeBeanReference jobRepositoryRef = new RuntimeBeanReference(jobRepository);
-        bd.getPropertyValues().addPropertyValue("jobRepository", jobRepositoryRef);
-
-        String transactionManager = element.getAttribute("transaction-manager");
-        RuntimeBeanReference tx = new RuntimeBeanReference(transactionManager);
-        bd.getPropertyValues().addPropertyValue("transactionManager", tx);
-		
-        bd.setRole(BeanDefinition.ROLE_SUPPORT);
-        
-        return bd;
-
-    }
-
 }

spring-batch-core/src/main/resources/org/springframework/batch/core/configuration/xml/spring-batch-2.0.xsd

@@ -232,6 +232,21 @@
 	<xsd:complexType name="simpleTaskType">
 		<xsd:complexContent>
 			<xsd:extension base="stepDefType">
+				<xsd:sequence>
+					<xsd:element name="listeners" minOccurs="0" maxOccurs="1">
+						<xsd:annotation>
+							<xsd:documentation><![CDATA[
+							List of all listeners for the step definition
+							]]>
+							</xsd:documentation>
+						</xsd:annotation>
+						<xsd:complexType>
+							<xsd:sequence>
+								<xsd:element name="listener" type="listenerType" minOccurs="1" maxOccurs="unbounded"/>
+							</xsd:sequence>
+						</xsd:complexType>
+					</xsd:element>
+				</xsd:sequence>
 				<xsd:attribute name="tasklet" type="xsd:string" use="required">
 					<xsd:annotation>
 						<xsd:documentation><![CDATA[

spring-batch-core/src/test/java/org/springframework/batch/core/configuration/xml/StepWithSimpleTaskJobParserTests.java

@@ -29,6 +29,7 @@
 import org.springframework.batch.core.repository.JobRepository;
 import org.springframework.batch.core.repository.support.MapJobRepositoryFactoryBean;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 
@@ -48,8 +49,13 @@ public class StepWithSimpleTaskJobParserTests {
 	private JobRepository jobRepository;
 
 	@Autowired
+	@Qualifier("tasklet")
 	private AbstractTestComponent tasklet;
 
+	@Autowired
+	@Qualifier("listener")
+	private TestListener listener;
+	
 	@Before
 	public void setUp() {
 		MapJobRepositoryFactoryBean.clear();
@@ -63,5 +69,6 @@ public void testStepWithTask() throws Exception {
 		assertEquals(BatchStatus.COMPLETED, jobExecution.getStatus());
 		assertEquals(2, jobExecution.getStepExecutions().size());
 		assertTrue(tasklet.isExecuted());
+		assertTrue(listener.isExecuted());
 	}
 }

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

@@ -12,7 +12,11 @@
 			<next on="*" to="step2" />
 		</step>
 		<step name="step2">
-			<simple-task tasklet="tasklet"/>
+			<simple-task tasklet="tasklet">
+				<listeners>
+					<listener id="listener" class="org.springframework.batch.core.configuration.xml.TestListener"/>
+				</listeners>
+			</simple-task>
 		</step>
 	</job>