AuthTool (Solr 9.6.1 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`	`getName()`	Defines the interface to a Solr tool that can be run from this command-line app.
`List<org.apache.commons.cli.Option>`	`getOptions()`
`void`	`runImpl(org.apache.commons.cli.CommandLine cli)`
`int`	`runTool(org.apache.commons.cli.CommandLine cli)`

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

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

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.
- getOptions
```
public List<org.apache.commons.cli.Option> getOptions()
```
- runTool
```
public int runTool(org.apache.commons.cli.CommandLine cli)
            throws Exception
```
  Specified by:
  
  runTool in interface Tool
  
  Overrides:
  
  runTool in class ToolBase
  
  Throws:
  
  Exception
- runImpl
```
public void runImpl(org.apache.commons.cli.CommandLine cli)
             throws Exception
```
  Specified by:
  
  runImpl in class ToolBase
  
  Throws:
  
  Exception