Package org.apache.solr.cli

Interface Tool

All Known Implementing Classes:
ApiTool, AssertTool, AuthTool, ClusterTool, ConfigSetDownloadTool, ConfigSetUploadTool, ConfigTool, CreateTool, DeleteTool, ExportTool, HealthcheckTool, LinkConfigTool, PackageTool, PostLogsTool, PostTool, RunExampleTool, SnapshotCreateTool, SnapshotDeleteTool, SnapshotDescribeTool, SnapshotExportTool, SnapshotListTool, StatusTool, StreamTool, ToolBase, UpdateACLTool, VersionTool, ZkCpTool, ZkLsTool, ZkMkrootTool, ZkMvTool, ZkRmTool, ZkToolHelp
public interface Tool

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getFooter()
    Optional footer to display after the options in help output.
    default String
    getHeader()
    Optional header to display before the options in help output.
    String
    getName()
    Defines the interface to a Solr tool that can be run from this command-line app.
    org.apache.commons.cli.Options
    getOptions()
    Retrieve the Options supported by this tool.
    ToolRuntime
    getRuntime()
    Return non-null runtime of the tool.
    default String
    getUsage()
    Provides a Usage string to display in help output.
    int
    runTool(org.apache.commons.cli.CommandLine cli)
     

  • Method Details

    • getName

      String getName()
      Defines the interface to a Solr tool that can be run from this command-line app.

    • getUsage

      default String getUsage()
      Provides a Usage string to display in help output. Defaults to auto generating usage string. Override for custom string
      Returns:
      The custom usage string or 'null' to auto generate (default)

    • getHeader

      default String getHeader()
      Optional header to display before the options in help output. Defaults to 'List of options:'

    • getFooter

      default String getFooter()
      Optional footer to display after the options in help output. Defaults to a link to reference guide

    • getRuntime

      ToolRuntime getRuntime()
      Return non-null runtime of the tool.

    • getOptions

      org.apache.commons.cli.Options getOptions()
      Retrieve the Options supported by this tool.
      Returns:
      The Options this tool supports.

    • runTool

      int runTool(org.apache.commons.cli.CommandLine cli) throws Exception
      Throws:
      Exception