org.xwiki.search.solr

Interface SolrCoreInitializer

All Known Implementing Classes:

AbstractSolrCoreInitializer

@Role
 @Unstable
public interface SolrCoreInitializer

An extension point used to inject mandatory Solr cores.

Since:

12.2

Version:

$Id: 959506b164c41585878974ed4e90448d7cb857ca $

Method Summary

Modifier and Type	Method and Description
String	getCoreName()
void	initialize(org.apache.solr.client.solrj.SolrClient client) Initialize the client after its creation.
default boolean	isCache() Indicate if the the core content is considered to be caching (it's possible to recreate it if the core is lost).

Method Detail

getCoreName

String getCoreName()

Returns:

the name of Solr core to initialize.

initialize

void initialize(org.apache.solr.client.solrj.SolrClient client)
         throws SolrException

Initialize the client after its creation.

Parameters:

client - to manipulate the core

Throws:

SolrException - when failing to initialize the core

isCache

default boolean isCache()

Indicate if the the core content is considered to be caching (it's possible to recreate it if the core is lost). In practice it's mostly used to decide where to store the core data to make clear what it is when looking at the permanent directory in case of embedded Solr.

Returns:

true if the content of the core is considered to be cache

Since:

12.10