From: Olivier Capillon <olivier.capillon@gmail.com>
Date: Fri, 21 May 2010 11:01:47 +0000 (+0000)
Subject: slc flow namespace extended (flow:variables, list, map, etc. in flow:arg and spec... 
X-Git-Tag: argeo-slc-2.1.7~1295
X-Git-Url: http://git.argeo.org/?a=commitdiff_plain;h=30463809ad9db9e57ea3ffce5b2b22e10ec0bf1c;p=gpl%2Fargeo-slc.git

slc flow namespace extended (flow:variables, list, map, etc. in flow:arg and spec default values)

git-svn-id: https://svn.argeo.org/slc/trunk@3585 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc
---

diff --git a/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/xml/ExecutionScopeDecorator.java b/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/xml/ExecutionScopeDecorator.java
index e5738b168..726f34230 100644
--- a/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/xml/ExecutionScopeDecorator.java
+++ b/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/xml/ExecutionScopeDecorator.java
@@ -1,44 +1,36 @@
 package org.argeo.slc.core.execution.xml;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
 import org.springframework.aop.scope.ScopedProxyUtils;
 import org.springframework.beans.factory.config.BeanDefinitionHolder;
 import org.springframework.beans.factory.parsing.BeanComponentDefinition;
 import org.springframework.beans.factory.xml.BeanDefinitionDecorator;
 import org.springframework.beans.factory.xml.ParserContext;
+import org.w3c.dom.Element;
 import org.w3c.dom.Node;
 
 /**
- * Inspired by org.springframework.aop.config.AopNamespaceHandler
- * Conceived to replace Element "aop:scoped-proxy" by an attribute.
- * Does not work correctly with other attribute decorators (e.g. 
- * p namespace) since this decorator needs to be called after all
- * properties have been set on target bean. 
+ * Inspired by org.springframework.aop.config.ScopedProxyBeanDefinitionDecorator
  */
-public class ExecutionScopeDecorator implements BeanDefinitionDecorator {
-	private Log log = LogFactory.getLog(ExecutionScopeDecorator.class);
+public class ExecutionScopeDecorator implements BeanDefinitionDecorator {	
+	private static final String PROXY_TARGET_CLASS = "proxy-target-class";	
 	
 	public BeanDefinitionHolder decorate(Node node,
 			BeanDefinitionHolder definition, ParserContext parserContext) {
 		
-		Boolean isVar = Boolean.valueOf(node.getNodeValue());
-				
-		if(isVar) {
-			definition.getBeanDefinition().setScope("execution");
-			
-			boolean proxyTargetClass = true;
-			
-			// Register the original bean definition as it will be referenced by the scoped proxy and is relevant for tooling (validation, navigation).
-			String targetBeanName = ScopedProxyUtils.getTargetBeanName(definition.getBeanName());
-			parserContext.getReaderContext().fireComponentRegistered(new BeanComponentDefinition(definition.getBeanDefinition(), targetBeanName));
-			
-			log.debug("Decorating bean " + definition.getBeanName());
-			
-			return ScopedProxyUtils.createScopedProxy(definition, parserContext.getRegistry(), proxyTargetClass);		
-		}
-		else {
-			return definition;
+		definition.getBeanDefinition().setScope("execution");
+		
+		boolean proxyTargetClass = true;
+		if (node instanceof Element) {
+			Element ele = (Element) node;
+			if (ele.hasAttribute(PROXY_TARGET_CLASS)) {
+				proxyTargetClass = Boolean.valueOf(ele.getAttribute(PROXY_TARGET_CLASS)).booleanValue();
+			}
 		}
+		
+		// Register the original bean definition as it will be referenced by the scoped proxy and is relevant for tooling (validation, navigation).
+		String targetBeanName = ScopedProxyUtils.getTargetBeanName(definition.getBeanName());
+		parserContext.getReaderContext().fireComponentRegistered(new BeanComponentDefinition(definition.getBeanDefinition(), targetBeanName));
+		
+		return ScopedProxyUtils.createScopedProxy(definition, parserContext.getRegistry(), proxyTargetClass);		
 	}
 }
diff --git a/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/xml/FlowNamespaceHandler.java b/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/xml/FlowNamespaceHandler.java
index f092bb1ac..a1d6912aa 100644
--- a/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/xml/FlowNamespaceHandler.java
+++ b/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/xml/FlowNamespaceHandler.java
@@ -10,7 +10,17 @@ public class FlowNamespaceHandler extends NamespaceHandlerSupport {
 		registerBeanDefinitionDecoratorForAttribute("as-flow",
 				new AsFlowDecorator());
 		registerBeanDefinitionParser("param", new ParamDecorator());
-//		registerBeanDefinitionDecoratorForAttribute("var", new ExecutionScopeDecorator());
+		 
+		// The objective was to replace
+		// - attribute scope="execution"
+		// - and element "aop:scoped-proxy" 
+		// by a single attribute, using an attribute decorator 
+		// this does not work correctly with other attribute decorators (e.g. 
+		// p namespace) since this decorator needs to be called after all
+		// properties have been set on target bean. 
+		// It works properly with element decorators (called after all attribute
+		// decorators
+		registerBeanDefinitionDecorator("variable", new ExecutionScopeDecorator());
 	}
 
 }
diff --git a/runtime/org.argeo.slc.core/src/main/resources/org/argeo/slc/core/execution/xml/slc-flow-0.12.xsd b/runtime/org.argeo.slc.core/src/main/resources/org/argeo/slc/core/execution/xml/slc-flow-0.12.xsd
index 884faaa21..7af852fe9 100644
--- a/runtime/org.argeo.slc.core/src/main/resources/org/argeo/slc/core/execution/xml/slc-flow-0.12.xsd
+++ b/runtime/org.argeo.slc.core/src/main/resources/org/argeo/slc/core/execution/xml/slc-flow-0.12.xsd
@@ -26,7 +26,7 @@
 			<xsd:complexContent>
 				<xsd:extension base="beans:identifiedType">
 					<xsd:sequence>
-						<xsd:element ref="beans:description" minOccurs="0"/>
+						<xsd:element ref="beans:description" minOccurs="0" />
 						<xsd:sequence>
 							<xsd:element name="arg" minOccurs="0" maxOccurs="unbounded"
 								type="flow:argType">
@@ -96,7 +96,7 @@
 			<xsd:complexContent>
 				<xsd:extension base="beans:identifiedType">
 					<xsd:sequence>
-						<xsd:element ref="beans:description" minOccurs="0"/>
+						<xsd:element ref="beans:description" minOccurs="0" />
 						<xsd:choice minOccurs="0" maxOccurs="unbounded">
 							<xsd:element name="primitive" type="flow:primitiveSpecAttributeType"
 								minOccurs="0" maxOccurs="unbounded">
@@ -134,6 +134,10 @@
 					<xsd:choice minOccurs="1" maxOccurs="1">
 						<xsd:element ref="beans:bean" />
 						<xsd:element ref="beans:ref" />
+						<xsd:element ref="beans:list"/>
+						<xsd:element ref="beans:set"/>
+						<xsd:element ref="beans:map"/>
+						<xsd:element ref="beans:props"/>							
 					</xsd:choice>
 				</xsd:complexType>
 			</xsd:element>
@@ -270,6 +274,10 @@
 			<xsd:element ref="beans:bean" />
 			<xsd:element ref="beans:ref" />
 			<xsd:element ref="flow:param" />
+			<xsd:element ref="beans:list"/>
+			<xsd:element ref="beans:set"/>
+			<xsd:element ref="beans:map"/>
+			<xsd:element ref="beans:props"/>			
 		</xsd:choice>
 		<xsd:attribute name="name" use="required" type="xsd:string">
 			<xsd:annotation>
@@ -302,15 +310,35 @@
 			]]></xsd:documentation>
 		</xsd:annotation>
 	</xsd:attribute>
