Package org.apache.solr.cli

Class StatusTool

java.lang.Object

org.apache.solr.cli.ToolBase

org.apache.solr.cli.StatusTool

All Implemented Interfaces:

Tool

public class StatusTool
extends ToolBase

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.commons.cli.Option	OPTION_PORT
static org.apache.commons.cli.Option	OPTION_SHORT

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

stdout, verbose

Constructor Summary

Constructors

Constructor	Description
StatusTool()
StatusTool(PrintStream stdout)

Method Summary

Modifier and Type	Method	Description
protected Map<String,String>	getCloudStatus(org.apache.solr.client.solrj.SolrClient solrClient, String zkHost)	Calls the CLUSTERSTATUS endpoint in Solr to get basic status information about the SolrCloud cluster.
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()
Map<String,Object>	getStatus(String solrUrl)
boolean	printStatusFromRunningSolr(String solrUrl, org.apache.commons.cli.CommandLine cli)
Map<String,Object>	reportStatus(org.apache.solr.common.util.NamedList<Object> info, org.apache.solr.client.solrj.SolrClient solrClient)
void	runImpl(org.apache.commons.cli.CommandLine cli)
String	statusFromRunningSolr(String solrUrl, org.apache.commons.cli.CommandLine cli)	Get the status of a Solr server and responds with a JSON status string.
boolean	waitForSolrUp(String solrUrl, org.apache.commons.cli.CommandLine cli, int maxWaitSecs)	Wait for Solr to come online and return true if it does, false otherwise.
void	waitForSolrUpAndPrintStatus(String solrUrl, org.apache.commons.cli.CommandLine cli, int maxWaitSecs)
Map<String,Object>	waitToSeeSolrUp(String solrUrl, long maxWait, TimeUnit unit)

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

echo, echoIfVerbose, 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 Detail

OPTION_PORT

public static final org.apache.commons.cli.Option OPTION_PORT

OPTION_SHORT

public static final org.apache.commons.cli.Option OPTION_SHORT

Constructor Detail

StatusTool

public StatusTool()

StatusTool

public StatusTool(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()

runImpl

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

Specified by:

runImpl in class ToolBase

Throws:

Exception

waitForSolrUpAndPrintStatus

public void waitForSolrUpAndPrintStatus(String solrUrl,
                                        org.apache.commons.cli.CommandLine cli,
                                        int maxWaitSecs)
                                 throws Exception

Throws:

Exception

waitForSolrUp

public boolean waitForSolrUp(String solrUrl,
                             org.apache.commons.cli.CommandLine cli,
                             int maxWaitSecs)
                      throws Exception

Wait for Solr to come online and return true if it does, false otherwise.

Parameters:

solrUrl - the URL of the Solr server

cli - the command line options

maxWaitSecs - the maximum number of seconds to wait

Returns:

true if Solr comes online, false otherwise

Throws:

Exception

printStatusFromRunningSolr

public boolean printStatusFromRunningSolr(String solrUrl,
                                          org.apache.commons.cli.CommandLine cli)
                                   throws Exception

Throws:

Exception

statusFromRunningSolr

public String statusFromRunningSolr(String solrUrl,
                                    org.apache.commons.cli.CommandLine cli)
                             throws Exception

Get the status of a Solr server and responds with a JSON status string.

Parameters:

solrUrl - the URL of the Solr server

cli - the command line options

Returns:

the status of the Solr server or null if the server is not online

Throws:

Exception - if there is an error getting the status

waitToSeeSolrUp

public Map<String,Object> waitToSeeSolrUp(String solrUrl,
                                                long maxWait,
                                                TimeUnit unit)
                                         throws Exception

Throws:

Exception

getStatus

public Map<String,Object> getStatus(String solrUrl)
                                   throws Exception

Throws:

Exception

reportStatus

public Map<String,Object> reportStatus(org.apache.solr.common.util.NamedList<Object> info,
                                             org.apache.solr.client.solrj.SolrClient solrClient)
                                      throws Exception

Throws:

Exception

getCloudStatus

protected Map<String,String> getCloudStatus(org.apache.solr.client.solrj.SolrClient solrClient,
                                                  String zkHost)
                                           throws Exception

Calls the CLUSTERSTATUS endpoint in Solr to get basic status information about the SolrCloud cluster.

Throws:

Exception