JMX Dump webscript and Share Admin Console tool

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

config/alfresco/templates/webscripts/org/alfresco/repository/admin/jmxdump.get.desc.xml

@@ -0,0 +1,10 @@
+<webscript>
+  <shortname>JMXDump</shortname>
+  <description>
+  <![CDATA[Stream the JMX property dump as a .zip content file]]>
+  </description>
+  <url>/api/admin/jmxdump</url>
+  <authentication>admin</authentication>
+  <transaction allow="readonly"/>
+  <lifecycle>internal</lifecycle>
+</webscript>

config/alfresco/web-scripts-application-context.xml

@@ -597,6 +597,13 @@
    <!--  Switch on debugger by setting log4j.logger.org.alfresco.repo.web.scripts.AlfrescoRhinoScriptDebugger to DEBUG -->
    <bean id="rhinoScriptDebugger" class="org.alfresco.repo.web.scripts.AlfrescoRhinoScriptDebugger" init-method="start"/>
    
+   
+   <!-- JMX Admin Dump - as ZIP file content -->
+   <bean id="webscript.org.alfresco.repository.admin.jmxdump.get" class="org.alfresco.repo.web.scripts.content.StreamJMXDump" parent="webscript">
+      <property name="MBeanServer" ref="alfrescoMBeanServer" />
+   </bean>
+   
+   
    <!--                             -->
    <!-- DICTIONARY Service REST API -->
    <!--                             -->

source/java/org/alfresco/repo/web/scripts/content/StreamContent.java

@@ -80,8 +80,6 @@ public class StreamContent extends AbstractWebScript
     protected ContentService contentService;
     protected MimetypeService mimetypeService;    
 
-    /** Cached file modified date */
-//    private Date resouceFileModifiedDate;
 
     /**
      * @param mimetypeService

source/java/org/alfresco/repo/web/scripts/content/StreamJMXDump.java

@@ -0,0 +1,120 @@
+/*
+ * Copyright (C) 2005-2010 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.web.scripts.content;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.util.Date;
+import java.util.zip.ZipOutputStream;
+
+import javax.management.MBeanServerConnection;
+
+import org.alfresco.repo.management.JmxDumpUtil;
+import org.alfresco.util.TempFileProvider;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.tools.zip.ZipEntry;
+import org.springframework.extensions.webscripts.Cache;
+import org.springframework.extensions.webscripts.Status;
+import org.springframework.extensions.webscripts.WebScriptException;
+import org.springframework.extensions.webscripts.WebScriptRequest;
+import org.springframework.extensions.webscripts.WebScriptResponse;
+import org.springframework.util.FileCopyUtils;
+
+/**
+ * WebScript java backed bean implementation to stream the JMX property
+ * dump as a .zip content file. 
+ * 
+ * @author Kevin Roast
+ */
+public class StreamJMXDump extends StreamContent
+{
+    /** Logger */
+    private static Log logger = LogFactory.getLog(StreamJMXDump.class);
+    
+    /** The MBean server. */
+    private MBeanServerConnection mbeanServer;
+    
+    
+    /**
+     * @param mBeanServer       MBeanServerConnection bean
+     */
+    public void setMBeanServer(MBeanServerConnection mBeanServer)
+    {
+        this.mbeanServer = mBeanServer;
+    }
+    
+    /**
+     * @see org.alfresco.web.scripts.WebScript#execute(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse)
+     */
+    public void execute(WebScriptRequest req, WebScriptResponse res) throws IOException
+    {
+        PrintWriter tempFileOut = null;
+        ZipOutputStream zout = null;
+        try
+        {
+            // content type and caching
+            res.setContentType("application/zip");
+            Cache cache = new Cache();
+            cache.setNeverCache(true);
+            cache.setMustRevalidate(true);
+            cache.setMaxAge(0L);
+            res.setCache(cache);
+            
+            Date date = new Date();
+            String attachFileName = "jmxdump_" + (date.getYear()+1900) + '_' + (date.getMonth()+1) + '_' + (date.getDate());
+            String headerValue = "attachment; filename=\"" + attachFileName + ".zip\"";
+            
+            // set header based on filename - will force a Save As from the browse if it doesn't recognize it
+            // this is better than the default response of the browser trying to display the contents
+            res.setHeader("Content-Disposition", headerValue);
+            
+            // write JMX data to temp file
+            File tempFile = TempFileProvider.createTempFile("jmxdump", ".txt");
+            tempFileOut = new PrintWriter(tempFile);
+            JmxDumpUtil.dumpConnection(mbeanServer, tempFileOut);
+            tempFileOut.flush();
+            tempFileOut.close();
+            tempFileOut = null;
+            
+            // zip output
+            zout = new ZipOutputStream(res.getOutputStream());
+            ZipEntry zipEntry = new ZipEntry(attachFileName + ".txt");
+            zout.putNextEntry(zipEntry);
+            FileCopyUtils.copy(new FileInputStream(tempFile), zout);
+            zout = null;
+        } 
+        catch (IOException ioe)
+        {
+            throw new WebScriptException(Status.STATUS_BAD_REQUEST,
+                    "Could not output JMX dump: " + ioe.getMessage(), ioe);
+        }
+        finally
+        {
+            if (tempFileOut != null) tempFileOut.close();
+            try
+            {
+                if (zout != null) zout.close();
+            }
+            catch (IOException e1) {}
+        }
+    }
+}