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/AuditBootstrap.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright (C) 2005-2009 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.repo.audit;
+
+import org.alfresco.repo.audit.model.AuditModelRegistry;
+import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
+import org.alfresco.service.transaction.TransactionService;
+import org.alfresco.util.AbstractLifecycleBean;
+import org.springframework.context.ApplicationEvent;
+
+/**
+ * Starts all the necessary audit functionality once the repository has started.
+ * 
+ * @author Derek Hulley
+ * @since 3.2
+ */
+public class AuditBootstrap extends AbstractLifecycleBean
+{
+    private TransactionService transactionService;
+    private AuditModelRegistry auditModelRegistry;
+    
+    public void setTransactionService(TransactionService transactionService)
+    {
+        this.transactionService = transactionService;
+    }
+
+    public void setAuditModelRegistry(AuditModelRegistry registry)
+    {
+        this.auditModelRegistry = registry;
+    }
+
+    /**
+     * @see AuditModelRegistry#loadAuditModels()
+     */
+    @Override
+    protected void onBootstrap(ApplicationEvent event)
+    {
+        RetryingTransactionCallback<Void> callback = new RetryingTransactionCallback<Void>()
+        {
+            public Void execute() throws Throwable
+            {
+                auditModelRegistry.loadAuditModels();
+                return null;
+            }
+        };
+        transactionService.getRetryingTransactionHelper().doInTransaction(callback);
+    }
+
+    /**
+     * No-op
+     */
+    @Override
+    protected void onShutdown(ApplicationEvent event)
+    {
+    }
+}

source/java/org/alfresco/repo/audit/AuditBootstrapTest.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright (C) 2005-2009 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.repo.audit;
+
+import junit.framework.TestCase;
+
+import org.alfresco.repo.audit.model.AuditModelRegistry;
+import org.alfresco.util.ApplicationContextHelper;
+import org.springframework.context.ApplicationContext;
+
+/**
+ * Tests that auditing is loaded properly on repository startup.
+ * 
+ * @see AuditBootstrap
+ * 
+ * @author Derek Hulley
+ * @since 3.2
+ */
+public class AuditBootstrapTest extends TestCase
+{
+    private static final String APPLICATION_REPOSITORY = "Alfresco Repository";
+    
+    private static ApplicationContext ctx = ApplicationContextHelper.getApplicationContext();
+    
+    private AuditModelRegistry auditModelRegistry;
+    
+    @Override
+    public void setUp() throws Exception
+    {
+        auditModelRegistry = (AuditModelRegistry) ctx.getBean("auditModel.registry");
+    }
+    
+    public void testSetUp()
+    {
+        // Just here to fail if the basic startup fails
+    }
+    
+    public void testGetModelId()
+    {
+        Long repoId = auditModelRegistry.getAuditModelId(APPLICATION_REPOSITORY);
+        assertNotNull("No audit model ID for " + APPLICATION_REPOSITORY, repoId);
+    }
+}

source/java/org/alfresco/repo/audit/AuditComponent.java

@@ -77,14 +77,23 @@ public interface AuditComponent
      */
     public List<AuditInfo> getAuditTrail(NodeRef nodeRef);
 
+    /*
+     * V3.2 from here on.  Put all fixes to the older audit code before this point, please.
+     */
+
     /**
      * Start an audit session for the given root path.  All later audit operations on the resulting
      * session will be relative to this root path.
+     * <p/>
+     * The name of the application controls part of the audit model will be used.  The root path must
+     * start with the matching <b>key</b> attribute that was declared for the matching
+     * <b>Application</b> element in the audit configuration.
      * 
+     * @param application       the name of the application to log against
      * @param rootPath          a base path of {@link AuditPath} key entries concatenated with <b>.</b> (period)
      * @return                  Returns the unique session identifier
      */
-    public Long startAuditSession(String rootPath);
+    public Long startAuditSession(String application, String rootPath);
     
     /**
      * Record a set of values against the given session.

source/java/org/alfresco/repo/audit/AuditComponentImpl.java

@@ -761,7 +761,7 @@ public class AuditComponentImpl implements AuditComponent
      * V3.2 from here on.  Put all fixes to the older audit code before this point, please.
      */
 
-    public Long startAuditSession(String rootPath)
+    public Long startAuditSession(String application, String rootPath)
     {
         throw new UnsupportedOperationException();
     }

source/java/org/alfresco/repo/audit/AuditSession.java

