Merge DEV/V3.4-BUG-FIX to HEAD (28799-28800,28864,28875,28879,28916,28941,28956,28970,28993)

28993: HomeFolderProviderSynchronizer: Provider used for LDAP to continue to use username as home folder name directly under .../app:company_home/app:user_homes
   Property spaces.user_homes.regex.pattern now set to "" rather than "^(..)" which would have given a single level hash structure.
   28970: Merge DEV/ALAN/HOME_FOLDER to DEV/V3.4-BUG-FIX
      28947: - Introduction of version 2 HomeFolderProvider2 and re-factor of version 1
        so that the code used to create the folders is now in the HomeFolderManager.
      - Re-factor homeFolderProviderSynchronizer to handle HomeFolderProvider2.
      - Addition of AbstractHomeFolderProvider.V2Adaptor to allow external providers
        that extend AbstractHomeFolderPathProvider to be handled by
        homeFolderProviderSynchronizer.
      28860: Minor change to class comment and removed unused imports
      28858: ALF-4727 Hashed home folder provider added and used by default for LDAP sync users  - based on Romain Guinot work.
      ALF-7797 HomeFolderProviderSynchronizer added to move existing users (normally those added by LDAP sync) into location preferred by home folder provider.
      - HomeFolderProviderSynchronizer bug fixes
        - tenant accounts supported for first time
        - addition of a phase to create parent folders before moving home folder to avoid a race condition
        - check for conditions that would result in FileExistExceptions as we don't want a the transaction to be discarded as this results in retries.  
      - HomeFolderProviderSynchronizerTest integration test including tenant services
      - HomeFolderManager now sets the HOME_FOLDER_PROVIDER if it uses a default when HOME_FOLDER_PROVIDER is not set.
      - AbstractHomeFolderProvider clears cache when path reset as it will be invalid.
      - UIDBasedHomeFolderProvider.createNewParent creates its own mutable List as the one passed in may not be mutable.
      28580: Save code changes - added comments to do with LDAP syn overriding the HFP value and related to this added a global property to keep empty parent folders. 
      28347: HomeFolderProviderSynchronizer
      - issue to do with new run of sync having created a user via UI that has a home folder as one of the parent folders.
      - issue to do with catching exception when creating temporary folder - transaction is gone
      - give up if error in any phase
      28298: Addition of HomeFolderPathProvider (based on Romain's work) and addition of HomeFolderProviderSynchronizer.
   28956: Merged DEV to V3.4-BUG-FIX
      ALF-9428: Multitenancy users not preserved after upgrade from 3.2.2.7 to 3.4.2
                - Provide correct RunAs context in FixUserQNamesPatch batching.
   28941: ALF-9361 : CLONE -sync Flat IMAP client with Alfresco is slow and inaccurate
   28916: ALF-9421 The AlfrescoJavaScript action now includes company home in the JavaScript scope.
   28879: Fixed ALF-9296: Alfresco Dashboard: Impossible to approve/reject task from My Tasks dashlet on My Alfresco
   28875: Fixed ALF-6329: SPANISH - Share, translation on Transfer Target configuration
   28864: Message:
   ALF-9430: RuntimeExec waitForCompletion logic is obscure
    - Only a single flag 'isCompleted'
    - Set flag in try-finally
    - Added notify()
   However, the wait() code doesn't, in practice, get called because the waitForCompletion is synchronized with the run()
   and is called a while after the reading thread is triggered.  So the logic is less obscure and safer for the finally.
   28800: File for rev 28799: ALF-9240
   28799: Merged DEV to V3.4-BUG-FIX
      28797: ALF-9240: Issue with adding an aspect with large multivalued list
             Added unit test to stress, but could not reproduce

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

source/java/org/alfresco/repo/security/person/AbstractHomeFolderProvider2.java

@@ -0,0 +1,209 @@
+/*
+ * Copyright (C) 2005-2011 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.alfresco.repo.security.person;
+
+import java.util.List;
+
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.util.PropertyCheck;
+import org.springframework.beans.factory.BeanNameAware;
+import org.springframework.beans.factory.InitializingBean;
+
+/**
+ * Abstract class that implements {@link HomeFolderProvider2} which
+ * works with the {@link HomeFolderManager} (which performs most of
+ * the work) to create home folders in custom locations.
+ * 
+ * @author Alan Davis
+ */
+public abstract class AbstractHomeFolderProvider2 implements
+        HomeFolderProvider2, BeanNameAware, InitializingBean
+{
+    /**
+     * The provider name
+     */
+    private String name;
+
+    /**
+     * The home folder manager
+     */
+    private HomeFolderManager homeFolderManager;
+    
+    /**
+     * The store URL.
+     */
+    private String storeUrl;
+
+    /**
+     * The path to the root folder
+     */
+    private String rootPath;
+    
+    /**
+     * Set the authority to use as the owner of all home folder nodes.
+     * May be {@code null}.
+     */
+    private String owner;
+
+    /**
+     * PermissionsManager used on creating the home folder
+     */
+    private PermissionsManager onCreatePermissionsManager;
+
+    /**
+     * PermissionsManager used on referencing the home folder
+     */
+    private PermissionsManager onReferencePermissionsManager;
+
+    /**
+     * Register with the homeFolderManagewr
+     */
+    public void afterPropertiesSet() throws Exception
+    {
+        PropertyCheck.mandatory(this, "homeFolderManager", homeFolderManager);
+        homeFolderManager.addProvider(this);
+    }
+
+    /**
+     * Get the home folder manager.
+     */
+    protected HomeFolderManager getHomeFolderManager()
+    {
+        return homeFolderManager;
+    }
+
+    /**
+     * Set the home folder manager.
+     * @param homeFolderManager
+     */
+    public void setHomeFolderManager(HomeFolderManager homeFolderManager)
+    {
+        this.homeFolderManager = homeFolderManager;
+    }
+
+    /**
+     * Get the provider name
+     */
+    @Override
+    public String getName()
+    {
+        return name;
+    }
+
+    /**
+     * The provider name is taken from the bean name
+     */
+    @Override
+    public void setBeanName(String name)
+    {
+        this.name = name;
+    }
+
+    /**
+     * Get the path of the root folder
+     */
+    @Override
+    public String getRootPath()
+    {
+        return rootPath;
+    }
+
+    /**
+     * Set the path of the root folder
+     */
+    public void setRootPath(String rootPath)
+    {
+        boolean reset = this.rootPath != null;
+        this.rootPath = rootPath;
+        
+        // If a reset need to clear caches
+        if (reset)
+        {
+            homeFolderManager.clearCaches(this);
+        }
+    }
+    
+    @Override
+    public String getStoreUrl()
+    {
+        return storeUrl;
+    }
+    
+    /**
+     * Set the store URL.
+     */
+    public void setStoreUrl(String storeUrl)
+    {
+        this.storeUrl = storeUrl;
+    }
+    
+    /**
+     * Sets the PermissionsManager used on creating the home folder
+     */
+    public void setOnCreatePermissionsManager(PermissionsManager onCreatePermissionsManager)
+    {
+        this.onCreatePermissionsManager = onCreatePermissionsManager;
+    }
+    
+    @Override
+    public PermissionsManager getOnCreatePermissionsManager()
+    {
+        return onCreatePermissionsManager;
+    }
+
+    /**
+     * Sets the PermissionsManager used on referencing the home folder
+     */
+    public void setOnReferencePermissionsManager(PermissionsManager onReferencePermissionsManager)
+    {
+        this.onReferencePermissionsManager = onReferencePermissionsManager;
+    }
+
+    @Override
+    public PermissionsManager getOnReferencePermissionsManager()
+    {
+        return onReferencePermissionsManager;
+    }
+
+    /**
+     * Set the authority to use as the owner of all home folder nodes.
+     */
+    public void setOwner(String owner)
+    {
+        this.owner = owner;
+    }
+    
+    @Override
+    public String getOwner()
+    {
+        return owner;
+    }
+
+    @Override
+    public List<String> getHomeFolderPath(NodeRef person)
+    {
+        return null;
+    }
+
+    @Override
+    public NodeRef getTemplateNodeRef()
+    {
+        return null;
+    }
+}