Make it possible to request that the ApplicationContext disables "autoStart=true" services for when running unit tests

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18545 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/repo/content/metadata/AbstractMetadataExtracterTest.java

@@ -58,6 +58,7 @@ public abstract class AbstractMetadataExtracterTest extends TestCase
 {
     static {
        ApplicationContextHelper.setUseLazyLoading(false);
+       ApplicationContextHelper.setNoAutoStart(true);
     }
     protected static ApplicationContext ctx = ApplicationContextHelper.getApplicationContext();
     

source/java/org/alfresco/util/ApplicationContextHelper.java

@@ -40,6 +40,7 @@ public class ApplicationContextHelper
     private static ClassPathXmlApplicationContext instance;
     private static String[] usedConfiguration;
     private static boolean useLazyLoading = false;
+    private static boolean noAutoStart = false;
     
     /** location of required configuration files */
     public static final String[] CONFIG_LOCATIONS = new String[] { "classpath:alfresco/application-context.xml" };
@@ -83,6 +84,8 @@ public class ApplicationContextHelper
        
         if(useLazyLoading) {
            instance = new LazyClassPathXmlApplicationContext(configLocations);
+        } else if(noAutoStart) {
+           instance = new NoAutoStartClassPathXmlApplicationContext(configLocations);
         } else {
            instance = new ClassPathXmlApplicationContext(configLocations);
         }
@@ -116,6 +119,9 @@ public class ApplicationContextHelper
      *  to reduce startup times when using a small, cut down context.
      */
     public static void setUseLazyLoading(boolean lazyLoading) {
+       if(lazyLoading && noAutoStart) {
+          throw new IllegalStateException("You must choose between LazyLoading and NoAutoStart");
+       }
        useLazyLoading = lazyLoading;
     }
     /**
@@ -127,6 +133,30 @@ public class ApplicationContextHelper
        return useLazyLoading;
     }
     
+    /**
+     * Should the autoStart=true property on subsystems
+     *  be honoured, or should this property be ignored
+     *  and the auto start prevented?
+     * Normally we will use the spring configuration to
+     *  decide what to start, but when running tests,
+     *  you can use this to prevent the auto start.
+     */
+    public static void setNoAutoStart(boolean noAutoStart) {
+       if(useLazyLoading && noAutoStart) {
+          throw new IllegalStateException("You must choose between LazyLoading and NoAutoStart");
+       }
+       ApplicationContextHelper.noAutoStart = noAutoStart;
+    }
+    /**
+     * Will subsystems with the autoStart=true property set
+     *  on them be allowed to auto start? The default is to
+     *  honour the spring configuration and allow them to,
+     *  but they can be prevented if required.
+     */
+    public static boolean isNoAutoStart() {
+       return noAutoStart;
+    }
+    
     public static void main(String ... args)
     {
         ClassPathXmlApplicationContext ctx = (ClassPathXmlApplicationContext) getApplicationContext();

source/java/org/alfresco/util/NoAutoStartClassPathXmlApplicationContext.java

@@ -0,0 +1,88 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.util;
+
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.xml.BeanDefinitionParserDelegate;
+import org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader;
+import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
+import org.springframework.beans.factory.xml.XmlReaderContext;
+import org.springframework.context.support.ClassPathXmlApplicationContext;
+import org.w3c.dom.Element;
+
+/**
+ * A wrapper around {@link ClassPathXmlApplicationContext} which 
+ *  stops abstractPropertyBackedBean based beans from being
+ *  AutoStarted by tweaking their property definitions.
+ * You shouldn't do this in production, but it can be handy with
+ *  unit tests, as it allows a quicker startup by preventing
+ *  subsystems from starting up
+ *  
+ * @author Nick Burch
+ */
+public class NoAutoStartClassPathXmlApplicationContext extends
+      ClassPathXmlApplicationContext {
+   
+   public NoAutoStartClassPathXmlApplicationContext(String[] configLocations)
+         throws BeansException {
+      super(configLocations);
+   }
+
+   protected void initBeanDefinitionReader(XmlBeanDefinitionReader reader) {
+      super.initBeanDefinitionReader(reader);
+      
+      reader.setDocumentReaderClass(NoAutoStartBeanDefinitionDocumentReader.class);
+   }
+
+   protected static class NoAutoStartBeanDefinitionDocumentReader extends DefaultBeanDefinitionDocumentReader {
+      @Override
+      protected BeanDefinitionParserDelegate createHelper(
+            XmlReaderContext readerContext, Element root) {
+         BeanDefinitionParserDelegate delegate = new NoAutoStartBeanDefinitionParserDelegate(readerContext);
+         delegate.initDefaults(root);
+         return delegate;
+      }
+   }
+   
+   protected static class NoAutoStartBeanDefinitionParserDelegate extends BeanDefinitionParserDelegate {
+      protected NoAutoStartBeanDefinitionParserDelegate(XmlReaderContext readerContext) {
+         super(readerContext);
+      }
+      
+      @Override  
+      public void parsePropertyElement(Element ele, BeanDefinition bd) {
+         String propertyName = ele.getAttribute("name");
+         if("autoStart".equals(propertyName)) {
+            if("abstractPropertyBackedBean".equals(bd.getParentName())) {
+               System.out.println("Preventing the autostart of " + bd.getBeanClassName());
+               return;
+            }
+         }
+         
+         super.parsePropertyElement(ele, bd);
+      }
+   }
+}