Merged DEV\EXTENSIONS to HEAD

svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/DEV/EXTENSIONS@4868 svn://svn.alfresco.com:3691/alfresco/BRANCHES/DEV/EXTENSIONS@4869 .
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/DEV/EXTENSIONS@4904 svn://svn.alfresco.com:3691/alfresco/BRANCHES/DEV/EXTENSIONS@4938 .
   Module management support
   Modularization of Records Management


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

source/java/org/alfresco/repo/module/ModuleServiceImpl.java

@@ -0,0 +1,192 @@
+/*
+ * Copyright (C) 2007 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.repo.module;
+
+import java.io.BufferedInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.alfresco.error.AlfrescoRuntimeException;
+import org.alfresco.repo.admin.registry.RegistryService;
+import org.alfresco.repo.security.authentication.AuthenticationComponent;
+import org.alfresco.service.ServiceRegistry;
+import org.alfresco.service.cmr.module.ModuleDetails;
+import org.alfresco.service.cmr.module.ModuleService;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.springframework.core.io.Resource;
+import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
+
+/**
+ * This component controls the execution of
+ * {@link org.alfresco.repo.module.runtime.ModuleComponent module startup components}.
+ * <p/>
+ * All required startup executions are performed in a single transaction, so this
+ * component guarantees that the module initialization is consistent.  Module components are
+ * executed in dependency order <i>only</i>.  The version numbering is not to be used
+ * for ordering purposes.
+ * <p/>
+ * Afterwards, execution details are persisted in the
+ * {@link org.alfresco.repo.admin.registry.RegistryService service registry} to be used when the
+ * server starts up again.
+ *
+ * @author Roy Wetherall
+ * @author Derek Hulley
+ * @since 2.0
+ */
+public class ModuleServiceImpl implements ModuleService
+{
+    /** Error messages **/
+    private static final String ERR_UNABLE_TO_OPEN_MODULE_PROPETIES = "module.err.unable_to_open_module_properties";
+
+    /** The classpath search path for module properties */
+    private static final String MODULE_CONFIG_SEARCH_ALL = "classpath*:alfresco/module/*/module.properties";
+    
+    private static Log logger = LogFactory.getLog(ModuleServiceImpl.class);
+
+    private ServiceRegistry serviceRegistry;
+    private AuthenticationComponent authenticationComponent;
+    private ModuleComponentHelper moduleComponentHelper;
+    /** A cache of module details by module ID */
+    private Map<String, ModuleDetails> moduleDetailsById;    
+
+    /** Default constructor */
+    public ModuleServiceImpl()
+    {
+        moduleComponentHelper = new ModuleComponentHelper();
+        moduleComponentHelper.setModuleService(this);
+    }
+
+    public void setServiceRegistry(ServiceRegistry serviceRegistry)
+    {
+        this.serviceRegistry = serviceRegistry;
+        this.moduleComponentHelper.setServiceRegistry(this.serviceRegistry);
+    }
+
+    /**
+     * @param authenticationComponent allows execution as system user.
+     */
+    public void setAuthenticationComponent(AuthenticationComponent authenticationComponent)
+    {
+        this.authenticationComponent = authenticationComponent;
+        this.moduleComponentHelper.setAuthenticationComponent(this.authenticationComponent);
+    }
+
+    /**
+     * @param registryService the service used to persist component execution details.
+     */
+    public void setRegistryService(RegistryService registryService)
+    {
+        this.moduleComponentHelper.setRegistryService(registryService);
+    }
+    
+    /**
+     * @see ModuleComponentHelper#registerComponent(ModuleComponent)
+     */
+    public void registerComponent(ModuleComponent component)
+    {
+        this.moduleComponentHelper.registerComponent(component);
+    }
+    
+    /**
+     * @inheritDoc
+     * 
+     * @see ModuleComponentHelper#startModules()
+     */
+    public void startModules()
+    {
+        moduleComponentHelper.startModules();
+    }
+    
+    /**
+     * @inheritDoc
+     */
+    public ModuleDetails getModule(String moduleId)
+    {
+        cacheModuleDetails();
+        // Get the details of the specific module
+        ModuleDetails details = moduleDetailsById.get(moduleId);
+        // Done
+        return details;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public List<ModuleDetails> getAllModules()
+    {
+        cacheModuleDetails();
+        Collection<ModuleDetails> moduleDetails = moduleDetailsById.values();
+        // Make a copy to avoid modification of cached data by clients (and to satisfy API)
+        List<ModuleDetails> result = new ArrayList<ModuleDetails>(moduleDetails);
+        // Done
+        return result;
+    }
+
+    /**
+     * Ensure that the {@link #moduleDetailsById module details} are populated.
+     * <p/>
+     * TODO: We will have to avoid caching or add context listening if we support reloading
+     *       of beans one day.
+     */
+    private synchronized void cacheModuleDetails()
+    {
+        if (moduleDetailsById != null)
+        {
+            // There is nothing to do
+            return;
+        }
+        try
+        {
+            moduleDetailsById = new HashMap<String, ModuleDetails>(13);
+            
+            PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
+            Resource[] resources = resolver.getResources(MODULE_CONFIG_SEARCH_ALL);
+            
+            // Read each resource
+            for (Resource resource : resources)
+            {
+                try
+                {
+                    InputStream is = new BufferedInputStream(resource.getInputStream());
+                    ModuleDetails details = new ModuleDetailsImpl(is);
+                    moduleDetailsById.put(details.getId(), details);
+                }
+                catch (Throwable e)
+                {
+                    throw AlfrescoRuntimeException.create(e, ERR_UNABLE_TO_OPEN_MODULE_PROPETIES, resource);
+                }
+            }
+        }
+        catch (IOException e)
+        {
+            throw new AlfrescoRuntimeException("Failed to retrieve module information", e);
+        }
+        // Done
+        if (logger.isDebugEnabled())
+        {
+            logger.debug(
+                    "Found " + moduleDetailsById.size() + " modules: \n" +
+                    "   Modules: " + moduleDetailsById);
+        }
+    }
+}