Added a Region Detail page (lists keys and allows removals) to the cache admin

James Taylor · James Taylor · commit 121b9444b7d8 · 2002-05-20T12:35:49.000Z
servlet, and added a silent mode (if the silent parameter is present on the request, no output will be produced. git-svn-id: https://svn.apache.org/repos/asf/jakarta/jcs/trunk@223978 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/java/org/apache/jcs/servlet/JCSAdminServlet.java b/src/java/org/apache/jcs/servlet/JCSAdminServlet.java
@@ -54,18 +54,23 @@ public class JCSAdminServlet extends VelocityServlet
     private static final String DEFAULT_TEMPLATE_NAME =
         "/org/apache/jcs/servlet/JCSAdminServletDefault.vm";
 
+    private static final String REGION_DETAIL_TEMPLATE_NAME =
+        "/org/apache/jcs/servlet/JCSAdminServletRegionDetail.vm";
+
     // Keys for parameters
 
     private static final String CACHE_NAME_PARAM = "cacheName";
 
     private static final String ACTION_PARAM = "action";
     private static final String KEY_PARAM = "key";
+    private static final String SILENT_PARAM = "silent";
 
     // Possible values for 'action' parameter
 
     private static final String CLEAR_ALL_REGIONS_ACTION = "clearAllRegions";
     private static final String CLEAR_REGION_ACTION = "clearRegion";
     private static final String REMOVE_ACTION = "remove";
+    private static final String DETAIL_ACTION = "detail";
 
     private CacheHub cacheHub = CacheHub.getInstance();
 
@@ -75,6 +80,10 @@ protected Template handleRequest( HttpServletRequest request,
                                       Context context )
         throws Exception
     {
+        String templateName = DEFAULT_TEMPLATE_NAME;
+
+        // Get cacheName for actions from request (might be null)
+
         String cacheName = request.getParameter( CACHE_NAME_PARAM );
 
         // If an action was provided, handle it
@@ -106,11 +115,52 @@ else if ( action.equals( REMOVE_ACTION ) )
                 {
                     removeItem( cacheName, keys[ i ] );
                 }
+
+                templateName = REGION_DETAIL_TEMPLATE_NAME;
+            }
+            else if ( action.equals( DETAIL_ACTION ) )
+            {
+                templateName = REGION_DETAIL_TEMPLATE_NAME;
+            }
+        }
+
+        if ( request.getParameter( SILENT_PARAM ) != null )
+        {
+            // If silent parameter was passed, no output should be produced.
+
+            return null;
+        }
+        else
+        {
+            // Populate the context based on the template
+
+            if ( templateName == REGION_DETAIL_TEMPLATE_NAME )
+            {
+                context.put( "cacheName", cacheName );
+                context.put( "keys", getSortedKeys( cacheName ) );
+            }
+            else if ( templateName == DEFAULT_TEMPLATE_NAME )
+            {
+                context.put( "cacheInfoRecords", buildCacheInfo() );
             }
+
+            return getTemplate( templateName );
         }
+    }
 
-        // Now populate the context
+    private Object[] getSortedKeys( String cacheName )
+    {
+        Cache cache = ( Cache ) cacheHub.getCache( cacheName );
 
+        Object[] keys = cache.getMemoryCache().getKeyArray();
+
+        Arrays.sort( keys );
+
+        return keys;
+    }
+
+    private LinkedList buildCacheInfo() throws Exception
+    {
         String[] cacheNames = cacheHub.getCacheNames();
 
         Arrays.sort( cacheNames );
@@ -134,9 +184,7 @@ else if ( action.equals( REMOVE_ACTION ) )
             cacheInfo.add( regionInfo );
         }
 
-        context.put( "cacheInfoRecords", cacheInfo );
-
-        return getTemplate( DEFAULT_TEMPLATE_NAME );
+        return cacheInfo;
     }
 
     public int getByteCount( Cache cache )
diff --git a/src/java/org/apache/jcs/servlet/JCSAdminServletDefault.vm b/src/java/org/apache/jcs/servlet/JCSAdminServletDefault.vm
@@ -1,3 +1,9 @@
+<html>
+
+<head><title> JCS Admin Servlet </title></head>
+
+<body>
+
 <h1> Cache Regions </h1>
 
 <p>These are the regions which are currently defined in the cache. 'Items' and
@@ -20,8 +26,15 @@ which empties the entire cache.</p>
             <td> $record.ItemCount </td>
             <td> $record.ByteCount </td>
             <td> $record.Status </td>
-            <td> <a href="?action=clearRegion&cacheName=${record.Name}"> Remove all </a> </td>
+            <td>
+                <a href="?action=detail&cacheName=${record.Name}"> Detail </a>
+                | <a href="?action=clearRegion&cacheName=${record.Name}"> Remove all </a>
+            </td>
         </tr>
     #end
 
-</table>
+</table>
+
+</body>
+
+</html>
diff --git a/src/java/org/apache/jcs/servlet/JCSAdminServletRegionDetail.vm b/src/java/org/apache/jcs/servlet/JCSAdminServletRegionDetail.vm
@@ -0,0 +1,25 @@
+<html>
+
+<head><title> JCS Admin Servlet Region Detail </title></head>
+
+<body>
+
+<h1> Keys for region: $cacheName </h1>
+
+<table border="1" cellpadding="5" >
+    <tr>
+        <th> Key </th>
+    </tr>
+
+    #foreach ( $key in $keys )
+        <tr>
+            <td> $key </td>
+            <td> <a href="?action=remove&cacheName=${cacheName}&key=${key}"> Remove </a> </td>
+        </tr>
+    #end
+
+</table>
+
+</body>
+
+</html>
