SOLR-8083: convert the ZookeeperInfoServlet to a request handler at /admin/zookeeper

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1705662 13f79535-47bb-0310-9956-ffa450edef68

solr/core/src/java/org/apache/solr/core/CoreContainer.java

@@ -49,6 +49,7 @@ import org.apache.solr.handler.admin.ConfigSetsHandler;
 import org.apache.solr.handler.admin.CoreAdminHandler;
 import org.apache.solr.handler.admin.InfoHandler;
 import org.apache.solr.handler.admin.SecurityConfHandler;
+import org.apache.solr.handler.admin.ZookeeperInfoHandler;
 import org.apache.solr.handler.component.HttpShardHandlerFactory;
 import org.apache.solr.handler.component.ShardHandlerFactory;
 import org.apache.solr.logging.LogWatcher;
@@ -398,6 +399,7 @@ public class CoreContainer {
     initializeAuthorizationPlugin((Map<String, Object>) securityConfig.data.get("authorization"));
     initializeAuthenticationPlugin((Map<String, Object>) securityConfig.data.get("authentication"));
 
+    containerHandlers.put(ZK_PATH, new ZookeeperInfoHandler(this));
     securityConfHandler = new SecurityConfHandler(this);
     collectionsHandler = createHandler(cfg.getCollectionsHandlerClass(), CollectionsHandler.class);
     containerHandlers.put(COLLECTIONS_HANDLER_PATH, collectionsHandler);

solr/core/src/java/org/apache/solr/handler/admin/ZookeeperInfoHandler.java

@@ -15,13 +15,12 @@
  * limitations under the License.
  */
 
-package org.apache.solr.servlet;
+package org.apache.solr.handler.admin;
 
-import javax.servlet.ServletException;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.OutputStreamWriter;
+import java.io.Reader;
 import java.io.Writer;
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
@@ -29,6 +28,7 @@ import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.Date;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
@@ -46,21 +46,33 @@ import org.apache.solr.common.cloud.OnReconnect;
 import org.apache.solr.common.cloud.Replica;
 import org.apache.solr.common.cloud.SolrZkClient;
 import org.apache.solr.common.cloud.ZkStateReader;
+import org.apache.solr.common.params.CommonParams;
+import org.apache.solr.common.params.MapSolrParams;
 import org.apache.solr.common.params.SolrParams;
+import org.apache.solr.common.util.ContentStream;
 import org.apache.solr.common.util.Utils;
 import org.apache.solr.core.CoreContainer;
-import org.apache.solr.util.FastWriter;
+import org.apache.solr.handler.ReplicationHandler;
+import org.apache.solr.handler.RequestHandlerBase;
+import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.response.JSONResponseWriter;
+import org.apache.solr.response.RawResponseWriter;
+import org.apache.solr.response.SolrQueryResponse;
+import org.apache.solr.util.SimplePostTool.BAOS;
 import org.apache.zookeeper.KeeperException;
 import org.apache.zookeeper.WatchedEvent;
 import org.apache.zookeeper.Watcher;
 import org.apache.zookeeper.data.Stat;
+import org.apache.zookeeper.server.ByteBufferInputStream;
 import org.noggit.CharArr;
 import org.noggit.JSONWriter;
 import org.noggit.ObjectBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import static org.apache.solr.common.params.CommonParams.OMIT_HEADER;
 import static org.apache.solr.common.params.CommonParams.PATH;
+import static org.apache.solr.common.params.CommonParams.WT;
 
 
 /**
@@ -68,13 +80,25 @@ import static org.apache.solr.common.params.CommonParams.PATH;
  *
  * @since solr 4.0
  */
-public final class ZookeeperInfoServlet extends BaseSolrServlet {
+public final class ZookeeperInfoHandler extends RequestHandlerBase {
-  static final Logger log = LoggerFactory.getLogger(ZookeeperInfoServlet.class);
+  private final CoreContainer cores;
+
+  static final Logger log = LoggerFactory.getLogger(ZookeeperInfoHandler.class);
 
   // used for custom sorting collection names looking like prefix##
   // only go out to 7 digits (which safely fits in an int)
   private static final Pattern endsWithDigits = Pattern.compile("^(\\D*)(\\d{1,7}?)$");
 
+  public ZookeeperInfoHandler(CoreContainer cc) {
+    this.cores = cc;
+  }
+
+
+  @Override
+  public String getDescription() {
+    return "Fetch Zookeeper contents";
+  }
+
   /**
    * Enumeration of ways to filter collections on the graph panel.
    */
@@ -109,7 +133,7 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
         if (start > numFound)
           start = 0; // this might happen if they applied a new filter
 
-        int lastIndex = Math.min(start+rows, numFound);        
+        int lastIndex = Math.min(start + rows, numFound);
         if (start > 0 || lastIndex < numFound)
           selected = collections.subList(start, lastIndex);
       }
@@ -126,11 +150,11 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
       // typically, a user will type a prefix and then *, e.g. tj*
       // when they really mean tj.*
       String regexFilter = (!filter.endsWith(".*") && filter.endsWith("*"))
-          ? filter.substring(0,filter.length()-1)+".*" : filter; 
+          ? filter.substring(0, filter.length() - 1) + ".*" : filter;
 
       // case-insensitive
       if (!regexFilter.startsWith("(?i)"))
-        regexFilter = "(?i)"+regexFilter;
+        regexFilter = "(?i)" + regexFilter;
 
       Pattern filterRegex = Pattern.compile(regexFilter);
       List<String> filtered = new ArrayList<String>();
@@ -147,7 +171,7 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
      * the state the user is filtering by.
      */
     @SuppressWarnings("unchecked")
-    final boolean matchesStatusFilter(Map<String,Object> collectionState, Set<String> liveNodes) {
+    final boolean matchesStatusFilter(Map<String, Object> collectionState, Set<String> liveNodes) {
 
       if (filterType != FilterType.status || filter == null || filter.length() == 0)
         return true; // no status filter, so all match
@@ -156,15 +180,15 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
       boolean hasDownedShard = false; // means one or more shards is down
       boolean replicaInRecovery = false;
 
-      Map<String,Object> shards = (Map<String,Object>)collectionState.get("shards");
+      Map<String, Object> shards = (Map<String, Object>) collectionState.get("shards");
       for (String shardId : shards.keySet()) {
         boolean hasActive = false;
-        Map<String,Object> shard = (Map<String,Object>)shards.get(shardId);
+        Map<String, Object> shard = (Map<String, Object>) shards.get(shardId);
-        Map<String,Object> replicas = (Map<String,Object>)shard.get("replicas");
+        Map<String, Object> replicas = (Map<String, Object>) shard.get("replicas");
         for (String replicaId : replicas.keySet()) {
-          Map<String,Object> replicaState = (Map<String,Object>)replicas.get(replicaId);
+          Map<String, Object> replicaState = (Map<String, Object>) replicas.get(replicaId);
-          Replica.State coreState = Replica.State.getState((String)replicaState.get(ZkStateReader.STATE_PROP));
+          Replica.State coreState = Replica.State.getState((String) replicaState.get(ZkStateReader.STATE_PROP));
-          String nodeName = (String)replicaState.get("node_name");
+          String nodeName = (String) replicaState.get("node_name");
 
           // state can lie to you if the node is offline, so need to reconcile with live_nodes too
           if (!liveNodes.contains(nodeName))
@@ -202,7 +226,7 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
     }
 
     String getPagingHeader() {
-      return start+"|"+rows+"|"+numFound+"|"+(filterType != null ? filterType.toString() : "")+"|"+(filter != null ? filter : "");
+      return start + "|" + rows + "|" + numFound + "|" + (filterType != null ? filterType.toString() : "") + "|" + (filter != null ? filter : "");
     }
 
     public String toString() {
@@ -323,15 +347,12 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
   private PagedCollectionSupport pagingSupport;
 
   @Override
-  public void doGet(HttpServletRequest request,
+  public void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp) throws Exception {
-                    HttpServletResponse response)
+    final SolrParams params = req.getParams();
-      throws ServletException,IOException {
+    Map<String, String> map = new HashMap<>(1);
-    // This attribute is set by the SolrDispatchFilter
+    map.put(WT, "raw");
-    CoreContainer cores = (CoreContainer) request.getAttribute("org.apache.solr.CoreContainer");
+    map.put(OMIT_HEADER, "true");
-    if (cores == null) {
+    req.setParams(SolrParams.wrapDefaults(new MapSolrParams(map), params));
-      throw new ServletException("Missing request attribute org.apache.solr.CoreContainer.");
-    }
-
     synchronized (this) {
       if (pagingSupport == null) {
         pagingSupport = new PagedCollectionSupport();
@@ -343,18 +364,6 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
       }
     }
 
-    final SolrParams params;
-    try {
-      params = SolrRequestParsers.DEFAULT.parse(null, request.getServletPath(), request).getParams();
-    } catch (Exception e) {
-      int code=500;
-      if (e instanceof SolrException) {
-        code = Math.min(599, Math.max(100, ((SolrException)e).code()));
-      }
-      response.sendError(code, e.toString());
-      return;
-    }
-
     String path = params.get(PATH);
     String addr = params.get("addr");
 
@@ -368,8 +377,8 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
     String dumpS = params.get("dump");
     boolean dump = dumpS != null && dumpS.equals("true");
 
-    int start = paramAsInt("start", params, 0);
+    int start = params.getInt("start", 0);
-    int rows = paramAsInt("rows", params, -1);
+    int rows = params.getInt("rows", -1);
 
     String filterType = params.get("filterType");
     if (filterType != null) {
@@ -386,12 +395,7 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
         filter = null;
     }
 
-    response.setCharacterEncoding("UTF-8");
+    ZKPrinter printer = new ZKPrinter(cores.getZkController(), addr);
-    response.setContentType("application/json");
-
-    Writer out = new FastWriter(new OutputStreamWriter(response.getOutputStream(), StandardCharsets.UTF_8));
-
-    ZKPrinter printer = new ZKPrinter(response, out, cores.getZkController(), addr);
     printer.detail = detail;
     printer.dump = dump;
     boolean isGraphView = "graph".equals(params.get("view"));
@@ -404,38 +408,14 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
     } finally {
       printer.close();
     }
-    
+    rsp.getValues().add(RawResponseWriter.CONTENT,printer);
-    out.flush();
-  }
-
-  @Override
-  public void doPost(HttpServletRequest request,
-                     HttpServletResponse response)
-      throws ServletException,IOException {
-    doGet(request, response);
-  }
-
-  protected int paramAsInt(final String paramName, final SolrParams params, final int defaultVal) {
-    int val = defaultVal;
-    String paramS = params.get(paramName);
-    if (paramS != null) {
-      String trimmed = paramS.trim();
-      if (trimmed.length() > 0) {
-        try {
-          val = Integer.parseInt(trimmed);
-        } catch (NumberFormatException nfe) {
-          log.warn("Invalid value "+paramS+" passed for parameter "+paramName+"; expected integer!");
-        }        
-      }
-    }
-    return val;
   }
 
   //--------------------------------------------------------------------------------------
   //
   //--------------------------------------------------------------------------------------
 
-  static class ZKPrinter {
+  static class ZKPrinter implements ContentStream {
     static boolean FULLPATH_DEFAULT = false;
 
     boolean indent = true;
@@ -448,8 +428,8 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
 
     boolean doClose;  // close the client after done if we opened it
 
-    final HttpServletResponse response;
+    final BAOS baos = new BAOS();
-    final Writer out;
+    final Writer out = new OutputStreamWriter(baos,  StandardCharsets.UTF_8);
     SolrZkClient zkClient;
 
     int level;
@@ -459,10 +439,8 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
     PagedCollectionSupport pagingSupport;
     ZkController zkController;
 
-    public ZKPrinter(HttpServletResponse response, Writer out, ZkController controller, String addr) throws IOException {
+    public ZKPrinter(ZkController controller, String addr) throws IOException {
       this.zkController = controller;
-      this.response = response;
-      this.out = out;
       this.addr = addr;
 
       if (addr == null) {
@@ -500,6 +478,11 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
       if (doClose) {
         zkClient.close();
       }
+      try {
+        out.flush();
+      } catch (Exception e) {
+        throw new RuntimeException(e);
+      }
     }
 
     // main entry point
@@ -551,7 +534,8 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
     }
 
     void writeError(int code, String msg) throws IOException {
-      response.setStatus(code);
+      throw new SolrException(ErrorCode.getErrorCode(code), msg);
+      /*response.setStatus(code);
 
       CharArr chars = new CharArr();
       JSONWriter w = new JSONWriter(chars, 2);
@@ -567,7 +551,7 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
       w.writeString(msg);
       w.endObject();
 
-      out.write(chars.toString());
+      out.write(chars.toString());*/
     }
 
 
@@ -588,7 +572,7 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
       json.writeString("attr");
       json.writeNameSeparator();
       json.startObject();
-      writeKeyValue(json, "href", "zookeeper?detail=true&path=" + URLEncoder.encode(path, "UTF-8"), true);
+      writeKeyValue(json, "href", "admin/zookeeper?detail=true&path=" + URLEncoder.encode(path, "UTF-8"), true);
       json.endObject();
       json.endObject();
 
@@ -697,7 +681,7 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
           // we've already pulled the data for /clusterstate.json from ZooKeeper above,
           // but it needs to be parsed into a map so we can lookup collection states before
           // trying to find them in the /collections/?/state.json znode
-          Map<String,Object> clusterstateJsonMap = null;
+          Map<String, Object> clusterstateJsonMap = null;
           if (dataStr != null) {
             try {
               clusterstateJsonMap = (Map<String, Object>) ObjectBuilder.fromJSON(dataStr);
@@ -718,14 +702,14 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
           Set<String> liveNodes = applyStatusFilter ?
               zkController.getZkStateReader().getClusterState().getLiveNodes() : null;
 
-          SortedMap<String,Object> collectionStates = new TreeMap<String,Object>(pagingSupport);          
+          SortedMap<String, Object> collectionStates = new TreeMap<String, Object>(pagingSupport);
           for (String collection : page.selected) {
             Object collectionState = clusterstateJsonMap.get(collection);
             if (collectionState != null) {
               // collection state was in /clusterstate.json
               if (applyStatusFilter) {
                 // verify this collection matches the status filter
-                if (page.matchesStatusFilter((Map<String,Object>)collectionState,liveNodes)) {
+                if (page.matchesStatusFilter((Map<String, Object>) collectionState, liveNodes)) {
                   matchesStatusFilter.add(collection);
                   collectionStates.put(collection, collectionState);
                 }
@@ -741,19 +725,19 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
                 if (childData != null)
                   childDataStr = (new BytesRef(childData)).utf8ToString();
               } catch (KeeperException.NoNodeException nne) {
-                log.warn("State for collection "+collection+
+                log.warn("State for collection " + collection +
-                    " not found in /clusterstate.json or /collections/"+collection+"/state.json!");
+                    " not found in /clusterstate.json or /collections/" + collection + "/state.json!");
               } catch (Exception childErr) {
-                log.error("Failed to get "+collStatePath+" due to: "+childErr);
+                log.error("Failed to get " + collStatePath + " due to: " + childErr);
               }
 
               if (childDataStr != null) {
-                Map<String,Object> extColl = (Map<String,Object>)ObjectBuilder.fromJSON(childDataStr);
+                Map<String, Object> extColl = (Map<String, Object>) ObjectBuilder.fromJSON(childDataStr);
                 collectionState = extColl.get(collection);
 
                 if (applyStatusFilter) {
                   // verify this collection matches the filtered state
-                  if (page.matchesStatusFilter((Map<String,Object>)collectionState,liveNodes)) {
+                  if (page.matchesStatusFilter((Map<String, Object>) collectionState, liveNodes)) {
                     matchesStatusFilter.add(collection);
                     collectionStates.put(collection, collectionState);
                   }
@@ -769,7 +753,7 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
             page.selectPage(matchesStatusFilter);
 
             // rebuild the Map of state data
-            SortedMap<String,Object> map = new TreeMap<String,Object>(pagingSupport);                      
+            SortedMap<String, Object> map = new TreeMap<String, Object>(pagingSupport);
             for (String next : page.selected)
               map.put(next, collectionStates.get(next));
             collectionStates = map;
@@ -826,5 +810,41 @@ public final class ZookeeperInfoServlet extends BaseSolrServlet {
       }
       return true;
     }
+
+   /* @Override
+    public void write(OutputStream os) throws IOException {
+      ByteBuffer bytes = baos.getByteBuffer();
+      os.write(bytes.array(),0,bytes.limit());
+    }
+*/
+    @Override
+    public String getName() {
+      return null;
+    }
+
+    @Override
+    public String getSourceInfo() {
+      return null;
+    }
+
+    @Override
+    public String getContentType() {
+      return JSONResponseWriter.CONTENT_TYPE_JSON_UTF8;
+    }
+
+    @Override
+    public Long getSize() {
+      return null;
+    }
+
+    @Override
+    public InputStream getStream() throws IOException {
+      return new ByteBufferInputStream(baos.getByteBuffer());
+    }
+
+    @Override
+    public Reader getReader() throws IOException {
+      return null;
+    }
   }
 }

solr/core/src/java/org/apache/solr/response/JSONResponseWriter.java

@@ -42,7 +42,7 @@ import org.apache.solr.search.SolrReturnFields;
  */
 
 public class JSONResponseWriter implements QueryResponseWriter {
-  static String CONTENT_TYPE_JSON_UTF8 = "application/json; charset=UTF-8";
+  public static String CONTENT_TYPE_JSON_UTF8 = "application/json; charset=UTF-8";
 
   private String contentType = CONTENT_TYPE_JSON_UTF8;
 

solr/solrj/src/java/org/apache/solr/common/params/CommonParams.java

@@ -169,6 +169,7 @@ public interface CommonParams {
   public static final String CONFIGSETS_HANDLER_PATH = "/admin/configs";
   public static final String AUTHZ_PATH = "/admin/authorization";
   public static final String AUTHC_PATH = "/admin/authentication";
+  public static final String ZK_PATH = "/admin/zookeeper";
 
   /** valid values for: <code>echoParams</code> */
   public enum EchoParamStyle {

solr/webapp/web/WEB-INF/web.xml

@@ -75,11 +75,6 @@
     <url-pattern>/*</url-pattern>
   </filter-mapping>
 
-  <servlet>
-    <servlet-name>Zookeeper</servlet-name>
-    <servlet-class>org.apache.solr.servlet.ZookeeperInfoServlet</servlet-class>
-  </servlet>
-  
   <servlet>
     <servlet-name>LoadAdminUI</servlet-name>
     <servlet-class>org.apache.solr.servlet.LoadAdminUiServlet</servlet-class>
@@ -101,7 +96,7 @@
     <servlet-class>org.apache.solr.servlet.RedirectServlet</servlet-class>
     <init-param>
       <param-name>destination</param-name>
-      <param-value>${context}/zookeeper</param-value>
+      <param-value>${context}/admin/zookeeper</param-value>
     </init-param>
   </servlet>
 
@@ -135,17 +130,15 @@
     <servlet-name>RedirectOldZookeeper</servlet-name>
     <url-pattern>/zookeeper.jsp</url-pattern>
   </servlet-mapping>
+  <servlet-mapping>
+    <servlet-name>RedirectOldZookeeper</servlet-name>
+    <url-pattern>/zookeeper</url-pattern>
+  </servlet-mapping>
   <servlet-mapping>
     <servlet-name>RedirectLogging</servlet-name>
     <url-pattern>/logging</url-pattern>
   </servlet-mapping>
 
-  <!-- Servlet Mapping -->
-  <servlet-mapping>
-    <servlet-name>Zookeeper</servlet-name>
-    <url-pattern>/zookeeper</url-pattern>
-  </servlet-mapping>
-  
   <servlet-mapping>
     <servlet-name>LoadAdminUI</servlet-name>
     <url-pattern>/admin.html</url-pattern>

solr/webapp/web/js/angular/services.js

@@ -60,7 +60,7 @@ solrAdminServices.factory('System',
   }])
 .factory('Zookeeper',
   ['$resource', function($resource) {
-    return $resource('/solr/zookeeper', {wt:'json', _:Date.now()}, {
+    return $resource('/solr/admin/zookeeper', {wt:'json', _:Date.now()}, {
       "simple": {},
       "dump": {params: {dump: "true"}},
       "liveNodes": {params: {path: '/live_nodes'}},

solr/webapp/web/js/scripts/cloud.js

@@ -91,7 +91,7 @@ var init_debug = function( cloud_element )
         $.ajax
         (
           {
-            url : app.config.solr_path + '/zookeeper?wt=json&dump=true',
+            url : app.config.solr_path + '/admin/zookeeper?wt=json&dump=true',
             dataType : 'text',
             context : debug_element,
             beforeSend : function( xhr, settings )
@@ -455,7 +455,7 @@ var prepare_graph = function( graph_element, callback )
   $.ajax
   (
     {
-      url : app.config.solr_path + '/zookeeper?wt=json&path=%2Flive_nodes',
+      url : app.config.solr_path + '/admin/zookeeper?wt=json&path=%2Flive_nodes',
       dataType : 'json',
       success : function( response, text_status, xhr )
       {
@@ -467,7 +467,7 @@ var prepare_graph = function( graph_element, callback )
 
         var start = $( '#cloudGraphPagingStart' ).val();
         var rows = $( '#cloudGraphPagingRows' ).val();
-        var clusterStateUrl = app.config.solr_path + '/zookeeper?wt=json&detail=true&path=%2Fclusterstate.json&view=graph';
+        var clusterStateUrl = app.config.solr_path + '/admin/zookeeper?wt=json&detail=true&path=%2Fclusterstate.json&view=graph';
         if (start && rows)
           clusterStateUrl += ('&start='+start+'&rows='+rows);
         
@@ -591,7 +591,7 @@ var init_tree = function( tree_element )
   $.ajax
   (
     {
-      url : app.config.solr_path + '/zookeeper?wt=json',
+      url : app.config.solr_path + '/admin/zookeeper?wt=json',
       dataType : 'json',
       context : tree_element,
       beforeSend : function( xhr, settings )
@@ -859,7 +859,7 @@ sammy.get
         $.ajax
         (
           {
-            url : app.config.solr_path + '/zookeeper?wt=json',
+            url : app.config.solr_path + '/admin/zookeeper?wt=json',
             dataType : 'json',
             context : cloud_element,
             success : function( response, text_status, xhr )