Class ToolBase

solr/core/src/java/org/apache/solr/cli/ToolBase.java:27–118

import org.apache.solr.util.StartupLoggingUtils;

public abstract class ToolBase implements Tool {

  protected final ToolRuntime runtime;

  private boolean verbose = false;

  protected ToolBase(ToolRuntime runtime) {
    this.runtime = runtime;
  }

  /** Is this tool being run in a verbose mode? */
  protected boolean isVerbose() {
    return verbose;
  }

  protected void echoIfVerbose(final String msg) {
    if (verbose) {
      echo(msg);
    }
  }

  protected void echoIfVerbose(Object response) throws JsonProcessingException {
    if (verbose && response != null) {
      echo(
          JacksonContentWriter.DEFAULT_MAPPER
              .writerWithDefaultPrettyPrinter()
              .writeValueAsString(response));
    }
  }

  protected void echo(final String msg) {
    runtime.println(msg);
  }

  @Override
  public Options getOptions() {
    return new Options()
        .addOption(CommonCLIOptions.HELP_OPTION)
        .addOption(CommonCLIOptions.VERBOSE_OPTION);
  }

  @Override
  public ToolRuntime getRuntime() {
    return runtime;
  }

  /**
   * Provides the connection options for CLI Tools: {@code --solr-url}, {@code --zk-host}, and the
   * unified {@code --solr-connection} (which accepts either form).
   *
   * @return OptionGroup that enforces only one of the connection options is supplied.
   */
  public OptionGroup getConnectionOptions() {
    OptionGroup optionGroup = new OptionGroup();
    optionGroup.addOption(CommonCLIOptions.SOLR_URL_OPTION);
    optionGroup.addOption(CommonCLIOptions.ZK_HOST_OPTION);
    optionGroup.addOption(CommonCLIOptions.SOLR_CONNECTION_OPTION);
    return optionGroup;