-<!--
-	<xsd:attribute name="var" type="xsd:boolean">
-		<xsd:annotation>
-			<xsd:documentation><![CDATA[
-	If true, the decorated bean is set to scope execution and proxied.
+	<!--
+		<xsd:attribute name="var" type="xsd:boolean"> <xsd:annotation>
+		<xsd:documentation><![CDATA[ If true, the decorated bean is set to
+		scope execution and proxied. ]]></xsd:documentation> </xsd:annotation>
+		</xsd:attribute>
+	-->
+
+	<xsd:element name="variable">
+		<xsd:complexType>
+			<xsd:annotation>
+				<xsd:documentation><![CDATA[
+	Marks a bean definition as being variable, i.e. a scoped proxy of scope execution 
 			]]></xsd:documentation>
-		</xsd:annotation>
-	</xsd:attribute>
--->
+			</xsd:annotation>
+			<xsd:attribute name="proxy-target-class" type="xsd:boolean"
+				default="true">
+				<xsd:annotation>
+					<xsd:documentation><![CDATA[
+						Are class-based (CGLIB) proxies to be created?
+						This is the default;
+						in order to switch to standard Java
+						interface-based proxies, turn this flag to
+						"false".
+					]]></xsd:documentation>
+				</xsd:annotation>
+			</xsd:attribute>
+		</xsd:complexType>
+	</xsd:element>
+	
 	<xsd:element name="param">
 		<xsd:annotation>
 			<xsd:documentation><![CDATA[
@@ -339,6 +367,6 @@
 	</xsd:element>
 
 	<!-- for description tags, beans or current namespace are valid -->
-	<xsd:element name="description" substitutionGroup="beans:description"/>
+	<xsd:element name="description" substitutionGroup="beans:description" />
 
 </xsd:schema>
\ No newline at end of file
diff --git a/runtime/org.argeo.slc.core/src/test/java/org/argeo/slc/core/execution/xml/FlowNamespaceTest.java b/runtime/org.argeo.slc.core/src/test/java/org/argeo/slc/core/execution/xml/FlowNamespaceTest.java
index b9f035db1..6f7a22206 100644
--- a/runtime/org.argeo.slc.core/src/test/java/org/argeo/slc/core/execution/xml/FlowNamespaceTest.java
+++ b/runtime/org.argeo.slc.core/src/test/java/org/argeo/slc/core/execution/xml/FlowNamespaceTest.java
@@ -1,6 +1,8 @@
 package org.argeo.slc.core.execution.xml;
 
 import org.argeo.slc.core.execution.AbstractExecutionFlowTestCase;
+import org.argeo.slc.core.test.SimpleTestResult;
+import org.argeo.slc.execution.ExecutionContext;
 import org.argeo.slc.execution.ExecutionFlow;
 import org.springframework.context.ConfigurableApplicationContext;
 
@@ -16,5 +18,30 @@ public class FlowNamespaceTest extends AbstractExecutionFlowTestCase {
 		((ExecutionFlow) applicationContext.getBean("flow1")).run();
 		((ExecutionFlow) applicationContext.getBean("flow2")).run();
 		((ExecutionFlow) applicationContext.getBean("flow3")).run();
+		
+		validateTestResult((SimpleTestResult) applicationContext
+				.getBean("testResult"));		
 	}	
+	
+	public void testAdvancedExecution() throws Exception {
+		ConfigurableApplicationContext applicationContext = createApplicationContext("advanced.xml");
+		
+		ExecutionContext executionContext = (ExecutionContext) applicationContext
+		.getBean("executionContext");
+		executionContext.setVariable("param2", 4);
+		
+		((ExecutionFlow) applicationContext.getBean("flow4")).run();
+		
+		validateTestResult((SimpleTestResult) applicationContext
+				.getBean("testResult"));		
+	}	
+	
+	public void testContainers() throws Exception {
+		ConfigurableApplicationContext applicationContext = createApplicationContext("containers.xml");
+		((ExecutionFlow) applicationContext.getBean("test.list.flow1")).run();
+		((ExecutionFlow) applicationContext.getBean("test.list.flow2")).run();
+		
+		validateTestResult((SimpleTestResult) applicationContext
+				.getBean("testResult"));			
+	}
 }
diff --git a/runtime/org.argeo.slc.core/src/test/resources/org/argeo/slc/core/execution/xml/advanced.xml b/runtime/org.argeo.slc.core/src/test/resources/org/argeo/slc/core/execution/xml/advanced.xml
index 4745a10c1..41164516a 100644
--- a/runtime/org.argeo.slc.core/src/test/resources/org/argeo/slc/core/execution/xml/advanced.xml
+++ b/runtime/org.argeo.slc.core/src/test/resources/org/argeo/slc/core/execution/xml/advanced.xml
@@ -1,72 +1,60 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <beans xmlns="http://www.springframework.org/schema/beans"
 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
-	xmlns:aop="http://www.springframework.org/schema/aop" xmlns:flow="http://www.argeo.org/schema/slc-flow"
+	xmlns:flow="http://www.argeo.org/schema/slc-flow"
 	xsi:schemaLocation="
 	http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
 	http://www.springframework.org/schema/lang http://www.springframework.org/schema/lang/spring-lang-2.5.xsd
-	http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd
 	http://www.argeo.org/schema/slc-flow http://www.argeo.org/schema/slc-flow-0.12.xsd">
 
 	<import resource="classpath:org/argeo/slc/core/execution/spring.xml" />
 	<import resource="classpath:/org/argeo/slc/core/test/spring.xml" />
 
+	<bean id="testResult" class="org.argeo.slc.core.test.SimpleTestResult" />
+
+	<bean id="testDef" class="org.argeo.slc.core.test.BasicTestDefinition" />
+
+	<bean id="testRunTemplate" class="org.argeo.slc.core.test.SimpleTestRun" abstract="true">
+		<property name="testDefinition" ref="testDef" />
+		<property name="testResult" ref="testResult"/>
+	</bean>	
+
 	<flow:spec id="advanced.spec">
 		<flow:description>spec description</flow:description>
 		<flow:primitive name="param1" isParameter="true"
 			type="integer" />
-		<flow:ref name="param2" targetClass="org.argeo.slc.core.test.BasicTestData"
-			isParameter="true">
-			<flow:value>
-				<bean class="org.argeo.slc.core.test.BasicTestData">
-					<property name="expected" value="tata" />
-					<property name="reached" value="tata" />
-				</bean>				
-			</flow:value>
-		</flow:ref>	
+		<flow:primitive name="param2" isParameter="true"
+			type="integer" />			
 	</flow:spec>
 
 
 	<flow:flow id="advanced.flowTemplate" abstract="true" spec="advanced.spec"
 		path="/path">
 		<description>flow description</description>
- 		<bean parent="task.echo"
-			scope="execution">
-			<property name="message" value="Advanced: param1=@{param1}" />
-			<aop:scoped-proxy/>
+ 		<bean parent="task.echo">
+			<property name="message" value="Advanced: param1=@{param1}, param2=@{param2}" />
+			<flow:variable/>
 		</bean> 
  		<flow:flow>
- 			<bean parent="task.echo" p:message="Flow in Flow - param1=@{param1}" />
+ 			<bean parent="task.echo" p:message="Flow in Flow - param1=@{param1}, param2=@{param2} [Not variable]" />
  		</flow:flow>
  
-	 	<bean class="org.argeo.slc.core.test.SimpleTestRun">
-			<property name="testDefinition">
-				<bean class="org.argeo.slc.core.test.BasicTestDefinition" />
-			</property>
+		<bean parent="testRunTemplate">
 			<property name="testData">
-				<flow:param name="param2" />
-			</property>
-
-			<property name="testResult">
-				<bean parent="slcDefault.test.basicTreeTestResult" scope="execution">
-					<property name="attributes">
-						<map>
-							<entry key="param1" value="@{param1}" />
-						</map>
-					</property>
-					<aop:scoped-proxy />
+				<bean class="org.argeo.slc.core.test.BasicTestData">
+					<flow:variable/>
+					<property name="expected" value="@{param1}" />
+					<property name="reached" value="@{param2}" />
 				</bean>
-			</property>
+			</property>					
 		</bean>
  
 	</flow:flow>
 
 	<flow:flow id="advanced.flowTemplate2" abstract="true" spec="advanced.spec"
 		path="/path">
- 		<bean parent="task.echo"
-			scope="execution">
-			<property name="message" value="Advanced2: param1=@{param1}" />
-			<aop:scoped-proxy/>
+ 		<bean parent="task.echo" p:message="Advanced2: param1=@{param1}, param2=@{param2}">
+			<flow:variable/>
 		</bean>
 		<flow:flow parent="advanced.flowTemplate">
 			<flow:arg name="param1" value="@{param1}"/>
@@ -80,22 +68,26 @@
 	
 	<flow:flow id="flow1" parent="advanced.flowTemplate">
 		<flow:arg name="param1" value="1" />
+		<flow:arg name="param2" value="1" />
 	</flow:flow>
 	
 	<flow:flow id="flow2">
 		<flow:flow parent="advanced.flowTemplate">
 			<flow:arg name="param1" value="2" />
+			<flow:arg name="param2" value="2" />
 		</flow:flow>
 	</flow:flow>
 
 	<flow:flow id="flow3" parent="advanced.flowTemplate2">
 		<flow:arg name="param1" value="3" />
-		<flow:arg name="param2">
-			<bean class="org.argeo.slc.core.test.BasicTestData">
-				<property name="expected" value="tata" />
-				<property name="reached" value="toto" />
-			</bean>		
-		</flow:arg>
+		<flow:arg name="param2" value="3" />
 	</flow:flow>
+	
+	<flow:flow id="flow4" parent="advanced.flowTemplate">
+		<description>Would fail if param 2 is not changed at execution</description>
+		<flow:arg name="param1" value="4" />
+		<flow:arg name="param2" value="3" />
+	</flow:flow>	
+
 
 </beans>
\ No newline at end of file
diff --git a/runtime/org.argeo.slc.core/src/test/resources/org/argeo/slc/core/execution/xml/containers.xml b/runtime/org.argeo.slc.core/src/test/resources/org/argeo/slc/core/execution/xml/containers.xml
new file mode 100644
index 000000000..d727508de
--- /dev/null
+++ b/runtime/org.argeo.slc.core/src/test/resources/org/argeo/slc/core/execution/xml/containers.xml
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
+	xmlns:flow="http://www.argeo.org/schema/slc-flow" xmlns:aop="http://www.springframework.org/schema/aop"
+	xsi:schemaLocation="
+	http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
+	http://www.springframework.org/schema/lang http://www.springframework.org/schema/lang/spring-lang-2.5.xsd
+	http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd
+	http://www.argeo.org/schema/slc-flow http://www.argeo.org/schema/slc-flow-0.12.xsd">
+
+	<import resource="classpath:org/argeo/slc/core/execution/spring.xml" />
+	<import resource="classpath:/org/argeo/slc/core/test/spring.xml" />
+
+	<bean id="testResult" class="org.argeo.slc.core.test.SimpleTestResult" />
+
+	<bean id="testDef" class="org.argeo.slc.core.test.BasicTestDefinition" />
+
+	<bean id="testRunTemplate" class="org.argeo.slc.core.test.SimpleTestRun" abstract="true">
+		<property name="testDefinition" ref="testDef" />
+		<property name="testResult" ref="testResult"/>
+	</bean>	
+
+	<flow:spec id="test.list.spec">
+		<flow:ref name="list1" targetClass="java.util.List">
+			<flow:value>
+				<!-- a list element can be used directly as default value-->
+				<list>
+					<value>val1</value>
+				</list>
+			</flow:value>
+		</flow:ref>
+		<flow:ref name="list2" targetClass="java.util.List" />
+		<!-- following parameters are not used in flow -->
+		<flow:ref name="dummyMap" targetClass="java.util.Map">
+			<flow:value>
+				<map></map>
+			</flow:value>
+		</flow:ref>
+		<flow:ref name="dummySet" targetClass="java.util.Set">
+			<flow:value>
+				<set></set>
+			</flow:value>
+		</flow:ref>
+		<flow:ref name="dummyProperties" targetClass="java.util.Properties">
+			<flow:value>
+				<props></props>
+			</flow:value>
+		</flow:ref>
+		
+	</flow:spec>
+
+
+	<flow:flow id="test.list.flowTemplate" abstract="true" spec="test.list.spec"
+		path="/path">
+ 		<bean parent="task.echo">
+			<property name="message" value="list1=@{list1}, list2=@{list2}" />
+			<flow:variable/>
+		</bean> 
+
+		<bean parent="testRunTemplate">
+			<property name="testData">
+				<bean class="org.argeo.slc.core.test.BasicTestData">
+					<property name="expected">
+						<flow:param name="list1"/>
+					</property>
+					<property name="reached">
+						<flow:param name="list2"/>
+					</property>
+				</bean>
+			</property>					
+		</bean>
+ 
+	</flow:flow>
+
+	<flow:flow id="test.list.flow1" parent="test.list.flowTemplate">
+		<flow:arg name="list1">
+			<list>
+				<value>val1</value>
+				<value>val2</value>			
+			</list>
+		</flow:arg>
+		<flow:arg name="list2">
+			<list>
+				<value>val1</value>
+				<value>val2</value>			
+			</list>
+		</flow:arg>
+		
+		<!-- not used in flow (just to test that the syntax is accepted): -->
+		<flow:arg name="dummyMap">
+			<map></map>
+		</flow:arg>
+		<flow:arg name="dummySet">
+			<set></set>
+		</flow:arg>
+		<flow:arg name="dummyProperties">
+			<props></props>
+		</flow:arg>		
+		
+	</flow:flow>
+	
+	<flow:flow id="test.list.flow2" parent="test.list.flowTemplate">
+		<description>use default value for parameter "list1"</description>
+		<flow:arg name="list2">
+			<list>
+				<value>val1</value>
+			</list>
+		</flow:arg>
+	</flow:flow>
+
+
+</beans>
\ No newline at end of file