ALF-4106 (ALF-4103): AuditService enhancements

- Additional methods to get all available applications
 - Web Script retrieval of applications and enabled/disabled states
 - Tests


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

config/alfresco/templates/webscripts/org/alfresco/repository/audit/control.get.desc.xml

@@ -1,7 +1,7 @@
 <webscript>
   <shortname>Alfresco Audit Service Control</shortname>
   <description>Get audit status for a given application and path</description>
-  <url>/api/audit/control?app={application?}&amp;path={path?}</url>
+  <url>/api/audit/control?application={application?}&amp;path={path?}</url>
   <format default="json" />
   <authentication>admin</authentication>
   <transaction allow="readonly">required</transaction>

source/java/org/alfresco/repo/web/scripts/audit/AbstractAuditWebScript.java

@@ -38,6 +38,11 @@ public abstract class AbstractAuditWebScript extends AbstractWebScript
     public static final String PARAM_APP = "app";
     public static final String PARAM_PATH="path";
     
+    public static final String JSON_KEY_APPLICATIONS = "applications";
+    public static final String JSON_KEY_NAME = "name";
+    public static final String JSON_KEY_PATH = "path";
+    public static final String JSON_KEY_ENABLED = "enabled";
+    
     /**
      * Logger that can be used by subclasses.
      */

source/java/org/alfresco/repo/web/scripts/audit/AuditWebScriptTest.java

@@ -18,9 +18,12 @@
  */
 package org.alfresco.repo.web.scripts.audit;
 
+import java.util.Set;
+
 import org.alfresco.repo.security.authentication.AuthenticationUtil;
 import org.alfresco.repo.web.scripts.BaseWebScriptTest;
 import org.alfresco.service.cmr.audit.AuditService;
+import org.json.JSONArray;
 import org.json.JSONObject;
 import org.springframework.context.ApplicationContext;
 import org.springframework.extensions.webscripts.TestWebScriptServer;
@@ -57,7 +60,9 @@ public class AuditWebScriptTest extends BaseWebScriptTest
     
     public void testGetWithoutPermissions() throws Exception
     {
-        
+        String url = "/api/audit/control";
+        TestWebScriptServer.GetRequest req = new TestWebScriptServer.GetRequest(url);
+        sendRequest(req, 401, AuthenticationUtil.getGuestRoleName());
     }
     
     public void testGetIsAuditEnabledGlobally() throws Exception
@@ -67,10 +72,27 @@ public class AuditWebScriptTest extends BaseWebScriptTest
         String url = "/api/audit/control";
         TestWebScriptServer.GetRequest req = new TestWebScriptServer.GetRequest(url);
         
-        //First, we'll try the request as a simple, non-admin user (expect a 401)
         Response response = sendRequest(req, 200, admin);
         JSONObject json = new JSONObject(response.getContentAsString());
         boolean enabled = json.getBoolean("enabled");
         assertEquals("Mismatched global audit enabled", checkEnabled, enabled);
     }
+    
+    public void testGetIsAuditEnabledMissingApp() throws Exception
+    {
+        boolean checkEnabled = auditService.isAuditEnabled();
+        Set<String> checkApps = auditService.getAuditApplications();
+
+        String url = "/api/audit/control?app=xxx";
+        TestWebScriptServer.GetRequest req = new TestWebScriptServer.GetRequest(url);
+        
+        //First, we'll try the request as a simple, non-admin user (expect a 401)
+        Response response = sendRequest(req, 200, admin);
+        JSONObject json = new JSONObject(response.getContentAsString());
+        boolean enabled = json.getBoolean("enabled");
+        assertEquals("Mismatched global audit enabled", checkEnabled, enabled);
+        JSONArray apps = json.getJSONArray(AbstractAuditWebScript.JSON_KEY_APPLICATIONS);
+        // We expect that the unknown application is returned with the others
+        assertEquals("Incorrect number of applications reported", checkApps.size()+1, apps.length());
+    }
 }

source/java/org/alfresco/repo/web/scripts/audit/ControlGet.java

@@ -20,11 +20,13 @@ package org.alfresco.repo.web.scripts.audit;
 
 import java.io.IOException;
 import java.io.StringWriter;
+import java.nio.charset.Charset;
+import java.util.Collections;
+import java.util.Set;
 
 import org.springframework.extensions.webscripts.Status;
 import org.springframework.extensions.webscripts.WebScriptRequest;
 import org.springframework.extensions.webscripts.WebScriptResponse;
-import org.springframework.extensions.webscripts.json.JSONUtils;
 import org.springframework.extensions.webscripts.json.JSONWriter;
 
 /**
@@ -36,34 +38,53 @@ public class ControlGet extends AbstractAuditWebScript
     @Override
     public void execute(WebScriptRequest req, WebScriptResponse res) throws IOException
     {
+        // return the unique transfer id (the lock id)
+        JSONWriter json = new JSONWriter(res.getWriter());
+
         String app = getApp(req, false);
         String path = getPath(req);
+        Set<String> apps = (app == null ? auditService.getAuditApplications() : Collections.singleton(app));
         
-        boolean enabled = false;
+        boolean enabledGlobal = auditService.isAuditEnabled();
-        if (app == null)
+        json.startObject();
         {
-            enabled = auditService.isAuditEnabled();
+            json.writeValue(JSON_KEY_ENABLED, enabledGlobal);
-        }
+            if (apps.size() > 0)
-        else
             {
-            enabled = auditService.isAuditEnabled(app, path);
+                json.startValue(JSON_KEY_APPLICATIONS);
+                {
+                    json.startArray();
+                    {
+                        for (String appName : apps)
+                        {
+                            boolean enabled = auditService.isAuditEnabled(appName, path);
+                            json.startObject();
+                            {
+                                json.writeValue(JSON_KEY_NAME, appName);
+                                json.writeValue(JSON_KEY_PATH, path);
+                                json.writeValue(JSON_KEY_ENABLED, enabled);
                             }
+                            json.endObject();
+                        }
+                    }
+                    json.endArray();
+                }
+                json.endValue();
+            }
+        }
+        json.endObject();
         
-        // return the unique transfer id (the lock id)
+        // Close off
-        StringWriter stringWriter = new StringWriter(300);
+        res.getWriter().close();
-        JSONWriter jsonWriter = new JSONWriter(stringWriter);
-        jsonWriter.startObject();
-        jsonWriter.writeValue("app", app);
-        jsonWriter.writeValue("path", path);
-        jsonWriter.writeValue("enabled", enabled);
-        jsonWriter.endObject();
-        String response = stringWriter.toString();
 
         res.setContentType("application/json");
-        res.setContentEncoding("UTF-8");
+        res.setContentEncoding(Charset.defaultCharset().displayName());     // TODO: Should be settable on JSONWriter
-        int length = response.getBytes("UTF-8").length;
+        //        res.addHeader("Content-Length", "" + length);             // TODO: Do we need this?
-        res.addHeader("Content-Length", "" + length);
         res.setStatus(Status.STATUS_OK);
-        res.getWriter().write(response);
+    }
+    
+    protected void writeResponse(JSONWriter json)
+    {
+        
     }
 }