Package org.apache.solr.cli

Class RunExampleTool

java.lang.Object

org.apache.solr.cli.ToolBase

org.apache.solr.cli.RunExampleTool

All Implemented Interfaces:

Tool

public class RunExampleTool
extends ToolBase

Supports start command in the bin/solr script.

Enhances start command by providing an interactive session with the user to launch (or relaunch the -e cloud example)

Field Summary

Fields

Modifier and Type	Field	Description
protected Path	exampleDir
protected org.apache.commons.exec.Executor	executor
protected String	script
protected Path	serverDir
protected Path	solrHomeDir
protected String	urlScheme
protected InputStream	userInput

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

runtime

Constructor Summary

Constructors

Constructor	Description
RunExampleTool(org.apache.commons.exec.Executor executor, InputStream userInput, ToolRuntime runtime)
RunExampleTool(ToolRuntime runtime)	Default constructor used by the framework when running as a command-line application.

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	checkPortConflict(String solrUrl, String credentials, Path solrHomeDir, int port)
protected void	copyIfNeeded(Path src, Path dest)
protected String	createCloudExampleCollection(int numNodes, Scanner readInput, boolean prompt, String solrUrl, String credentials)
String	getName()	Defines the interface to a Solr tool that can be run from this command-line app.
protected Map<String,Object>	getNodeStatus(String solrUrl, String credentials, int maxWaitSecs)
org.apache.commons.cli.Options	getOptions()	Retrieve the Options supported by this tool.
protected boolean	isPortAvailable(int port)
protected boolean	isValidConfig(Path configsetsDir, String config)
protected String	prompt(Scanner s, String prompt)
protected String	prompt(Scanner s, String prompt, String defaultValue)
protected Integer	promptForInt(Scanner s, String prompt, String label, Integer defVal, Integer min, Integer max)
protected Integer	promptForPort(Scanner s, int node, String prompt, Integer defVal)
protected String	readExtraArgs(String[] extraArgsArr)
void	runImpl(org.apache.commons.cli.CommandLine cli)
protected Path	setupSolrHomeDir(Path serverDir, Path solrHomeParentDir, String dirName)
protected void	waitToSeeLiveNodes(String zkHost, int numNodes)	wait until the number of live nodes == numNodes.

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

echo, echoIfVerbose, 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, getHeader, getUsage

Field Details

userInput

protected InputStream userInput

executor

protected org.apache.commons.exec.Executor executor

script

protected String script

serverDir

protected Path serverDir

exampleDir

protected Path exampleDir

solrHomeDir

protected Path solrHomeDir

urlScheme

protected String urlScheme

Constructor Details

RunExampleTool

public RunExampleTool(ToolRuntime runtime)

Default constructor used by the framework when running as a command-line application.

RunExampleTool

public RunExampleTool(org.apache.commons.exec.Executor executor,
 InputStream userInput,
 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.

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

waitToSeeLiveNodes

protected void waitToSeeLiveNodes(String zkHost,
 int numNodes)

wait until the number of live nodes == numNodes.

checkPortConflict

protected Map<String,Object> checkPortConflict(String solrUrl,
 String credentials,
 Path solrHomeDir,
 int port)

readExtraArgs

protected String readExtraArgs(String[] extraArgsArr)

createCloudExampleCollection

protected String createCloudExampleCollection(int numNodes,
 Scanner readInput,
 boolean prompt,
 String solrUrl,
 String credentials)
                                       throws Exception

Throws:

Exception

isValidConfig

protected boolean isValidConfig(Path configsetsDir,
 String config)

getNodeStatus

protected Map<String,Object> getNodeStatus(String solrUrl,
 String credentials,
 int maxWaitSecs)
                                    throws Exception

Throws:

Exception

setupSolrHomeDir

protected Path setupSolrHomeDir(Path serverDir,
 Path solrHomeParentDir,
 String dirName)
                         throws IOException

Throws:

IOException

copyIfNeeded

protected void copyIfNeeded(Path src,
 Path dest)
                     throws IOException

Throws:

IOException

isPortAvailable

protected boolean isPortAvailable(int port)

promptForPort

protected Integer promptForPort(Scanner s,
 int node,
 String prompt,
 Integer defVal)

promptForInt

protected Integer promptForInt(Scanner s,
 String prompt,
 String label,
 Integer defVal,
 Integer min,
 Integer max)

prompt

protected String prompt(Scanner s,
 String prompt)

prompt

protected String prompt(Scanner s,
 String prompt,
 String defaultValue)