AuthTool (Solr 9.7.0 core API)

java.lang.Object
- org.apache.solr.cli.ToolBase
- - org.apache.solr.cli.AuthTool

All Implemented Interfaces:

Tool
```
public class AuthTool
extends ToolBase
```

Field Summary
- Fields inherited from class org.apache.solr.cli.ToolBase
  stdout, verbose

Constructor Summary

Constructors
Constructor Description

AuthTool()

AuthTool(PrintStream stdout)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.
`List<org.apache.commons.cli.Option>`	`getOptions()`
`String`	`getUsage()`	Provides a Usage string to display in help output.
`void`	`runImpl(org.apache.commons.cli.CommandLine cli)`

Methods inherited from class org.apache.solr.cli.ToolBase
echo, echoIfVerbose, runTool

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.cli.Tool
getFooter

- Constructor Detail
  - AuthTool
```
public AuthTool()
```
  - AuthTool
```
public AuthTool(PrintStream stdout)
```
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: Tool
    
    Defines the interface to a Solr tool that can be run from this command-line app.
  - getUsage
```
public String getUsage()
```
    Description copied from interface: Tool
    
    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
```
public String getHeader()
```
    Description copied from interface: Tool
    
    Optional header to display before the options in help output. Defaults to 'List of options:'
  - getOptions
```
public List<org.apache.commons.cli.Option> getOptions()
```
  - runImpl
```
public void runImpl(org.apache.commons.cli.CommandLine cli)
             throws Exception
```
    Specified by:
    
    runImpl in class ToolBase
    
    Throws:
    
    Exception