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 an interactive session with the user to launch (or relaunch the -e cloud example)

Field Summary

Fields

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

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

runtime, verbose

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, File solrHomeDir, int port)
protected void	copyIfNeeded(File src, File dest)
protected String	createCloudExampleCollection(int numNodes, Scanner readInput, boolean prompt, String solrUrl)
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, int maxWaitSecs, org.apache.commons.cli.CommandLine cli)
List<org.apache.commons.cli.Option>	getOptions()
protected boolean	isPortAvailable(int port)
protected boolean	isValidConfig(File 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)
protected void	runCloudExample(org.apache.commons.cli.CommandLine cli)
protected void	runExample(org.apache.commons.cli.CommandLine cli, String exampleName)
void	runImpl(org.apache.commons.cli.CommandLine cli)
protected File	setupSolrHomeDir(File serverDir, File solrHomeParentDir, String dirName)
protected Map<String,Object>	startSolr(File solrHomeDir, boolean cloudMode, org.apache.commons.cli.CommandLine cli, int port, String zkHost, int maxWaitSecs)
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, 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 File serverDir

exampleDir

protected File exampleDir

solrHomeDir

protected File 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 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

runExample

protected void runExample(org.apache.commons.cli.CommandLine cli,
 String exampleName)
                   throws Exception

Throws:

Exception

runCloudExample

protected void runCloudExample(org.apache.commons.cli.CommandLine cli)
                        throws Exception

Throws:

Exception

waitToSeeLiveNodes

protected void waitToSeeLiveNodes(String zkHost,
 int numNodes)

wait until the number of live nodes == numNodes.

startSolr

protected Map<String,Object> startSolr(File solrHomeDir,
 boolean cloudMode,
 org.apache.commons.cli.CommandLine cli,
 int port,
 String zkHost,
 int maxWaitSecs)
                                throws Exception

Throws:

Exception

checkPortConflict

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

readExtraArgs

protected String readExtraArgs(String[] extraArgsArr)

createCloudExampleCollection

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

Throws:

Exception

isValidConfig

protected boolean isValidConfig(File configsetsDir,
 String config)

getNodeStatus

protected Map<String,Object> getNodeStatus(String solrUrl,
 int maxWaitSecs,
 org.apache.commons.cli.CommandLine cli)
                                    throws Exception

Throws:

Exception

setupSolrHomeDir

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

Throws:

IOException

copyIfNeeded

protected void copyIfNeeded(File src,
 File 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)