legacy/org.argeo.slc.spring/src/org/argeo/slc/core/execution/xml/FlowBeanDefinitionParser.java

   1 package org.argeo.slc.core.execution.xml;
   2
   3 import java.util.ArrayList;
   4 import java.util.List;
   5
   6 import org.argeo.api.cms.CmsLog;
   7 import org.argeo.slc.SlcException;
   8 import org.argeo.slc.core.execution.DefaultExecutionFlow;
   9 import org.argeo.slc.execution.ExecutionFlow;
  10 import org.springframework.beans.factory.BeanDefinitionStoreException;
  11 import org.springframework.beans.factory.config.RuntimeBeanReference;
  12 import org.springframework.beans.factory.support.AbstractBeanDefinition;
  13 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
  14 import org.springframework.beans.factory.support.ManagedList;
  15 import org.springframework.beans.factory.support.ManagedMap;
  16 import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
  17 import org.springframework.beans.factory.xml.ParserContext;
  18 import org.springframework.util.StringUtils;
  19 import org.springframework.util.xml.DomUtils;
  20 import org.w3c.dom.Element;
  21 import org.w3c.dom.Node;
  22 import org.w3c.dom.NodeList;
  23
  24 /** Interprets the <flow:flow> tag */
  25 public class FlowBeanDefinitionParser extends
  26                 AbstractSingleBeanDefinitionParser {
  27         private CmsLog log = CmsLog.getLog(FlowBeanDefinitionParser.class);
  28
  29         /** Whether the user has already be warned on path attribute usage. */
  30         private Boolean warnedAboutPathAttribute = false;
  31
  32         @Override
  33         protected void doParse(Element element, ParserContext parserContext,
  34                         BeanDefinitionBuilder builder) {
  35                 String path = element.getAttribute("path");
  36                 if (StringUtils.hasText(path)) {
  37                         builder.addPropertyValue("path", path);
  38
  39                         // warns user only once
  40                         if (!warnedAboutPathAttribute)
  41                                 log.warn("The path=\"\" attribute is deprecated"
  42                                                 + " and will be removed in a later release."
  43                                                 + " Use <flow:flow name=\"/my/path/flowName\">.");
  44                         warnedAboutPathAttribute = true;
  45                 }
  46
  47                 String spec = element.getAttribute("spec");
  48                 if (StringUtils.hasText(spec))
  49                         builder.getBeanDefinition().getConstructorArgumentValues()
  50                                         .addGenericArgumentValue(new RuntimeBeanReference(spec));
  51
  52                 String abstrac = element.getAttribute("abstract");
  53                 if (StringUtils.hasText(abstrac))
  54                         builder.setAbstract(Boolean.parseBoolean(abstrac));
  55
  56                 String parent = element.getAttribute("parent");
  57                 if (StringUtils.hasText(parent))
  58                         builder.setParentName(parent);
  59
  60                 builder.getBeanDefinition().setDescription(
  61                                 DomUtils.getChildElementValueByTagName(element, "description"));
  62
  63                 List<Element> argsElems = new ArrayList<Element>();
  64                 List<Element> execElems = new ArrayList<Element>();
  65                 List<Element> specElems = new ArrayList<Element>();
  66                 NodeList nodeList = element.getChildNodes();
  67                 for (int i = 0; i < nodeList.getLength(); i++) {
  68                         Node node = nodeList.item(i);
  69                         if (node instanceof Element) {
  70                                 if (DomUtils.nodeNameEquals(node, "arg"))
  71                                         argsElems.add((Element) node);
  72                                 else if (DomUtils.nodeNameEquals(node, "spec"))
  73                                         specElems.add((Element) node);
  74                                 else if (!DomUtils.nodeNameEquals(node, "description"))
  75                                         execElems.add((Element) node);
  76                         }
  77                 }
  78
  79                 // Arguments
  80                 if (argsElems.size() != 0) {
  81                         ManagedMap<String, Object> args = new ManagedMap<String, Object>(
  82                                         argsElems.size());
  83                         for (Element argElem : argsElems) {
  84                                 Object value = NamespaceUtils.parseValue(argElem,
  85                                                 parserContext, builder.getBeanDefinition(), null);
  86                                 if (value != null)
  87                                         args.put(argElem.getAttribute("name"), value);
  88                                 else
  89                                         throw new SlcException("No value defined.");
  90                         }
  91                         builder.getBeanDefinition().getConstructorArgumentValues()
  92                                         .addGenericArgumentValue(args);
  93                 }
  94
  95                 // Execution specs
  96                 if (StringUtils.hasText(spec) && specElems.size() != 0)
  97                         throw new SlcException("A flow cannot have multiple specs");
  98                 if (specElems.size() == 1) {
  99                         Object specObj = NamespaceUtils.parseBeanOrReference(
 100                                         specElems.get(0), parserContext,
 101                                         builder.getBeanDefinition());
 102                         builder.getBeanDefinition().getConstructorArgumentValues()
 103                                         .addGenericArgumentValue(specObj);
 104                 } else if (specElems.size() > 1)
 105                         throw new SlcException("A flow cannot have multiple specs");
 106
 107                 // Executables
 108                 if (execElems.size() != 0) {
 109                         ManagedList<Object> executables = new ManagedList<Object>(
 110                                         execElems.size());
 111                         for (Element child : execElems) {
 112                                 // child validity check is performed in xsd
 113                                 executables.add(NamespaceUtils.parseBeanOrReference(child,
 114                                                 parserContext, builder.getBeanDefinition()));
 115                         }
 116                         if (executables.size() > 0)
 117                                 builder.addPropertyValue("executables", executables);
 118                 }
 119         }
 120
 121         @SuppressWarnings("unchecked")
 122         @Override
 123         protected Class<? extends ExecutionFlow> getBeanClass(Element element) {
 124                 String clss = element.getAttribute("class");
 125                 if (StringUtils.hasText(clss))
 126                         // TODO: check that it actually works
 127                         try {
 128                                 return (Class<? extends ExecutionFlow>) getClass()
 129                                                 .getClassLoader().loadClass(clss);
 130                         } catch (ClassNotFoundException e) {
 131                                 try {
 132                                         return (Class<? extends ExecutionFlow>) Thread
 133                                                         .currentThread().getContextClassLoader()
 134                                                         .loadClass(clss);
 135                                 } catch (ClassNotFoundException e1) {
 136                                         throw new SlcException("Cannot load class " + clss, e);
 137                                 }
 138                         }
 139                 else
 140                         return DefaultExecutionFlow.class;
 141         }
 142
 143         // parse nested bean definition
 144         // private Object parseBeanReference(Element element,
 145         // ParserContext parserContext, BeanDefinitionBuilder builder) {
 146         // return parserContext.getDelegate().parsePropertySubElement(element,
 147         // builder.getBeanDefinition());
 148         // }
 149
 150         @Override
 151         protected String resolveId(Element element,
 152                         AbstractBeanDefinition definition, ParserContext parserContext)
 153                         throws BeanDefinitionStoreException {
 154                 String name = element.getAttribute("name");
 155                 if (StringUtils.hasText(name)) {
 156                         return name;
 157                 } else {
 158                         return super.resolveId(element, definition, parserContext);
 159                 }
 160         }
 161
 162         protected boolean shouldGenerateIdAsFallback() {
 163                 return true;
 164         }
 165
 166 }