• Home
• org.apache.solr
• solr-core
• 9.6.0
• source code
• StatusTool.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.apache.solr.cli.StatusTool Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.solr.cli;

import java.io.PrintStream;
import java.net.URL;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Option;
import org.apache.solr.client.solrj.SolrClient;
import org.apache.solr.client.solrj.SolrRequest;
import org.apache.solr.client.solrj.request.CollectionAdminRequest;
import org.apache.solr.client.solrj.request.GenericSolrRequest;
import org.apache.solr.common.params.CommonParams;
import org.apache.solr.common.util.NamedList;
import org.noggit.CharArr;
import org.noggit.JSONWriter;

public class StatusTool extends ToolBase {
  /** Get the status of a Solr server. */
  public StatusTool() {
    this(CLIO.getOutStream());
  }

  public StatusTool(PrintStream stdout) {
    super(stdout);
  }

  @Override
  public String getName() {
    return "status";
  }

  // These options are not exposed to the end user, and are
  // used directly by the bin/solr status CLI.
  @Override
  public List getOptions() {
    return List.of(
        Option.builder("solr")
            .argName("URL")
            .hasArg()
            .required(false)
            .desc(
                "Address of the Solr Web application, defaults to: "
                    + SolrCLI.getDefaultSolrUrl()
                    + '.')
            .build(),
        Option.builder("maxWaitSecs")
            .argName("SECS")
            .hasArg()
            .required(false)
            .desc("Wait up to the specified number of seconds to see Solr running.")
            .build());
  }

  @Override
  public void runImpl(CommandLine cli) throws Exception {
    int maxWaitSecs = Integer.parseInt(cli.getOptionValue("maxWaitSecs", "0"));
    String solrUrl = cli.getOptionValue("solr", SolrCLI.getDefaultSolrUrl());
    if (maxWaitSecs > 0) {
      int solrPort = (new URL(solrUrl)).getPort();
      echo("Waiting up to " + maxWaitSecs + " seconds to see Solr running on port " + solrPort);
      try {
        waitToSeeSolrUp(solrUrl, maxWaitSecs, TimeUnit.SECONDS);
        echo("Started Solr server on port " + solrPort + ". Happy searching!");
      } catch (TimeoutException timeout) {
        throw new Exception(
            "Solr at " + solrUrl + " did not come online within " + maxWaitSecs + " seconds!");
      }
    } else {
      try {
        CharArr arr = new CharArr();
        new JSONWriter(arr, 2).write(getStatus(solrUrl));
        echo(arr.toString());
      } catch (Exception exc) {
        if (SolrCLI.exceptionIsAuthRelated(exc)) {
          throw exc;
        }
        if (SolrCLI.checkCommunicationError(exc)) {
          // this is not actually an error from the tool as it's ok if Solr is not online.
          CLIO.err("Solr at " + solrUrl + " not online.");
        } else {
          throw new Exception(
              "Failed to get system information from " + solrUrl + " due to: " + exc);
        }
      }
    }
  }

  public Map waitToSeeSolrUp(String solrUrl, long maxWait, TimeUnit unit)
      throws Exception {
    long timeout = System.nanoTime() + TimeUnit.NANOSECONDS.convert(maxWait, unit);
    while (System.nanoTime() < timeout) {
      try {
        return getStatus(solrUrl);
      } catch (Exception exc) {
        if (SolrCLI.exceptionIsAuthRelated(exc)) {
          throw exc;
        }
        try {
          Thread.sleep(2000L);
        } catch (InterruptedException interrupted) {
          timeout = 0; // stop looping
        }
      }
    }
    throw new TimeoutException(
        "Did not see Solr at "
            + solrUrl
            + " come online within "
            + TimeUnit.SECONDS.convert(maxWait, unit)
            + " seconds!");
  }

  public Map getStatus(String solrUrl) throws Exception {
    Map status;

    if (!solrUrl.endsWith("/")) solrUrl += "/";

    try (var solrClient = SolrCLI.getSolrClient(solrUrl)) {
      NamedList