Merged HEAD-BUG-FIX (5.0/Cloud) to HEAD (5.0/Cloud)

75030: Merged WAT2 (5.0/Cloud) to HEAD-BUG-FIX (5.0/Cloud)
      71714: Added a event publishing test to WebDAVHelper


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

source/java/org/alfresco/repo/events/AbstractEventPublisher.java

@@ -0,0 +1,80 @@
+/*
+ * Copyright (C) 2005-2014 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.events;
+
+import org.alfresco.events.types.BrowserEvent;
+import org.alfresco.events.types.Event;
+import org.alfresco.repo.security.authentication.AuthenticationUtil;
+import org.alfresco.repo.tenant.TenantUtil;
+import org.alfresco.repo.transaction.AlfrescoTransactionSupport;
+import org.springframework.extensions.webscripts.WebScriptRequest;
+
+/**
+ * An abstract implementation of some of the EventPublisher functionality.
+ *
+* @author Gethin James
+* @since 5.0
+ */
+public abstract class AbstractEventPublisher implements EventPublisher
+{
+    @Override
+    public void publishBrowserEvent(final WebScriptRequest req, final String siteId, final String component, final String action, final String attributes)
+    {
+        publishEvent(new EventPreparator(){
+            @Override
+            public Event prepareEvent(String user, String networkId, String transactionId)
+            {
+                String agent = req.getHeader("user-agent");
+                return new BrowserEvent(user, networkId, transactionId, siteId, component, action, agent, attributes);
+            }
+        });
+    }
+    
+    /**
+     * Gets userful information from the current thread for use when creating an event
+     * @return ThreadInfo
+     */
+    protected ThreadInfo getThreadInfo()
+    {
+        return new ThreadInfo(
+                    AuthenticationUtil.getFullyAuthenticatedUser(),
+                    AlfrescoTransactionSupport.getTransactionId(),
+                    TenantUtil.getCurrentDomain());
+    }
+    
+    /**
+     * Basic information from a thread
+     *
+     */
+    protected static class ThreadInfo {
+        protected final String user;
+        protected final String transaction;
+        protected final String network;
+        
+        public ThreadInfo(String user, String transaction, String network)
+        {
+            super();
+            this.user = user;
+            this.transaction = transaction;
+            this.network = network;
+        }
+    }
+
+
+}

source/java/org/alfresco/repo/events/NoOpEventPublisher.java

@@ -18,14 +18,7 @@
  */
 package org.alfresco.repo.events;
 
-import org.alfresco.events.types.BrowserEvent;
 import org.alfresco.events.types.Event;
-import org.alfresco.repo.security.authentication.AuthenticationUtil;
-import org.alfresco.repo.tenant.TenantUtil;
-import org.alfresco.repo.transaction.AlfrescoTransactionSupport;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.extensions.webscripts.WebScriptRequest;
 
 /**
  * An implementation of EventPublisher that does nothing.
@@ -33,39 +26,18 @@ import org.springframework.extensions.webscripts.WebScriptRequest;
  * @author Gethin James
  * @since 5.0
  */
-public class NoOpEventPublisher implements EventPublisher {
+public class NoOpEventPublisher extends AbstractEventPublisher implements EventPublisher {
-
-    private static final Logger logger = LoggerFactory.getLogger(NoOpEventPublisher.class);
 
     @Override
     public void publishEvent(Event event)
     {
-    	if (logger.isDebugEnabled())
+        //Do nothing
-    	{
-            logger.debug("No event published for [" + event + "]");
-        }
     }
 
     @Override
     public void publishEvent(EventPreparator prep)
     {
-    	if (logger.isDebugEnabled())
+        //Do nothing
-    	{
-            logger.debug("No event published with preparator.");
-        }
-    }
-
-    @Override
-    public void publishBrowserEvent(final WebScriptRequest req, final String siteId, final String component, final String action, final String attributes)
-    {
-        publishEvent(new EventPreparator(){
-            @Override
-            public Event prepareEvent(String user, String networkId, String transactionId)
-            {
-                String agent = req.getHeader("user-agent");
-                return new BrowserEvent(user, networkId, transactionId, siteId, component, action, agent, attributes);
-            }
-        });
     }
 	
 }

source/test-java/org/alfresco/repo/events/EventPublisherForTestingOnly.java

@@ -0,0 +1,84 @@
+/*
+ * Copyright (C) 2005-2014 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.events;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Queue;
+import java.util.concurrent.ConcurrentLinkedQueue;
+
+import org.alfresco.events.types.Event;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * An implementation of EventPublisher that is used for testing
+ *
+ * @author Gethin James
+ * @since 5.0
+ */
+public class EventPublisherForTestingOnly extends AbstractEventPublisher implements EventPublisher
+{
+    private static final Logger logger = LoggerFactory.getLogger(EventPublisherForTestingOnly.class);
+    Queue<Event> queue = new ConcurrentLinkedQueue<Event>();
+    
+    @Override
+    public void publishEvent(Event event)
+    {
+        queue.add(event);
+        log("Event published for [" + event + "]");
+    }
+
+    @Override
+    public void publishEvent(EventPreparator prep)
+    {
+        ThreadInfo info = getThreadInfo();
+        Event event = prep.prepareEvent(info.user, info.network, info.transaction);
+        queue.add(event);
+        log("Event published: [" + event + "]");
+    }
+
+    private void log (String logMessage)
+    {
+        if (logger.isDebugEnabled())
+        {
+            logger.debug(logMessage);
+        }  
+    }
+    
+    public Queue<Event> getQueue()
+    {
+        return this.queue;
+    }
+    
+    @SuppressWarnings("unchecked")
+    public <T extends Event> List<T> getQueueByType(Class<T> type)
+    {
+        List<T> toReturn = new ArrayList<>();
+        for (Event event : queue)
+        {
+           if (type.equals(event.getClass()))
+           {
+               toReturn.add((T) event);
+           }
+        }
+        return (List<T>) toReturn;
+    }
+
+}

source/test-resources/alfresco/extension/overides-for-testing-context.xml

@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+    xmlns:context="http://www.springframework.org/schema/context"
+    xsi:schemaLocation="http://www.springframework.org/schema/context
+          http://www.springframework.org/schema/context/spring-context-3.0.xsd
+          http://www.springframework.org/schema/beans
+          http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
+          
+  <!-- Beans used for testing that overide funtionality in the core product -->
+  <bean id="eventPublisher" class="org.alfresco.repo.events.EventPublisherForTestingOnly" />
+</beans>