Audit session and bootstrap support

- Sessions are created using an application name (shared prop) and a persisted model ID
 - Added a bootstrap bean for audit that unmarshalls the models
 - Added hook points for repo-loading models, but won't implement yet


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

source/java/org/alfresco/repo/audit/model/AuditModelRegistry.java

@@ -24,17 +24,33 @@
  */
 package org.alfresco.repo.audit.model;
 
+import java.io.BufferedInputStream;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
 import java.net.URL;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.locks.ReentrantReadWriteLock;
 
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBElement;
+import javax.xml.bind.Unmarshaller;
+
+import org.alfresco.error.AlfrescoRuntimeException;
 import org.alfresco.repo.audit.extractor.DataExtractor;
 import org.alfresco.repo.audit.generator.DataGenerator;
 import org.alfresco.repo.audit.model._3.Application;
 import org.alfresco.repo.audit.model._3.Audit;
 import org.alfresco.repo.audit.model._3.DataExtractors;
 import org.alfresco.repo.audit.model._3.DataGenerators;
+import org.alfresco.repo.domain.audit.AuditDAO;
+import org.alfresco.service.cmr.repository.NodeRef;
 
 /**
  * Component used to store audit model definitions.  It ensures that duplicate application and converter
@@ -45,26 +61,191 @@ import org.alfresco.repo.audit.model._3.DataGenerators;
  */
 public class AuditModelRegistry
 {
-    private final Map<URL, Audit> auditModelsByUrl;
+    private AuditDAO auditDAO;
+    
+    private final ReentrantReadWriteLock.ReadLock readLock;
+    private final ReentrantReadWriteLock.WriteLock writeLock;
+    
+    private final Set<URL> auditModelUrls;
+    private final List<Audit> auditModels;
     private final Map<String, DataExtractor> dataExtractorsByName;
     private final Map<String, DataGenerator> dataGeneratorsByName;
+    /**
+     * Used to lookup the audit application java hierarchy 
+     */
     private final Map<String, Application> auditApplicationsByName;
+    /**
+     * Used to lookup a reference to the persisted config binary for an application
+     */
+    private final Map<String, Long> auditModelIdsByApplicationsName;
     
+    /**
+     * Default constructor
+     */
     public AuditModelRegistry()
     {
-        auditModelsByUrl = new HashMap<URL, Audit>(7);
+        ReentrantReadWriteLock lock = new ReentrantReadWriteLock();
+        readLock = lock.readLock();
+        writeLock = lock.writeLock();
+        
+        auditModelUrls = new HashSet<URL>(7);
+        auditModels = new ArrayList<Audit>(7);
         dataExtractorsByName = new HashMap<String, DataExtractor>(13);
         dataGeneratorsByName = new HashMap<String, DataGenerator>(13);
         auditApplicationsByName = new HashMap<String, Application>(7);
+        auditModelIdsByApplicationsName = new HashMap<String, Long>(7);
+    }
+
+    /**
+     * Set the DAO used to persisted the registered audit models
+     */
+    public void setAuditDAO(AuditDAO auditDAO)
+    {
+        this.auditDAO = auditDAO;
+    }
+
+    /**
+     * Register an audit model at a given URL.
+     * 
+     * @param auditModelUrl             the source of the model
+     */
+    public void registerModel(URL auditModelUrl)
+    {
+        writeLock.lock();
+        try
+        {
+            if (auditModelUrls.contains(auditModelUrl))
+            {
+                throw new AlfrescoRuntimeException(
+                        "An audit model has already been registered at URL " + auditModelUrl);
+            }
+            auditModelUrls.add(auditModelUrl);
+        }
+        finally
+        {
+            writeLock.unlock();
+        }
     }
     
     /**
-     * Register an audit model.
+     * Register an audit model at a given node reference.
      * 
-     * @param configurationUrl              the source of the configuration
-     * @param audit                         the unmarshalled instance tree
+     * @param auditModelNodeRef         the source of the audit model
      */
-    public void registerModel(URL configurationUrl, Audit audit)
+    public void registerModel(NodeRef auditModelNodeRef)
+    {
+        writeLock.lock();
+        try
+        {
+            throw new UnsupportedOperationException();
+        }
+        finally
+        {
+            writeLock.unlock();
+        }
+    }
+    
+    /**
+     * Method to load audit models into memory.  This method is also responsible for persisting
+     * the audit models for later retrieval.  Models are loaded from the locations given by the
+     * {@link #registerModel(URL) register} methods.
+     */
+    public void loadAuditModels()
+    {
+        writeLock.lock();
+        try
+        {
+            // Load models from the URLs
+            for (URL auditModelUrl : auditModelUrls)
+            {
+                Audit audit = AuditModelRegistry.unmarshallModel(auditModelUrl);
+                // That worked, so now get an input stream and write the model
+                Long auditModelId = auditDAO.getOrCreateAuditModel(auditModelUrl).getFirst();
+                // Now cache it (eagerly)
+                cacheAuditElements(auditModelId, audit);
+            }
+            // NOTE: If we support other types of loading, then that will have to go here, too
+        }
+        finally
+        {
+            writeLock.unlock();
+        }
+    }
+    
+    /**
+     * Get the ID of the persisted audit model for the given application name
+     * 
+     * @param application           the name of the audited application
+     * @return                      the unique ID of the persisted model (<tt>null</tt> if not found)
+     */
+    public Long getAuditModelId(String application)
+    {
+        readLock.lock();
+        try
+        {
+            return auditModelIdsByApplicationsName.get(application);
+        }
+        finally
+        {
+            readLock.unlock();
+        }
+    }
+    
+    /**
+     * Unmarshalls the Audit model from the URL.
+     * 
+     * @throws AlfrescoRuntimeException         if an IOException occurs
+     */
+    public static Audit unmarshallModel(URL configUrl)
+    {
+        try
+        {
+            File file = new File(configUrl.getFile());
+            if (!file.exists())
+            {
+                throw new AlfrescoRuntimeException("The Audit model XML was not found: " + configUrl);
+            }
+            
+            // Load it
+            InputStream is = new BufferedInputStream(new FileInputStream(file));
+            return unmarshallModel(is, configUrl.toString());
+        }
+        catch (IOException e)
+        {
+            throw new AlfrescoRuntimeException("The Audit model XML failed to load: " + configUrl, e);
+        }
+    }
+
+    /**
+     * Unmarshalls the Audit model from a stream
+     */
+    private static Audit unmarshallModel(InputStream is, String source)
+    {
+        try
+        {
+            JAXBContext jaxbCtx = JAXBContext.newInstance("org.alfresco.repo.audit.model._3");
+            Unmarshaller jaxbUnmarshaller = jaxbCtx.createUnmarshaller();
+            @SuppressWarnings("unchecked")
+            JAXBElement<Audit> auditElement = (JAXBElement<Audit>) jaxbUnmarshaller.unmarshal(is);
+            Audit audit = auditElement.getValue();
+            // Done
+            return audit;
+        }
+        catch (Throwable e)
+        {
+            throw new AlfrescoRuntimeException(
+                    "Failed to read Audit model XML: \n" +
+                    "   Source: " + source + "\n" +
+                    "   Error:  " + e.getMessage(),
+                    e);
+        }
+        finally
+        {
+            try { is.close(); } catch (IOException e) {}
+        }
+    }
+    
+    private void cacheAuditElements(Long auditModelId, Audit audit)
     {
         // Get the data extractors and check for duplicates
         DataExtractors extractorsElement = audit.getDataExtractors();
@@ -134,8 +315,9 @@ public class AuditModelRegistry
                 throw new AuditModelException("Audit application '" + name + "' has already been defined.");
             }
             auditApplicationsByName.put(name, application);
+            auditModelIdsByApplicationsName.put(name, auditModelId);
         }
-        // Store the model
-        auditModelsByUrl.put(configurationUrl, audit);
+        // Store the model itself
+        auditModels.add(audit);
     }
 }