RM-3114: Prevent access to custom map before it is ready

- remove public init method from AdministrationService
- make admin service impl ordered listener, always goes last
- protect execution of service behaviours until custom map init'ed

.gitignore

@@ -24,6 +24,7 @@ test-output
 /rm-server/alfresco-solr.zip
 /rm-server/solr
 /rm-server/shared
+/rm-server/alf_data
 
 # /rm-server/config/
 /rm-server/config/alfresco-global.properties

rm-server/config/alfresco/module/org_alfresco_module_rm/module-context.xml

@@ -168,7 +168,6 @@
       <!-- init caveatConfig behaviours  -->
       <property name="caveatConfigService" ref="caveatConfigService"/>
       <property name="customEmailMappingService" ref="customEmailMappingService"/>
-      <property name="recordsManagementAdminService" ref="RecordsManagementAdminService"/>
    </bean>
 
    <!-- Java script interface for rm caveat config-->

rm-server/config/alfresco/module/org_alfresco_module_rm/rm-service-context.xml

@@ -813,7 +813,6 @@
         <property name="objectDefinitionSource">
             <value>
                 <![CDATA[
-                org.alfresco.module.org_alfresco_module_rm.admin.RecordsManagementAdminService.initialiseCustomModel=RM_ALLOW
                 org.alfresco.module.org_alfresco_module_rm.admin.RecordsManagementAdminService.getCustomisable=RM_ALLOW
                 org.alfresco.module.org_alfresco_module_rm.admin.RecordsManagementAdminService.isCustomisable=RM_ALLOW
                 org.alfresco.module.org_alfresco_module_rm.admin.RecordsManagementAdminService.makeCustomisable=RM_ALLOW

rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminService.java

@@ -42,11 +42,6 @@ import org.alfresco.service.namespace.QName;
  */
 public interface RecordsManagementAdminService
 {
-    /**
-     * Initialise the custom model
-     */
-    void initialiseCustomModel();
-
     /**
      * Get a list of all registered customisable types and aspects.
      *

rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java

@@ -86,6 +86,9 @@ import org.alfresco.service.namespace.RegexQNamePattern;
 import org.alfresco.util.GUID;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.springframework.context.ApplicationListener;
+import org.springframework.context.event.ContextRefreshedEvent;
+import org.springframework.core.Ordered;
 import org.springframework.extensions.surf.util.I18NUtil;
 import org.springframework.extensions.surf.util.ParameterCheck;
 import org.springframework.extensions.surf.util.URLDecoder;
@@ -100,7 +103,9 @@ public class RecordsManagementAdminServiceImpl implements RecordsManagementAdmin
 														  RecordsManagementCustomModel,
 														  NodeServicePolicies.OnAddAspectPolicy,
 														  NodeServicePolicies.OnRemoveAspectPolicy,
-														  NodeServicePolicies.OnCreateNodePolicy
+														  NodeServicePolicies.OnCreateNodePolicy,
+														  ApplicationListener<ContextRefreshedEvent>, 
+														  Ordered
 {
     /** Logger */
     private static Log logger = LogFactory.getLog(RecordsManagementAdminServiceImpl.class);
@@ -162,6 +167,9 @@ public class RecordsManagementAdminServiceImpl implements RecordsManagementAdmin
     /** List of types that can be customisable */
     private List<QName> pendingCustomisableTypes;
     private Map<QName, QName> customisableTypes;
+    
+    /** indicates whether the custom map has been initialised or not */
+    private boolean isCustomMapInit = false;
 
     /**
      * @param dictionaryService     the dictionary service
@@ -223,15 +231,39 @@ public class RecordsManagementAdminServiceImpl implements RecordsManagementAdmin
         onCreateReferenceDelegate = policyComponent.registerClassPolicy(OnCreateReference.class);
         beforeRemoveReferenceDelegate = policyComponent.registerClassPolicy(BeforeRemoveReference.class);
         onRemoveReferenceDelegate = policyComponent.registerClassPolicy(OnRemoveReference.class);
+	}
+
+	/**
+	 * Indicate that this application content listener must be executed with the highest 
+	 * precedence.
+	 * 
+	 * @see Ordered#getOrder()
+	 */
+    @Override
+    public int getOrder()
+    {
+        return Ordered.LOWEST_PRECEDENCE;
+    }
+
+    /**
+     * Load the custom properties map
+     * 
+     * @see ApplicationListener#onApplicationEvent(org.springframework.context.ApplicationEvent)
+     */
+    @Override
+    public void onApplicationEvent(ContextRefreshedEvent event)
+    {
+        // initialise custom properties
+        initCustomMap();          
     }
 
 	/**
-     * Invoke before create reference policy
+	 * Invoke before create reference policy
-     *
+	 *
-     * @param fromNodeRef
+	 * @param fromNodeRef
-     * @param toNodeRef
+	 * @param toNodeRef
-     * @param reference
+	 * @param reference
-     */
+	 */
     protected void invokeBeforeCreateReference(NodeRef fromNodeRef, NodeRef toNodeRef, QName reference)
     {
         // get qnames to invoke against
@@ -301,22 +333,25 @@ public class RecordsManagementAdminServiceImpl implements RecordsManagementAdmin
     )
     public void onAddAspect(final NodeRef nodeRef, final QName aspectTypeQName)
     {
-        AuthenticationUtil.runAs(new RunAsWork<Void>()
+        if (isCustomMapInit)
         {
-            @Override
+            AuthenticationUtil.runAs(new RunAsWork<Void>()
-            public Void doWork()
             {
-                if (nodeService.exists(nodeRef) &&
+                @Override
-                    dictionaryService.getAllModels().contains(RM_CUSTOM_MODEL) &&
+                public Void doWork()
-                    isCustomisable(aspectTypeQName))
                 {
-                    QName customPropertyAspect = getCustomAspect(aspectTypeQName);
+                    if (nodeService.exists(nodeRef) &&
-                    nodeService.addAspect(nodeRef, customPropertyAspect, null);
+                        dictionaryService.getAllModels().contains(RM_CUSTOM_MODEL) &&
+                        isCustomisable(aspectTypeQName))
+                    {
+                        QName customPropertyAspect = getCustomAspect(aspectTypeQName);
+                        nodeService.addAspect(nodeRef, customPropertyAspect, null);
+                    }
+    
+                    return null;
                 }
-
+            }, AuthenticationUtil.getSystemUserName());
-                return null;
+        }
-            }
-        }, AuthenticationUtil.getSystemUserName());
     }
 
     /**
@@ -331,21 +366,24 @@ public class RecordsManagementAdminServiceImpl implements RecordsManagementAdmin
     )
     public void onRemoveAspect(final NodeRef nodeRef, final QName aspectTypeQName)
     {
-        AuthenticationUtil.runAs(new RunAsWork<Void>()
+        if (isCustomMapInit)
         {
-            @Override
+            AuthenticationUtil.runAs(new RunAsWork<Void>()
-            public Void doWork()
             {
-                if (nodeService.exists(nodeRef) &&
+                @Override
-                    isCustomisable(aspectTypeQName))
+                public Void doWork()
                 {
-                    QName customPropertyAspect = getCustomAspect(aspectTypeQName);
+                    if (nodeService.exists(nodeRef) &&
-                    nodeService.removeAspect(nodeRef, customPropertyAspect);
+                        isCustomisable(aspectTypeQName))
+                    {
+                        QName customPropertyAspect = getCustomAspect(aspectTypeQName);
+                        nodeService.removeAspect(nodeRef, customPropertyAspect);
+                    }
+    
+                    return null;
                 }
-
+            }, AuthenticationUtil.getSystemUserName());
-                return null;
+        }
-            }
-        }, AuthenticationUtil.getSystemUserName());
     }
 
     /**
@@ -362,47 +400,41 @@ public class RecordsManagementAdminServiceImpl implements RecordsManagementAdmin
     )
     public void onCreateNode(final ChildAssociationRef childAssocRef)
     {
-        AuthenticationUtil.runAs(new RunAsWork<Void>()
+        if (isCustomMapInit)
-        {
+        {            
-            @Override
+            AuthenticationUtil.runAs(new RunAsWork<Void>()
-            public Void doWork()
             {
-                if (dictionaryService.getAllModels().contains(RecordsManagementCustomModel.RM_CUSTOM_MODEL))
+                @Override
+                public Void doWork()
                 {
-                    NodeRef nodeRef = childAssocRef.getChildRef();
+                    if (dictionaryService.getAllModels().contains(RecordsManagementCustomModel.RM_CUSTOM_MODEL))
-                    QName type = nodeService.getType(nodeRef);
-                    while (type != null && !ContentModel.TYPE_CMOBJECT.equals(type))
                     {
-                        if (isCustomisable(type))
+                        NodeRef nodeRef = childAssocRef.getChildRef();
+                        QName type = nodeService.getType(nodeRef);
+                        while (type != null && !ContentModel.TYPE_CMOBJECT.equals(type))
                         {
-                            QName customPropertyAspect = getCustomAspect(type);
+                            if (isCustomisable(type))
-                            nodeService.addAspect(nodeRef, customPropertyAspect, null);
+                            {
-                        }
+                                QName customPropertyAspect = getCustomAspect(type);
-
+                                nodeService.addAspect(nodeRef, customPropertyAspect, null);
-                        TypeDefinition def = dictionaryService.getType(type);
+                            }
-                        if (def != null)
+    
-                        {
+                            TypeDefinition def = dictionaryService.getType(type);
-                            type = def.getParentName();
+                            if (def != null)
-                        }
+                            {
-                        else
+                                type = def.getParentName();
-                        {
+                            }
-                            type = null;
+                            else
+                            {
+                                type = null;
+                            }
                         }
                     }
+    
+                    return null;
                 }
-
+            }, AuthenticationUtil.getSystemUserName());
-                return null;
+        }
-            }
-        }, AuthenticationUtil.getSystemUserName());
-    }
-
-    /**
-     * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementAdminService#initialiseCustomModel()
-     */
-    public void initialiseCustomModel()
-    {
-        // Initialise the map
-        getCustomisableMap();
     }
 
     /**
@@ -483,6 +515,92 @@ public class RecordsManagementAdminServiceImpl implements RecordsManagementAdmin
 
         return result;
     }
+    
+    /**
+     * Initialise custom type map
+     */
+    private void initCustomMap()
+    {
+        customisableTypes = new HashMap<QName, QName>(7);
+        Collection<QName> aspects = dictionaryService.getAspects(RM_CUSTOM_MODEL);
+        for (QName aspect : aspects)
+        {
+            AspectDefinition aspectDef = dictionaryService.getAspect(aspect);
+            String name = aspectDef.getName().getLocalName();
+            if (name.endsWith("Properties"))
+            {
+                QName type = null;
+                String prefixString = aspectDef.getDescription(dictionaryService);
+                if (prefixString == null)
+                {
+                    // Backward compatibility from previous RM V1.0 custom models
+                    if (CompatibilityModel.NAME_CUSTOM_RECORD_PROPERTIES.equals(name))
+                    {
+                        type = RecordsManagementModel.ASPECT_RECORD;
+                    }
+                    else if (CompatibilityModel.NAME_CUSTOM_RECORD_FOLDER_PROPERTIES.equals(name))
+                    {
+                        type = RecordsManagementModel.TYPE_RECORD_FOLDER;
+                    }
+                    else if (CompatibilityModel.NAME_CUSTOM_RECORD_CATEGORY_PROPERTIES.equals(name))
+                    {
+                        type = RecordsManagementModel.TYPE_RECORD_CATEGORY;
+                    }
+                    else if (CompatibilityModel.NAME_CUSTOM_RECORD_SERIES_PROPERTIES.equals(name) &&
+                            // Only add the deprecated record series type as customisable if
+                            // a v1.0 installation has added custom properties
+                            aspectDef.getProperties().size() != 0)
+                    {
+                        type = CompatibilityModel.TYPE_RECORD_SERIES;
+                    }
+                }
+                else
+                {
+                    type = QName.createQName(prefixString, namespaceService);
+                }
+
+                // Add the customisable type to the map
+                if (type != null)
+                {
+                    customisableTypes.put(type, aspect);
+
+                    // Remove customisable type from the pending list
+                    if (pendingCustomisableTypes != null && pendingCustomisableTypes.contains(type))
+                    {
+                        pendingCustomisableTypes.remove(type);
+                    }
+                }
+            }
+        }
+
+        // Deal with any pending types left over
+        if (pendingCustomisableTypes != null && pendingCustomisableTypes.size() != 0)
+        {
+            NodeRef modelRef = getCustomModelRef(RecordsManagementModel.RM_CUSTOM_URI);
+            M2Model model = readCustomContentModel(modelRef);
+            try
+            {
+                for (QName customisableType : pendingCustomisableTypes)
+                {
+                    QName customAspect = getCustomAspectImpl(customisableType);
+
+                    // Create the new aspect to hold the custom properties
+                    M2Aspect aspect = model.createAspect(customAspect.toPrefixString(namespaceService));
+                    aspect.setDescription(customisableType.toPrefixString(namespaceService));
+
+                    // Make a record of the customisable type
+                    customisableTypes.put(customisableType, customAspect);
+                }
+            }
+            finally
+            {
+                writeCustomContentModel(modelRef, model);
+            }
+        }
+        
+        // indicate map is initialised
+        isCustomMapInit = true;
+    }
 
     /**
      * Gets a map containing all the customisable types
@@ -493,82 +611,7 @@ public class RecordsManagementAdminServiceImpl implements RecordsManagementAdmin
     {
     	if (customisableTypes == null)
     	{
-    		customisableTypes = new HashMap<QName, QName>(7);
+    		throw AlfrescoRuntimeException.create("Customisable map has not been initialised correctly.");
-	    	Collection<QName> aspects = dictionaryService.getAspects(RM_CUSTOM_MODEL);
-	    	for (QName aspect : aspects)
-	    	{
-	    		AspectDefinition aspectDef = dictionaryService.getAspect(aspect);
-	    		String name = aspectDef.getName().getLocalName();
-	    		if (name.endsWith("Properties"))
-	    		{
-	    			QName type = null;
-	    			String prefixString = aspectDef.getDescription(dictionaryService);
-	    			if (prefixString == null)
-	    			{
-	    				// Backward compatibility from previous RM V1.0 custom models
-	    				if (CompatibilityModel.NAME_CUSTOM_RECORD_PROPERTIES.equals(name))
-	    				{
-	    					type = RecordsManagementModel.ASPECT_RECORD;
-	    				}
-	    				else if (CompatibilityModel.NAME_CUSTOM_RECORD_FOLDER_PROPERTIES.equals(name))
-	    				{
-	    					type = RecordsManagementModel.TYPE_RECORD_FOLDER;
-	    				}
-	    				else if (CompatibilityModel.NAME_CUSTOM_RECORD_CATEGORY_PROPERTIES.equals(name))
-	    				{
-	    					type = RecordsManagementModel.TYPE_RECORD_CATEGORY;
-	    				}
-	    				else if (CompatibilityModel.NAME_CUSTOM_RECORD_SERIES_PROPERTIES.equals(name) &&
-	                            // Only add the deprecated record series type as customisable if
-	                            // a v1.0 installation has added custom properties
-	    				        aspectDef.getProperties().size() != 0)
-	    				{
-	    				    type = CompatibilityModel.TYPE_RECORD_SERIES;
-	    				}
-	    			}
-	    			else
-	    			{
-	    				type = QName.createQName(prefixString, namespaceService);
-	    			}
-
-	    			// Add the customisable type to the map
-	    			if (type != null)
-	    			{
-	    			    customisableTypes.put(type, aspect);
-
-            			// Remove customisable type from the pending list
-            			if (pendingCustomisableTypes != null && pendingCustomisableTypes.contains(type))
-            			{
-            			    pendingCustomisableTypes.remove(type);
-            			}
-	    			}
-	    		}
-			}
-
-	    	// Deal with any pending types left over
-	    	if (pendingCustomisableTypes != null && pendingCustomisableTypes.size() != 0)
-	    	{
-	    	    NodeRef modelRef = getCustomModelRef(RecordsManagementModel.RM_CUSTOM_URI);
-                M2Model model = readCustomContentModel(modelRef);
-	    	    try
-	    	    {
-        	    	for (QName customisableType : pendingCustomisableTypes)
-        	        {
-        	            QName customAspect = getCustomAspectImpl(customisableType);
-
-        	            // Create the new aspect to hold the custom properties
-        	            M2Aspect aspect = model.createAspect(customAspect.toPrefixString(namespaceService));
-        	            aspect.setDescription(customisableType.toPrefixString(namespaceService));
-
-        	            // Make a record of the customisable type
-                        customisableTypes.put(customisableType, customAspect);
-        	        }
-	    	    }
-	    	    finally
-	    	    {
-	    	        writeCustomContentModel(modelRef, model);
-	    	    }
-	    	}
     	}
     	return customisableTypes;
     }

rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/bootstrap/RecordsManagementBootstrap.java

@@ -18,7 +18,6 @@
  */
 package org.alfresco.module.org_alfresco_module_rm.bootstrap;
 
-import org.alfresco.module.org_alfresco_module_rm.admin.RecordsManagementAdminService;
 import org.alfresco.module.org_alfresco_module_rm.action.impl.SplitEmailAction;
 import org.alfresco.module.org_alfresco_module_rm.caveat.RMCaveatConfigService;
 import org.alfresco.module.org_alfresco_module_rm.email.CustomEmailMappingService;
@@ -40,8 +39,7 @@ public class RecordsManagementBootstrap extends AbstractLifecycleBean
     private TransactionService transactionService;
     private RMCaveatConfigService caveatConfigService;
     private CustomEmailMappingService customEmailMappingService;
-    private RecordsManagementAdminService adminService;
+    
-
     public void setTransactionService(TransactionService transactionService)
     {
         this.transactionService = transactionService;
@@ -57,11 +55,6 @@ public class RecordsManagementBootstrap extends AbstractLifecycleBean
         this.customEmailMappingService = customEmailMappingService;
     }
 
-    public void setRecordsManagementAdminService(RecordsManagementAdminService adminService)
-    {
-		this.adminService = adminService;
-	}
-
     public CustomEmailMappingService getCustomEmailMappingService()
     {
         return customEmailMappingService;
@@ -82,9 +75,6 @@ public class RecordsManagementBootstrap extends AbstractLifecycleBean
                         // initialise caveat config
                         caveatConfigService.init();
 
-                        // Initialise the custom model
-                        adminService.initialiseCustomModel();
-
                         // Initialise the SplitEmailAction
                         SplitEmailAction action = (SplitEmailAction)getApplicationContext().getBean("splitEmail");
                         action.bootstrap();