org.ametys.cms.search.solr

Interface SolrClientProvider

All Known Implementing Classes:

DefaultSolrClientProvider

public interface SolrClientProvider

Component acting as a single entry point to get access to Solr clients.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE The component role.

Method Summary

Modifier and Type	Method and Description
String	getCollectionName() Get the name of the collection to use.
String	getCollectionName(String workspaceName) Get the collection to use.
SolrClient	getReadClient() Get the "read" mode solr client.
default SolrClient	getUpdateClient(String workspaceName) Get a (default) Solr client suited to update.
SolrClient	getUpdateClient(String workspaceName, boolean autoCommit) Get a Solr client suited to update.

Field Detail

ROLE

static final String ROLE

The component role.

Method Detail

getReadClient

SolrClient getReadClient()

Get the "read" mode solr client.

Returns:

the "read" mode solr client.

getUpdateClient

default SolrClient getUpdateClient(String workspaceName)

Get a (default) Solr client suited to update.

Parameters:

workspaceName - The name of the workspace

Returns:

a Solr client suited to update.

getUpdateClient

SolrClient getUpdateClient(String workspaceName,
                           boolean autoCommit)

Get a Solr client suited to update.
You must call this method with false value for argument `autocommit` so as to get a client that will not trigger any autocommit on Solr side.
Otherwise, calling this method with true value for argument `autocommit` is equivalent to calling getUpdateClient(String)

Parameters:

workspaceName - The name of the workspace

autoCommit - false so as to get a client that will not trigger any autocommit on Solr side.

Returns:

a Solr client suited to update.

getCollectionName

String getCollectionName()

Get the name of the collection to use.

Returns:

The name of the collection to search in.

getCollectionName

String getCollectionName(String workspaceName)

Get the collection to use.

Parameters:

workspaceName - The workspace name.

Returns:

The name of the collection to search in.