org.codice.solr.factory.impl

Class EmbeddedSolrFactory

java.lang.Object

org.codice.solr.factory.impl.EmbeddedSolrFactory

All Implemented Interfaces:

SolrClientFactory

public class EmbeddedSolrFactory
extends Object
implements SolrClientFactory

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

• solr.data.dir: Absolute path to the directory where the Solr data will be stored

Field Summary

Fields

Modifier and Type	Field and Description
static String	IMMEMORY_SOLRCONFIG_XML

Constructor Summary

Constructors

Constructor and Description
EmbeddedSolrFactory()

Method Summary

Modifier and Type	Method and Description
static File	getConfigFile(String configFileName, ConfigurationFileProxy configProxy, String core)
static org.apache.solr.client.solrj.SolrClient	getEmbeddedSolrServer() Creates a new EmbeddedSolrServer using the default Solr core name (), configuration file () and schema.
static org.apache.solr.client.solrj.embedded.EmbeddedSolrServer	getEmbeddedSolrServer(String solrConfigXml) Creates a new EmbeddedSolrServer using the Solr configuration file provided.
static org.apache.solr.client.solrj.embedded.EmbeddedSolrServer	getEmbeddedSolrServer(String coreName, String solrConfigXml, String schemaXml, ConfigurationFileProxy givenConfigFileProxy) Creates a new EmbeddedSolrServer using the Solr core and configuration file names, schema and configuration file proxy 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

IMMEMORY_SOLRCONFIG_XML

public static final String IMMEMORY_SOLRCONFIG_XML

See Also:

Constant Field Values

Constructor Detail

EmbeddedSolrFactory

public EmbeddedSolrFactory()

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

getEmbeddedSolrServer

public static org.apache.solr.client.solrj.SolrClient getEmbeddedSolrServer()

Creates a new EmbeddedSolrServer using the default Solr core name (), configuration file () and schema.

Returns:

a new EmbeddedSolrServer instance

getEmbeddedSolrServer

public static org.apache.solr.client.solrj.embedded.EmbeddedSolrServer getEmbeddedSolrServer(@Nullable
                                                                                             String solrConfigXml)

Creates a new EmbeddedSolrServer using the Solr configuration file provided. Uses the default core name () and schema.

Parameters:

solrConfigXml - name of the Solr configuration file. Defaults to if null.

Returns:

a new EmbeddedSolrServer instance

getEmbeddedSolrServer

public static org.apache.solr.client.solrj.embedded.EmbeddedSolrServer getEmbeddedSolrServer(String coreName,
                                                                                             @Nullable
                                                                                             String solrConfigXml,
                                                                                             @Nullable
                                                                                             String schemaXml,
                                                                                             @Nullable
                                                                                             ConfigurationFileProxy givenConfigFileProxy)

Creates a new EmbeddedSolrServer using the Solr core and configuration file names, schema and configuration file proxy provided.

Parameters:

coreName - name of the Solr core

solrConfigXml - name of the Solr configuration file. Defaults to if null.

schemaXml - file name of the Solr core schema. Defaults to if null.

givenConfigFileProxy - ConfigurationFileProxy instance to use. If null, a new ConfigurationFileProxy will be used.

Returns:

a new EmbeddedSolrServer instance

getConfigFile

public static File getConfigFile(String configFileName,
                                 ConfigurationFileProxy configProxy,
                                 String core)