Package org.apache.solr.cli

Class AuthTool

java.lang.Object

org.apache.solr.cli.ToolBase

org.apache.solr.cli.AuthTool

All Implemented Interfaces:

Tool

public class AuthTool
extends ToolBase

Supports auth command in the bin/solr script.

Field Summary

Fields inherited from class org.apache.solr.cli.ToolBase

runtime

Constructor Summary

Constructors

Constructor	Description
AuthTool(ToolRuntime runtime)

Method Summary

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.
org.apache.commons.cli.Options	getOptions()	Retrieve the Options supported by this tool.
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, getConnectionOptions, getRuntime, isVerbose, 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 Details

AuthTool

public AuthTool(ToolRuntime runtime)

Method Details

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 org.apache.commons.cli.Options getOptions()

Description copied from interface: Tool

Retrieve the Options supported by this tool.

Specified by:

getOptions in interface Tool

Overrides:

getOptions in class ToolBase

Returns:

The Options this tool supports.

runImpl

public void runImpl(org.apache.commons.cli.CommandLine cli)
             throws Exception

Specified by:

runImpl in class ToolBase

Throws:

Exception