2 * Copyright (C) 2007-2012 Mathieu Baudier
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 package org
.argeo
.slc
.core
.execution
;
18 import java
.util
.Comparator
;
19 import java
.util
.HashMap
;
21 import java
.util
.SortedSet
;
22 import java
.util
.TreeMap
;
23 import java
.util
.TreeSet
;
25 import org
.apache
.commons
.logging
.Log
;
26 import org
.apache
.commons
.logging
.LogFactory
;
27 import org
.argeo
.slc
.SlcException
;
28 import org
.argeo
.slc
.UnsupportedException
;
29 import org
.argeo
.slc
.execution
.ExecutionFlow
;
30 import org
.argeo
.slc
.execution
.ExecutionFlowDescriptor
;
31 import org
.argeo
.slc
.execution
.ExecutionFlowDescriptorConverter
;
32 import org
.argeo
.slc
.execution
.ExecutionModuleDescriptor
;
33 import org
.argeo
.slc
.execution
.ExecutionSpec
;
34 import org
.argeo
.slc
.execution
.ExecutionSpecAttribute
;
35 import org
.springframework
.aop
.scope
.ScopedObject
;
36 import org
.springframework
.beans
.BeansException
;
37 import org
.springframework
.beans
.factory
.BeanFactory
;
38 import org
.springframework
.beans
.factory
.config
.BeanDefinition
;
39 import org
.springframework
.beans
.factory
.config
.ConfigurableListableBeanFactory
;
40 import org
.springframework
.context
.ApplicationContext
;
41 import org
.springframework
.context
.ApplicationContextAware
;
42 import org
.springframework
.context
.ConfigurableApplicationContext
;
43 import org
.springframework
.util
.StringUtils
;
46 * Performs conversion in both direction between data exchanged with the agent
47 * and the data in the application context.
49 public class DefaultExecutionFlowDescriptorConverter
implements
50 ExecutionFlowDescriptorConverter
, ApplicationContextAware
{
51 public final static String REF_VALUE_TYPE_BEAN_NAME
= "beanName";
53 /** Workaround for https://www.spartadn.com/bugzilla/show_bug.cgi?id=206 */
54 private final static String REF_VALUE_INTERNAL
= "[internal]";
56 private final static Log log
= LogFactory
57 .getLog(DefaultExecutionFlowDescriptorConverter
.class);
59 private ApplicationContext applicationContext
;
61 @SuppressWarnings("unused")
62 public Map
<String
, Object
> convertValues(
63 ExecutionFlowDescriptor executionFlowDescriptor
) {
64 Map
<String
, Object
> values
= executionFlowDescriptor
.getValues();
65 Map
<String
, Object
> convertedValues
= new HashMap
<String
, Object
>();
66 ExecutionSpec executionSpec
= executionFlowDescriptor
69 if (executionSpec
== null && log
.isTraceEnabled())
70 log
.warn("Execution spec is null for " + executionFlowDescriptor
);
72 if (values
!= null && executionSpec
!= null) {
73 values
: for (String key
: values
.keySet()) {
74 ExecutionSpecAttribute attribute
= executionSpec
75 .getAttributes().get(key
);
77 if (attribute
== null)
78 throw new SlcException("No spec attribute defined for '"
81 if (attribute
.getIsConstant())
84 Object value
= values
.get(key
);
85 if (value
instanceof PrimitiveValue
) {
86 PrimitiveValue primitiveValue
= (PrimitiveValue
) value
;
87 // TODO: check class <=> type
88 convertedValues
.put(key
, primitiveValue
.getValue());
89 } else if (value
instanceof RefValue
) {
90 RefValue refValue
= (RefValue
) value
;
91 String type
= refValue
.getType();
92 if (REF_VALUE_TYPE_BEAN_NAME
.equals(type
)) {
93 // FIXME: UI should send all information about spec
96 // String executionSpecName = executionSpec.getName();
97 // ExecutionSpec localSpec = (ExecutionSpec)
99 // .getBean(executionSpecName);
100 // RefSpecAttribute localAttr = (RefSpecAttribute)
102 // .getAttributes().get(key);
103 // Class<?> targetClass = localAttr.getTargetClass();
105 // String primitiveType = PrimitiveUtils
106 // .classAsType(targetClass);
107 String primitiveType
= null;
108 if (primitiveType
!= null) {
110 String ref
= refValue
.getRef();
111 Object obj
= PrimitiveUtils
.convert(primitiveType
,
113 convertedValues
.put(key
, obj
);
115 String ref
= refValue
.getRef();
116 if (ref
!= null && !ref
.equals(REF_VALUE_INTERNAL
)) {
118 if (applicationContext
.containsBean(ref
)) {
119 obj
= applicationContext
.getBean(ref
);
121 // FIXME: hack in order to pass primitive
124 convertedValues
.put(key
, obj
);
126 log
.warn("Cannot interpret " + refValue
);
129 } else if (PrimitiveUtils
.typeAsClass(type
) != null) {
130 String ref
= refValue
.getRef();
131 Object obj
= PrimitiveUtils
.convert(type
, ref
);
132 convertedValues
.put(key
, obj
);
134 throw new UnsupportedException("Ref value type",
138 // default is to take the value as is
139 convertedValues
.put(key
, value
);
143 return convertedValues
;
146 public void addFlowsToDescriptor(ExecutionModuleDescriptor md
,
147 Map
<String
, ExecutionFlow
> executionFlows
) {
148 SortedSet
<ExecutionFlowDescriptor
> set
= new TreeSet
<ExecutionFlowDescriptor
>(
149 new ExecutionFlowDescriptorComparator());
150 for (String name
: executionFlows
.keySet()) {
151 ExecutionFlow executionFlow
= executionFlows
.get(name
);
153 ExecutionFlowDescriptor efd
= getExecutionFlowDescriptor(executionFlow
);
154 ExecutionSpec executionSpec
= efd
.getExecutionSpec();
156 // Add execution spec if necessary
157 if (!md
.getExecutionSpecs().contains(executionSpec
))
158 md
.getExecutionSpecs().add(executionSpec
);
160 // Add execution flow
162 // md.getExecutionFlows().add(efd);
164 md
.getExecutionFlows().addAll(set
);
167 public ExecutionFlowDescriptor
getExecutionFlowDescriptor(
168 ExecutionFlow executionFlow
) {
169 if (executionFlow
.getName() == null)
170 throw new SlcException("Flow name is null: " + executionFlow
);
171 String name
= executionFlow
.getName();
173 ExecutionSpec executionSpec
= executionFlow
.getExecutionSpec();
174 if (executionSpec
== null)
175 throw new SlcException("Execution spec is null: " + executionFlow
);
176 if (executionSpec
.getName() == null)
177 throw new SlcException("Execution spec name is null: "
180 Map
<String
, Object
> values
= new TreeMap
<String
, Object
>();
181 for (String key
: executionSpec
.getAttributes().keySet()) {
182 ExecutionSpecAttribute attribute
= executionSpec
.getAttributes()
185 if (attribute
instanceof PrimitiveSpecAttribute
) {
186 if (executionFlow
.isSetAsParameter(key
)) {
187 Object value
= executionFlow
.getParameter(key
);
188 PrimitiveValue primitiveValue
= new PrimitiveValue();
189 primitiveValue
.setType(((PrimitiveSpecAttribute
) attribute
)
191 primitiveValue
.setValue(value
);
192 values
.put(key
, primitiveValue
);
194 // no need to add a primitive value if it is not set,
195 // all necessary information is in the spec
197 } else if (attribute
instanceof RefSpecAttribute
) {
198 if (attribute
.getIsConstant()) {
199 values
.put(key
, new RefValue(REF_VALUE_INTERNAL
));
203 buildRefValue((RefSpecAttribute
) attribute
,
204 executionFlow
, key
));
206 throw new SlcException("Unkown spec attribute type "
207 + attribute
.getClass());
212 ExecutionFlowDescriptor efd
= new ExecutionFlowDescriptor(name
, values
,
214 // if (executionFlow.getPath() != null)
215 // efd.setPath(executionFlow.getPath());
219 // Takes description from spring
220 BeanFactory bf
= getBeanFactory();
222 BeanDefinition bd
= getBeanFactory().getBeanDefinition(name
);
223 efd
.setDescription(bd
.getDescription());
228 @SuppressWarnings(value
= { "unchecked" })
229 protected RefValue
buildRefValue(RefSpecAttribute rsa
,
230 ExecutionFlow executionFlow
, String key
) {
231 RefValue refValue
= new RefValue();
232 // FIXME: UI should be able to deal with other types
233 refValue
.setType(REF_VALUE_TYPE_BEAN_NAME
);
234 Class
<?
> targetClass
= rsa
.getTargetClass();
235 String primitiveType
= PrimitiveUtils
.classAsType(targetClass
);
236 if (primitiveType
!= null) {
237 if (executionFlow
.isSetAsParameter(key
)) {
238 Object value
= executionFlow
.getParameter(key
);
239 refValue
.setRef(value
.toString());
241 refValue
.setType(primitiveType
);
245 if (executionFlow
.isSetAsParameter(key
)) {
247 Object value
= executionFlow
.getParameter(key
);
248 if (applicationContext
== null) {
249 log
.warn("No application context declared, cannot scan ref value.");
250 ref
= value
.toString();
253 // look for a ref to the value
254 Map
<String
, Object
> beans
= getBeanFactory()
255 .getBeansOfType(targetClass
, false, false);
256 // TODO: also check scoped beans
257 beans
: for (String beanName
: beans
.keySet()) {
258 Object obj
= beans
.get(beanName
);
259 if (value
instanceof ScopedObject
) {
260 // don't call methods of the target of the scope
261 if (obj
instanceof ScopedObject
)
267 if (obj
.equals(value
)) {
275 if (log
.isTraceEnabled())
276 log
.trace("Cannot define reference for ref spec attribute "
283 + " If it is an inner bean consider put it frozen.");
284 ref
= REF_VALUE_INTERNAL
;
286 if (log
.isTraceEnabled())
288 + " is the reference for ref spec attribute "
289 + key
+ " in " + executionFlow
+ " (" + rsa
292 refValue
.setRef(ref
);
298 /** @return can be null */
299 private ConfigurableListableBeanFactory
getBeanFactory() {
300 if (applicationContext
== null)
302 return ((ConfigurableApplicationContext
) applicationContext
)
306 /** Must be use within the execution application context */
307 public void setApplicationContext(ApplicationContext applicationContext
)
308 throws BeansException
{
309 this.applicationContext
= applicationContext
;
312 private static class ExecutionFlowDescriptorComparator
implements
313 Comparator
<ExecutionFlowDescriptor
> {
314 @SuppressWarnings("deprecation")
315 public int compare(ExecutionFlowDescriptor o1
,
316 ExecutionFlowDescriptor o2
) {
317 // TODO: write unit tests for this
319 String name1
= o1
.getName();
320 String name2
= o2
.getName();
322 String path1
= o1
.getPath();
323 String path2
= o2
.getPath();
325 // Check whether name include path
326 int lastIndex1
= name1
.lastIndexOf('/');
327 // log.debug(name1+", "+lastIndex1);
328 if (!StringUtils
.hasText(path1
) && lastIndex1
>= 0) {
329 path1
= name1
.substring(0, lastIndex1
);
330 name1
= name1
.substring(lastIndex1
+ 1);
333 int lastIndex2
= name2
.lastIndexOf('/');
334 if (!StringUtils
.hasText(path2
) && lastIndex2
>= 0) {
335 path2
= name2
.substring(0, lastIndex2
);
336 name2
= name2
.substring(lastIndex2
+ 1);
339 // Perform the actual comparison
340 if (StringUtils
.hasText(path1
) && StringUtils
.hasText(path2
)) {
341 if (path1
.equals(path2
))
342 return name1
.compareTo(name2
);
343 else if (path1
.startsWith(path2
))
345 else if (path2
.startsWith(path1
))
348 return path1
.compareTo(path2
);
349 } else if (!StringUtils
.hasText(path1
)
350 && StringUtils
.hasText(path2
)) {
352 } else if (StringUtils
.hasText(path1
)
353 && !StringUtils
.hasText(path2
)) {
355 } else if (!StringUtils
.hasText(path1
)
356 && !StringUtils
.hasText(path2
)) {
357 return name1
.compareTo(name2
);