org.apache.solr.util

Class SolrCLI

java.lang.Object

org.apache.solr.util.SolrCLI

public class SolrCLI
extends Object

Command-line utility for working with Solr.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SolrCLI.ApiTool Used to send an arbitrary HTTP request to a Solr API endpoint.
static class	SolrCLI.HealthcheckTool Requests health information about a specific collection in SolrCloud.
static class	SolrCLI.SolrCloudTool Helps build SolrCloud aware tools by initializing a CloudSolrServer instance before running the tool.
static class	SolrCLI.StatusTool Get the status of a Solr server.
static interface	SolrCLI.Tool Defines the interface to a Solr tool that can be run from this command-line app.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.cli.Option[]	cloudOptions
static String	DEFAULT_SOLR_URL
static org.apache.log4j.Logger	log
static String	ZK_HOST

Constructor Summary

Constructors

Constructor and Description
SolrCLI()

Method Summary

Methods

Modifier and Type	Method and Description
static List<String>	asList(String jsonPath, Map<String,Object> json) Helper function for reading a List of Strings from a JSON Object tree.
static Long	asLong(String jsonPath, Map<String,Object> json) Helper function for reading a Long value from a JSON Object tree.
static Map<String,Object>	asMap(String jsonPath, Map<String,Object> json) Helper function for reading a Map from a JSON Object tree.
static String	asString(String jsonPath, Map<String,Object> json) Helper function for reading a String value from a JSON Object tree.
static Object	atPath(String jsonPath, Map<String,Object> json) Helper function for reading an Object of unknown type from a JSON Object tree.
static boolean	checkCommunicationError(Exception exc) Determine if a request to Solr failed due to a communication error, which is generally retry-able.
static void	closeHttpClient(org.apache.http.client.HttpClient httpClient)
static org.apache.commons.cli.Option[]	getCommonToolOptions() Support options common to all tools.
static org.apache.http.client.HttpClient	getHttpClient()
static Map<String,Object>	getJson(org.apache.http.client.HttpClient httpClient, String getUrl) Utility function for sending HTTP GET request to Solr and then doing some validation of the response.
static Map<String,Object>	getJson(org.apache.http.client.HttpClient httpClient, String getUrl, int attempts) Utility function for sending HTTP GET request to Solr with built-in retry support.
static Map<String,Object>	getJson(String getUrl) Useful when a tool just needs to send one request to Solr.
static org.apache.commons.cli.Option[]	joinCommonAndToolOptions(org.apache.commons.cli.Option[] toolOpts)
static org.apache.commons.cli.Option[]	joinOptions(org.apache.commons.cli.Option[] lhs, org.apache.commons.cli.Option[] rhs)
static void	main(String[] args) Runs a tool.
static org.apache.commons.cli.CommandLine	processCommandLineArgs(org.apache.commons.cli.Option[] customOptions, String[] args) Parses the command-line arguments passed by the user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static org.apache.log4j.Logger log

DEFAULT_SOLR_URL

public static final String DEFAULT_SOLR_URL

See Also:

Constant Field Values

ZK_HOST

public static final String ZK_HOST

See Also:

Constant Field Values

cloudOptions

public static org.apache.commons.cli.Option[] cloudOptions

Constructor Detail

SolrCLI

public SolrCLI()

Method Detail

main

public static void main(String[] args)
                 throws Exception

Runs a tool.

Throws:

Exception

getCommonToolOptions

public static org.apache.commons.cli.Option[] getCommonToolOptions()

Support options common to all tools.

joinCommonAndToolOptions

public static org.apache.commons.cli.Option[] joinCommonAndToolOptions(org.apache.commons.cli.Option[] toolOpts)

joinOptions

public static org.apache.commons.cli.Option[] joinOptions(org.apache.commons.cli.Option[] lhs,
                                          org.apache.commons.cli.Option[] rhs)

processCommandLineArgs

public static org.apache.commons.cli.CommandLine processCommandLineArgs(org.apache.commons.cli.Option[] customOptions,
                                                        String[] args)

Parses the command-line arguments passed by the user.

checkCommunicationError

public static boolean checkCommunicationError(Exception exc)

Determine if a request to Solr failed due to a communication error, which is generally retry-able.

getHttpClient

public static org.apache.http.client.HttpClient getHttpClient()

closeHttpClient

public static void closeHttpClient(org.apache.http.client.HttpClient httpClient)

getJson

public static Map<String,Object> getJson(String getUrl)
                                  throws Exception

Useful when a tool just needs to send one request to Solr.

Throws:

Exception

getJson

public static Map<String,Object> getJson(org.apache.http.client.HttpClient httpClient,
                         String getUrl,
                         int attempts)
                                  throws Exception

Utility function for sending HTTP GET request to Solr with built-in retry support.

Throws:

Exception

getJson

public static Map<String,Object> getJson(org.apache.http.client.HttpClient httpClient,
                         String getUrl)
                                  throws Exception

Utility function for sending HTTP GET request to Solr and then doing some validation of the response.

Throws:

Exception

asString

public static String asString(String jsonPath,
              Map<String,Object> json)

Helper function for reading a String value from a JSON Object tree.

asLong

public static Long asLong(String jsonPath,
          Map<String,Object> json)

Helper function for reading a Long value from a JSON Object tree.

asList

public static List<String> asList(String jsonPath,
                  Map<String,Object> json)

Helper function for reading a List of Strings from a JSON Object tree.

asMap

public static Map<String,Object> asMap(String jsonPath,
                       Map<String,Object> json)

Helper function for reading a Map from a JSON Object tree.

atPath

public static Object atPath(String jsonPath,
            Map<String,Object> json)

Helper function for reading an Object of unknown type from a JSON Object tree.