org.codice.solr.factory.impl

Class HttpSolrClientFactory

java.lang.Object

org.codice.solr.factory.impl.HttpSolrClientFactory

All Implemented Interfaces:

SolrClientFactory

public class HttpSolrClientFactory
extends Object
implements SolrClientFactory

Factory class used to create new HttpSolrClient instances.
Uses the following system properties when creating an instance:

• solr.data.dir: Absolute path to the directory where the Solr data will be stored
• solr.http.url: Solr server URL
• org.codice.ddf.system.threadPoolSize: Solr query thread pool size
• https.protocols: Secure protocols supported by the Solr server
• https.cipherSuites: Cipher suites supported by the Solr server

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	DEFAULT_CIPHER_SUITES
static List<String>	DEFAULT_PROTOCOLS
static String	DEFAULT_SCHEMA_XML
static String	DEFAULT_SOLRCONFIG_XML

Constructor Summary

Constructors

Constructor and Description
HttpSolrClientFactory()

Method Summary

Modifier and Type	Method and Description
static String	getDefaultHttpAddress() Gets the default Solr server HTTP address.
static String	getDefaultHttpsAddress() Gets the default Solr server secure HTTP address.
static Future<org.apache.solr.client.solrj.SolrClient>	getHttpSolrClient(String url) Creates a new HttpSolrClient using the URL provided.
static Future<org.apache.solr.client.solrj.SolrClient>	getHttpSolrClient(String url, String coreName) Creates a new HttpSolrClient using the URL and core name provided.
static Future<org.apache.solr.client.solrj.SolrClient>	getHttpSolrClient(String url, String coreName, String configFile) Creates a new HttpSolrClient using the URL, core name and configuration file name provided.
Future<org.apache.solr.client.solrj.SolrClient>	newClient(String core) Requests the creation of a new SolrClient for a specific Solr core name.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROTOCOLS

public static final List<String> DEFAULT_PROTOCOLS

DEFAULT_CIPHER_SUITES

public static final List<String> DEFAULT_CIPHER_SUITES

DEFAULT_SCHEMA_XML

public static final String DEFAULT_SCHEMA_XML

See Also:

Constant Field Values

DEFAULT_SOLRCONFIG_XML

public static final String DEFAULT_SOLRCONFIG_XML

See Also:

Constant Field Values

Constructor Detail

HttpSolrClientFactory

public HttpSolrClientFactory()

Method Detail

newClient

public Future<org.apache.solr.client.solrj.SolrClient> newClient(String core)

Description copied from interface: SolrClientFactory

Requests the creation of a new SolrClient for a specific Solr core name.
Note that Future.get() will return null if a SolrClient could not be created either immediately or after a retry period determined by the implementing class. Clients of this class should consider implementing retry logic if needed based on that return value.

Specified by:

newClient in interface SolrClientFactory

Parameters:

core - name of the Solr core to create

Returns:

Future used to retrieve the new SolrClient created

getDefaultHttpsAddress

public static String getDefaultHttpsAddress()

Gets the default Solr server secure HTTP address.

Returns:

Solr server secure HTTP address

getDefaultHttpAddress

public static String getDefaultHttpAddress()

Gets the default Solr server HTTP address.

Returns:

Solr server HTTP address

getHttpSolrClient

public static Future<org.apache.solr.client.solrj.SolrClient> getHttpSolrClient(@Nullable
                                                                                String url)

Creates a new HttpSolrClient using the URL provided. Uses the default Solr core name () and configuration file ("solrconfig.xml").

Parameters:

url - Solr server URL. If null, defaults to the system's base URL followed by /solr.

Returns:

Future used to retrieve the new HttpSolrClient instance

getHttpSolrClient

public static Future<org.apache.solr.client.solrj.SolrClient> getHttpSolrClient(@Nullable
                                                                                String url,
                                                                                String coreName)

Creates a new HttpSolrClient using the URL and core name provided. Uses the default configuration file ("solrconfig.xml").

Parameters:

url - Solr server URL. If null, defaults to the system's base URL followed by /solr.

coreName - name of the Solr core to create

Returns:

Future used to retrieve the new HttpSolrClient instance

getHttpSolrClient

public static Future<org.apache.solr.client.solrj.SolrClient> getHttpSolrClient(@Nullable
                                                                                String url,
                                                                                String coreName,
                                                                                @Nullable
                                                                                String configFile)

Creates a new HttpSolrClient using the URL, core name and configuration file name provided.

Parameters:

url - Solr server URL. If null, defaults to the system's base URL followed by /solr.

coreName - name of the Solr core to create

configFile - configuration file name. If null, defaults to "solrconfig.xml".

Returns:

Future used to retrieve the new HttpSolrClient instance