execution/DefaultExecutionFlowDescriptorConverter.java

   1 /*
   2  * Copyright (C) 2007-2012 Argeo GmbH
   3  *
   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
   7  *
   8  *         http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16 package org.argeo.slc.core.execution;
  17
  18 import java.util.Comparator;
  19 import java.util.HashMap;
  20 import java.util.Map;
  21 import java.util.SortedSet;
  22 import java.util.TreeMap;
  23 import java.util.TreeSet;
  24
  25 import org.apache.commons.logging.Log;
  26 import org.apache.commons.logging.LogFactory;
  27 import org.argeo.slc.execution.ExecutionFlow;
  28 import org.argeo.slc.execution.ExecutionFlowDescriptor;
  29 import org.argeo.slc.execution.ExecutionFlowDescriptorConverter;
  30 import org.argeo.slc.execution.ExecutionModuleDescriptor;
  31 import org.argeo.slc.execution.ExecutionSpec;
  32 import org.argeo.slc.execution.ExecutionSpecAttribute;
  33 import org.springframework.aop.scope.ScopedObject;
  34 import org.springframework.beans.BeansException;
  35 import org.springframework.beans.factory.BeanFactory;
  36 import org.springframework.beans.factory.config.BeanDefinition;
  37 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
  38 import org.springframework.context.ApplicationContext;
  39 import org.springframework.context.ApplicationContextAware;
  40 import org.springframework.context.ConfigurableApplicationContext;
  41 import org.springframework.util.StringUtils;
  42
  43 /**
  44  * Performs conversion in both direction between data exchanged with the agent
  45  * and the data in the application context.
  46  */
  47 public class DefaultExecutionFlowDescriptorConverter implements
  48                 ExecutionFlowDescriptorConverter, ApplicationContextAware {
  49         public final static String REF_VALUE_TYPE_BEAN_NAME = "beanName";
  50
  51         /** Workaround for https://www.spartadn.com/bugzilla/show_bug.cgi?id=206 */
  52         private final static String REF_VALUE_INTERNAL = "[internal]";
  53
  54         private final static Log log = LogFactory
  55                         .getLog(DefaultExecutionFlowDescriptorConverter.class);
  56
  57         private ApplicationContext applicationContext;
  58
  59         @SuppressWarnings("unused")
  60         public Map<String, Object> convertValues(
  61                         ExecutionFlowDescriptor executionFlowDescriptor) {
  62                 Map<String, Object> values = executionFlowDescriptor.getValues();
  63                 Map<String, Object> convertedValues = new HashMap<String, Object>();
  64                 ExecutionSpec executionSpec = executionFlowDescriptor
  65                                 .getExecutionSpec();
  66
  67                 if (executionSpec == null && log.isTraceEnabled())
  68                         log.warn("Execution spec is null for " + executionFlowDescriptor);
  69
  70                 if (values != null && executionSpec != null) {
  71                         values: for (String key : values.keySet()) {
  72                                 ExecutionSpecAttribute attribute = executionSpec
  73                                                 .getAttributes().get(key);
  74
  75                                 if (attribute == null)
  76                                         throw new FlowConfigurationException(
  77                                                         "No spec attribute defined for '" + key + "'");
  78
  79                                 if (attribute.getIsConstant())
  80                                         continue values;
  81
  82                                 Object value = values.get(key);
  83                                 if (value instanceof PrimitiveValue) {
  84                                         PrimitiveValue primitiveValue = (PrimitiveValue) value;
  85                                         // TODO: check class <=> type
  86                                         convertedValues.put(key, primitiveValue.getValue());
  87                                 } else if (value instanceof RefValue) {
  88                                         RefValue refValue = (RefValue) value;
  89                                         String type = refValue.getType();
  90                                         if (REF_VALUE_TYPE_BEAN_NAME.equals(type)) {
  91                                                 // FIXME: UI should send all information about spec
  92                                                 // - targetClass
  93                                                 // - name
  94                                                 // String executionSpecName = executionSpec.getName();
  95                                                 // ExecutionSpec localSpec = (ExecutionSpec)
  96                                                 // applicationContext
  97                                                 // .getBean(executionSpecName);
  98                                                 // RefSpecAttribute localAttr = (RefSpecAttribute)
  99                                                 // localSpec
 100                                                 // .getAttributes().get(key);
 101                                                 // Class<?> targetClass = localAttr.getTargetClass();
 102                                                 //
 103                                                 // String primitiveType = PrimitiveUtils
 104                                                 // .classAsType(targetClass);
 105                                                 String primitiveType = null;
 106                                                 if (primitiveType != null) {
 107                                                         // not active
 108                                                         String ref = refValue.getRef();
 109                                                         Object obj = PrimitiveUtils.convert(primitiveType,
 110                                                                         ref);
 111                                                         convertedValues.put(key, obj);
 112                                                 } else {
 113                                                         String ref = refValue.getRef();
 114                                                         if (ref != null && !ref.equals(REF_VALUE_INTERNAL)) {
 115                                                                 Object obj = null;
 116                                                                 if (applicationContext.containsBean(ref)) {
 117                                                                         obj = applicationContext.getBean(ref);
 118                                                                 } else {
 119                                                                         // FIXME: hack in order to pass primitive
 120                                                                         obj = ref;
 121                                                                 }
 122                                                                 convertedValues.put(key, obj);
 123                                                         } else {
 124                                                                 log.warn("Cannot interpret " + refValue);
 125                                                         }
 126                                                 }
 127                                         } else if (PrimitiveUtils.typeAsClass(type) != null) {
 128                                                 String ref = refValue.getRef();
 129                                                 Object obj = PrimitiveUtils.convert(type, ref);
 130                                                 convertedValues.put(key, obj);
 131                                         } else {
 132                                                 throw new FlowConfigurationException(
 133                                                                 "Ref value type not supported: "
 134                                                                                 + refValue.getType());
 135                                         }
 136                                 } else {
 137                                         // default is to take the value as is
 138                                         convertedValues.put(key, value);
 139                                 }
 140                         }
 141                 }
 142                 return convertedValues;
 143         }
 144
 145         public void addFlowsToDescriptor(ExecutionModuleDescriptor md,
 146                         Map<String, ExecutionFlow> executionFlows) {
 147                 SortedSet<ExecutionFlowDescriptor> set = new TreeSet<ExecutionFlowDescriptor>(
 148                                 new ExecutionFlowDescriptorComparator());
 149                 for (String name : executionFlows.keySet()) {
 150                         ExecutionFlow executionFlow = executionFlows.get(name);
 151
 152                         ExecutionFlowDescriptor efd = getExecutionFlowDescriptor(executionFlow);
 153                         ExecutionSpec executionSpec = efd.getExecutionSpec();
 154
 155                         // Add execution spec if necessary
 156                         if (!md.getExecutionSpecs().contains(executionSpec))
 157                                 md.getExecutionSpecs().add(executionSpec);
 158
 159                         // Add execution flow
 160                         set.add(efd);
 161                         // md.getExecutionFlows().add(efd);
 162                 }
 163                 md.getExecutionFlows().addAll(set);
 164         }
 165
 166         @SuppressWarnings("deprecation")
 167         public ExecutionFlowDescriptor getExecutionFlowDescriptor(
 168                         ExecutionFlow executionFlow) {
 169                 if (executionFlow.getName() == null)
 170                         throw new FlowConfigurationException("Flow name is null: "
 171                                         + executionFlow);
 172                 String name = executionFlow.getName();
 173
 174                 ExecutionSpec executionSpec = executionFlow.getExecutionSpec();
 175                 if (executionSpec == null)
 176                         throw new FlowConfigurationException("Execution spec is null: "
 177                                         + executionFlow);
 178                 if (executionSpec.getName() == null)
 179                         throw new FlowConfigurationException(
 180                                         "Execution spec name is null: " + executionSpec);
 181
 182                 Map<String, Object> values = new TreeMap<String, Object>();
 183                 for (String key : executionSpec.getAttributes().keySet()) {
 184                         ExecutionSpecAttribute attribute = executionSpec.getAttributes()
 185                                         .get(key);
 186
 187                         if (attribute instanceof PrimitiveSpecAttribute) {
 188                                 if (executionFlow.isSetAsParameter(key)) {
 189                                         Object value = executionFlow.getParameter(key);
 190                                         PrimitiveValue primitiveValue = new PrimitiveValue();
 191                                         primitiveValue.setType(((PrimitiveSpecAttribute) attribute)
 192                                                         .getType());
 193                                         primitiveValue.setValue(value);
 194                                         values.put(key, primitiveValue);
 195                                 } else {
 196                                         // no need to add a primitive value if it is not set,
 197                                         // all necessary information is in the spec
 198                                 }
 199                         } else if (attribute instanceof RefSpecAttribute) {
 200                                 if (attribute.getIsConstant()) {
 201                                         values.put(key, new RefValue(REF_VALUE_INTERNAL));
 202                                 } else
 203                                         values.put(
 204                                                         key,
 205                                                         buildRefValue((RefSpecAttribute) attribute,
 206                                                                         executionFlow, key));
 207                         } else {
 208                                 throw new FlowConfigurationException(
 209                                                 "Unkown spec attribute type " + attribute.getClass());
 210                         }
 211
 212                 }
 213
 214                 ExecutionFlowDescriptor efd = new ExecutionFlowDescriptor(name, null,
 215                                 values, executionSpec);
 216                 if (executionFlow.getPath() != null)
 217                         efd.setPath(executionFlow.getPath());
 218                 else
 219                         efd.setPath("");
 220
 221                 // Takes description from spring
 222                 BeanFactory bf = getBeanFactory();
 223                 if (bf != null) {
 224                         BeanDefinition bd = getBeanFactory().getBeanDefinition(name);
 225                         efd.setDescription(bd.getDescription());
 226                 }
 227                 return efd;
 228         }
 229
 230         protected RefValue buildRefValue(RefSpecAttribute rsa,
 231                         ExecutionFlow executionFlow, String key) {
 232                 RefValue refValue = new RefValue();
 233                 // FIXME: UI should be able to deal with other types
 234                 refValue.setType(REF_VALUE_TYPE_BEAN_NAME);
 235                 Class<?> targetClass = rsa.getTargetClass();
 236                 String primitiveType = PrimitiveUtils.classAsType(targetClass);
 237                 if (primitiveType != null) {
 238                         if (executionFlow.isSetAsParameter(key)) {
 239                                 Object value = executionFlow.getParameter(key);
 240                                 refValue.setRef(value.toString());
 241                         }
 242                         refValue.setType(primitiveType);
 243                         return refValue;
 244                 } else {
 245
 246                         if (executionFlow.isSetAsParameter(key)) {
 247                                 String ref = null;
 248                                 Object value = executionFlow.getParameter(key);
 249                                 if (applicationContext == null) {
 250                                         log.warn("No application context declared, cannot scan ref value.");
 251                                         ref = value.toString();
 252                                 } else {
 253
 254                                         // look for a ref to the value
 255                                         Map<String, ?> beans = getBeanFactory()
 256                                                         .getBeansOfType(targetClass, false, false);
 257                                         // TODO: also check scoped beans
 258                                         beans: for (String beanName : beans.keySet()) {
 259                                                 Object obj = beans.get(beanName);
 260                                                 if (value instanceof ScopedObject) {
 261                                                         // don't call methods of the target of the scope
 262                                                         if (obj instanceof ScopedObject)
 263                                                                 if (value == obj) {
 264                                                                         ref = beanName;
 265                                                                         break beans;
 266                                                                 }
 267                                                 } else {
 268                                                         if (obj.equals(value)) {
 269                                                                 ref = beanName;
 270                                                                 break beans;
 271                                                         }
 272                                                 }
 273                                         }
 274                                 }
 275                                 if (ref == null) {
 276                                         if (log.isTraceEnabled())
 277                                                 log.trace("Cannot define reference for ref spec attribute "
 278                                                                 + key
 279                                                                 + " in "
 280                                                                 + executionFlow
 281                                                                 + " ("
 282                                                                 + rsa
 283                                                                 + ")."
 284                                                                 + " If it is an inner bean consider put it frozen.");
 285                                         ref = REF_VALUE_INTERNAL;
 286                                 } else {
 287                                         if (log.isTraceEnabled())
 288                                                 log.trace(ref
 289                                                                 + " is the reference for ref spec attribute "
 290                                                                 + key + " in " + executionFlow + " (" + rsa
 291                                                                 + ")");
 292                                 }
 293                                 refValue.setRef(ref);
 294                         }
 295                         return refValue;
 296                 }
 297         }
 298
 299         /** @return can be null */
 300         private ConfigurableListableBeanFactory getBeanFactory() {
 301                 if (applicationContext == null)
 302                         return null;
 303                 return ((ConfigurableApplicationContext) applicationContext)
 304                                 .getBeanFactory();
 305         }
 306
 307         /** Must be use within the execution application context */
 308         public void setApplicationContext(ApplicationContext applicationContext)
 309                         throws BeansException {
 310                 this.applicationContext = applicationContext;
 311         }
 312
 313         private static class ExecutionFlowDescriptorComparator implements
 314                         Comparator<ExecutionFlowDescriptor> {
 315                 @SuppressWarnings("deprecation")
 316                 public int compare(ExecutionFlowDescriptor o1,
 317                                 ExecutionFlowDescriptor o2) {
 318                         // TODO: write unit tests for this
 319
 320                         String name1 = o1.getName();
 321                         String name2 = o2.getName();
 322
 323                         String path1 = o1.getPath();
 324                         String path2 = o2.getPath();
 325
 326                         // Check whether name include path
 327                         int lastIndex1 = name1.lastIndexOf('/');
 328                         // log.debug(name1+", "+lastIndex1);
 329                         if (!StringUtils.hasText(path1) && lastIndex1 >= 0) {
 330                                 path1 = name1.substring(0, lastIndex1);
 331                                 name1 = name1.substring(lastIndex1 + 1);
 332                         }
 333
 334                         int lastIndex2 = name2.lastIndexOf('/');
 335                         if (!StringUtils.hasText(path2) && lastIndex2 >= 0) {
 336                                 path2 = name2.substring(0, lastIndex2);
 337                                 name2 = name2.substring(lastIndex2 + 1);
 338                         }
 339
 340                         // Perform the actual comparison
 341                         if (StringUtils.hasText(path1) && StringUtils.hasText(path2)) {
 342                                 if (path1.equals(path2))
 343                                         return name1.compareTo(name2);
 344                                 else if (path1.startsWith(path2))
 345                                         return -1;
 346                                 else if (path2.startsWith(path1))
 347                                         return 1;
 348                                 else
 349                                         return path1.compareTo(path2);
 350                         } else if (!StringUtils.hasText(path1)
 351                                         && StringUtils.hasText(path2)) {
 352                                 return 1;
 353                         } else if (StringUtils.hasText(path1)
 354                                         && !StringUtils.hasText(path2)) {
 355                                 return -1;
 356                         } else if (!StringUtils.hasText(path1)
 357                                         && !StringUtils.hasText(path2)) {
 358                                 return name1.compareTo(name2);
 359                         } else {
 360                                 return 0;
 361                         }
 362                 }
 363
 364         }
 365 }