@@ -0,0 +1,95 @@
+/*
+ * Copyright (C) 2005-2009 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.repo.audit;
+
+import org.alfresco.repo.audit.model._3.Application;
+import org.alfresco.util.ParameterCheck;
+
+/**
+ * Entity bean for <b>alf_audit_session</b> table.
+ * 
+ * @author Derek Hulley
+ * @since 3.2
+ */
+public class AuditSession
+{
+    private final Application application;
+    private final String rootPath;
+    
+    public AuditSession(Application application, String rootPath)
+    {
+        ParameterCheck.mandatory("application", application);
+        ParameterCheck.mandatoryString("rootPath", rootPath);
+        
+        this.application = application;
+        this.rootPath = rootPath;
+    }
+    
+    @Override
+    public int hashCode()
+    {
+        return (application.getName().hashCode() + rootPath.hashCode());
+    }
+    
+    @Override
+    public boolean equals(Object obj)
+    {
+        if (this == obj)
+        {
+            return true;
+        }
+        else if (obj instanceof AuditSession)
+        {
+            AuditSession that = (AuditSession) obj;
+            return this.application.getName().equals(that.application.getName()) &&
+                   this.rootPath.equals(that.rootPath);
+        }
+        else
+        {
+            return false;
+        }
+    }
+    
+    @Override
+    public String toString()
+    {
+        StringBuilder sb = new StringBuilder(512);
+        sb.append("AuditSession")
+          .append("[ application=").append(application.getName())
+          .append(", rootPath=").append(rootPath)
+          .append("]");
+        return sb.toString();
+    }
+
+    public Application getApplication()
+    {
+        return application;
+    }
+
+    public String getRootPath()
+    {
+        return rootPath;
+    }
+}

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

@@ -24,40 +24,32 @@
  */
 package org.alfresco.repo.audit.model;
 
-import java.io.File;
 import java.net.URL;
 
-import javax.xml.bind.JAXBContext;
-import javax.xml.bind.JAXBElement;
-import javax.xml.bind.UnmarshalException;
-import javax.xml.bind.Unmarshaller;
-
-import org.alfresco.error.AlfrescoRuntimeException;
-import org.alfresco.repo.audit.model._3.Audit;
 import org.alfresco.util.PropertyCheck;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.util.ResourceUtils;
 
 /**
- * A component used to load Audit configuration XML documents.
+ * A component used to load Audit model XML documents.
  * 
  * @author Derek Hulley
  * @since 3.2
  */
 public class AuditModelReader implements InitializingBean
 {
-    private URL configUrl;
+    private URL auditModelUrl;
     private AuditModelRegistry auditModelRegistry;
     
     /**
      * Set the XML location using <b>file:</b>, <b>classpath:</b> or any of the
      * {@link ResourceUtils Spring-supported} formats.
      * 
-     * @param configUrl             the location of the XML file
+     * @param auditModelUrl         the location of the XML file
      */
-    public void setConfigUrl(URL configUrl)
+    public void setAuditModelUrl(URL auditModelUrl)
     {
-        this.configUrl = configUrl;
+        this.auditModelUrl = auditModelUrl;
     }
 
     /**
@@ -74,32 +66,9 @@ public class AuditModelReader implements InitializingBean
      */
     public void afterPropertiesSet() throws Exception
     {
-        PropertyCheck.mandatory(this, "configUrl", configUrl);
+        PropertyCheck.mandatory(this, "configUrl", auditModelUrl);
         PropertyCheck.mandatory(this, "auditModelRegistry", auditModelRegistry);
         
-        File file = new File(configUrl.getFile());
-        if (!file.exists())
-        {
-            throw new AlfrescoRuntimeException("The Audit configuration XML was not found: " + configUrl);
-        }
-        
-        // Load it
-        JAXBContext jaxbCtx = JAXBContext.newInstance("org.alfresco.repo.audit.model._3");
-        Unmarshaller jaxbUnmarshaller = jaxbCtx.createUnmarshaller();
-        try
-        {
-            @SuppressWarnings("unchecked")
-            JAXBElement<Audit> auditElement = (JAXBElement<Audit>) jaxbUnmarshaller.unmarshal(configUrl);
-            Audit audit = auditElement.getValue();
-            // Now register it
-            auditModelRegistry.registerModel(configUrl, audit);
-        }
-        catch (UnmarshalException e)
-        {
-            throw new AlfrescoRuntimeException(
-                    "Failed to read Audit configuration XML: \n" +
-                    "   URL:   " + configUrl + "\n" +
-                    "   Error: " + e.getMessage());
-        }
+        auditModelRegistry.registerModel(auditModelUrl);
     }
 }

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);
     }
 }