Package org.nuxeo.elasticsearch.core

Class ElasticSearchAdminImpl

java.lang.Object

org.nuxeo.elasticsearch.core.ElasticSearchAdminImpl

All Implemented Interfaces:

ElasticSearchAdmin

public class ElasticSearchAdminImpl
extends Object
implements ElasticSearchAdmin

Since:

6.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ElasticSearchAdminImpl.ReindexingPubSub

Field Summary

Fields

Modifier and Type	Field	Description
protected ESClient	client
protected final ElasticSearchClientConfig	clientConfig
protected ElasticSearchEmbeddedNode	embeddedServer
protected final ElasticSearchEmbeddedServerConfig	embeddedServerConfig
static final String	ES_KV_STORE
protected String[]	excludeSourceFields
protected Map<String,ESHintQueryBuilder>	hints
protected String[]	includeSourceFields
protected final Map<String,ElasticSearchIndexConfig>	indexConfig
protected boolean	indexInitDone
protected final Map<String,String>	indexNames
static final String	REINDEXING_PUBSUB_TOPIC
protected final ElasticSearchAdminImpl.ReindexingPubSub	reindexingPubSub
protected final Map<String,String>	repoNames
protected List<String>	repositoryInitialized
protected final Map<String,String>	secondaryWriteIndexNames
protected static final int	TIMEOUT_DELETE_SECOND
protected static final int	TIMEOUT_WAIT_FOR_CLUSTER_SECOND
protected final AtomicInteger	totalCommandProcessed
protected boolean	useSecondaryWriteIndex
protected final Map<String,String>	writeIndexNames

Constructor Summary

Constructors

Constructor	Description
ElasticSearchAdminImpl(ElasticSearchEmbeddedServerConfig embeddedServerConfig, ElasticSearchClientConfig clientConfig, Map<String,ElasticSearchIndexConfig> indexConfig, Collection<ESHintQueryBuilderDescriptor> hintDescriptors)	Init the admin service, remote configuration if not null will take precedence over local embedded configuration.

Method Summary

Modifier and Type	Method	Description
protected void	checkClusterHealth(String... indexNames)
protected void	checkConfig()
protected void	connect()
protected ESClient	createClient(ElasticSearchEmbeddedNode node)
void	disconnect()
void	dropAndInitIndex(String indexName)	Reinitialize an index.
void	dropAndInitRepositoryIndex(String repositoryName, boolean syncAlias)	Reinitialize the index of a repository.
void	flush()	Elasticsearch flush on all document indexes, triggers a lucene commit, empties the transaction log.
void	flushRepositoryIndex(String repositoryName)	Elasticsearch flush on document index for a specific repository, triggers a lucene commit, empties the transaction log.
ESClient	getClient()	Retrieves the Client that can be used to access Elasticsearch API
protected String[]	getExcludeSourceFields()
Optional<ESHintQueryBuilder>	getHintByOperator(String name)	Returns the hint by the Elasticsearch operator name.
protected String[]	getIncludeSourceFields()
String	getIndexNameForRepository(String repositoryName)	Get the search index name associated with the repository name.
String	getIndexNameForType(String type)	Get the first search index name with the given type.
List<String>	getIndexNamesForType(String type)	Get the index names with the given type.
List<String>	getInitializedRepositories()	Get the list of repository names that have their index created.
protected KeyValueStore	getKvStore()
long	getPendingWorkerCount()	Returns the number of indexing worker scheduled waiting to be executed.
String	getRepositoryForIndex(String indexName)	Gets the repository name associated with the index.
protected Map<String,String>	getRepositoryMap()
List<String>	getRepositoryNames()	List repository names that have Elasticsearch support.
long	getRunningWorkerCount()	Returns the number of indexing worker that are currently running.
protected String[]	getSearchIndexes(List<String> searchRepositories)	Get the elastic search indexes for searches
String	getSecondaryWriteIndexName(String searchIndexName)	Returns the secondary write index used during re-indexing with aliases.
int	getTotalCommandProcessed()	Returns the total number of command processed by Elasticsearch for this Nuxeo instance.
String	getWriteIndexName(String searchIndexName)	Returns the index to use for any write operations.
protected void	initializeIndexes()
protected void	initIndex(String indexName, ElasticSearchIndexConfig conf, boolean dropIfExists)
protected void	initIndex(ElasticSearchIndexConfig conf, boolean dropIfExists)
protected void	initIndex(ElasticSearchIndexConfig conf, boolean dropIfExists, boolean syncAlias)
void	initIndexes(boolean dropIfExists)	Initialize Elasticsearch indexes.
void	initRepositoryIndexWithAliases(String repositoryName)	Creates a new index for the repository applying the mapping and settings.
protected void	initSearchAlias(ElasticSearchIndexConfig conf)
protected void	initWriteAlias(ElasticSearchIndexConfig conf, boolean create)
boolean	isEmbedded()	Returns true if the Elasticsearch is embedded with Nuxeo, sharing the same JVM.
boolean	isIndexingInProgress()	Returns true if there are indexing activities scheduled or running.
boolean	isReady()
void	optimize()	Elasticsearch run ElasticSearchAdmin.optimizeRepositoryIndex(java.lang.String) on all document indexes,
void	optimizeIndex(String indexName)	Elasticsearch optimize operation allows to reduce the number of segments to one, Note that this can potentially be a very heavy operation.
void	optimizeRepositoryIndex(String repositoryName)	Elasticsearch optimize operation allows to reduce the number of segments to one, Note that this can potentially be a very heavy operation.
com.google.common.util.concurrent.ListenableFuture<Boolean>	prepareWaitForIndexing()	A Future that accepts callback on completion when all the indexing worker are done.
void	refresh()	Refresh all document indexes, immediately after the operation occurs, so that the updated document appears in search results immediately.
void	refreshRepositoryIndex(String repositoryName)	Refresh document index for the specific repository, immediately after the operation occurs, so that the updated document appears in search results immediately.
void	syncSearchAndWriteAlias(String searchIndexName)	Make sure that the search alias point to the same index as the write alias.
protected void	syncSearchAndWriteAlias(ElasticSearchIndexConfig conf)	Update the search index to point to the write index.
boolean	useExternalVersion()	When true use an external version for Elasticsearch document, this enable an optimistic concurrency control ensuring that an older version of a document never overwrites a newer version.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.elasticsearch.api.ElasticSearchAdmin

dropAndInitRepositoryIndex

Field Details

TIMEOUT_WAIT_FOR_CLUSTER_SECOND

protected static final int TIMEOUT_WAIT_FOR_CLUSTER_SECOND

See Also:

• Constant Field Values

TIMEOUT_DELETE_SECOND

protected static final int TIMEOUT_DELETE_SECOND

See Also:

• Constant Field Values

ES_KV_STORE

public static final String ES_KV_STORE

See Also:

• Constant Field Values

totalCommandProcessed

protected final AtomicInteger totalCommandProcessed

indexNames

protected final Map<String,String> indexNames

repoNames

protected final Map<String,String> repoNames

writeIndexNames

protected final Map<String,String> writeIndexNames

secondaryWriteIndexNames

protected final Map<String,String> secondaryWriteIndexNames

useSecondaryWriteIndex

protected boolean useSecondaryWriteIndex

reindexingPubSub

protected final ElasticSearchAdminImpl.ReindexingPubSub reindexingPubSub

REINDEXING_PUBSUB_TOPIC

public static final String REINDEXING_PUBSUB_TOPIC

See Also:

• Constant Field Values

indexConfig

protected final Map<String,ElasticSearchIndexConfig> indexConfig

hints

protected Map<String,ESHintQueryBuilder> hints

embeddedServerConfig

protected final ElasticSearchEmbeddedServerConfig embeddedServerConfig

clientConfig

protected final ElasticSearchClientConfig clientConfig

embeddedServer

protected ElasticSearchEmbeddedNode embeddedServer

client

protected ESClient client

indexInitDone

protected boolean indexInitDone

includeSourceFields

protected String[] includeSourceFields

excludeSourceFields

protected String[] excludeSourceFields

repositoryInitialized

protected List<String> repositoryInitialized

Constructor Details

ElasticSearchAdminImpl

public ElasticSearchAdminImpl(ElasticSearchEmbeddedServerConfig embeddedServerConfig,
 ElasticSearchClientConfig clientConfig,
 Map<String,ElasticSearchIndexConfig> indexConfig,
 Collection<ESHintQueryBuilderDescriptor> hintDescriptors)

Init the admin service, remote configuration if not null will take precedence over local embedded configuration. The transport client initialization can be customized.

Since:

9.1

Method Details

checkConfig

protected void checkConfig()

connect

protected void connect()

disconnect

public void disconnect()

createClient

protected ESClient createClient(ElasticSearchEmbeddedNode node)

checkClusterHealth

protected void checkClusterHealth(String... indexNames)

initializeIndexes

protected void initializeIndexes()

refreshRepositoryIndex

public void refreshRepositoryIndex(String repositoryName)

Description copied from interface: ElasticSearchAdmin

Refresh document index for the specific repository, immediately after the operation occurs, so that the updated document appears in search results immediately. There is no fsync thus doesn't guarantee durability.

Specified by:

refreshRepositoryIndex in interface ElasticSearchAdmin

getIndexNameForRepository

public String getIndexNameForRepository(String repositoryName)

Description copied from interface: ElasticSearchAdmin

Get the search index name associated with the repository name.

Specified by:

getIndexNameForRepository in interface ElasticSearchAdmin

getRepositoryForIndex

public String getRepositoryForIndex(String indexName)

Description copied from interface: ElasticSearchAdmin

Gets the repository name associated with the index.

Specified by:

getRepositoryForIndex in interface ElasticSearchAdmin

getIndexNamesForType

public List<String> getIndexNamesForType(String type)

Description copied from interface: ElasticSearchAdmin

Get the index names with the given type.

Specified by:

getIndexNamesForType in interface ElasticSearchAdmin

getIndexNameForType

public String getIndexNameForType(String type)

Description copied from interface: ElasticSearchAdmin

Get the first search index name with the given type.

Specified by:

getIndexNameForType in interface ElasticSearchAdmin

getWriteIndexName

public String getWriteIndexName(String searchIndexName)

Description copied from interface: ElasticSearchAdmin

Returns the index to use for any write operations.

Specified by:

getWriteIndexName in interface ElasticSearchAdmin

getSecondaryWriteIndexName

public String getSecondaryWriteIndexName(String searchIndexName)

Description copied from interface: ElasticSearchAdmin

Returns the secondary write index used during re-indexing with aliases.

Specified by:

getSecondaryWriteIndexName in interface ElasticSearchAdmin

Returns:

an index name or null if there is no re-indexing in progress.

syncSearchAndWriteAlias

public void syncSearchAndWriteAlias(String searchIndexName)

Description copied from interface: ElasticSearchAdmin

Make sure that the search alias point to the same index as the write alias.

Specified by:

syncSearchAndWriteAlias in interface ElasticSearchAdmin

flushRepositoryIndex

public void flushRepositoryIndex(String repositoryName)

Description copied from interface: ElasticSearchAdmin

Elasticsearch flush on document index for a specific repository, triggers a lucene commit, empties the transaction log. Data is flushed to disk.

Specified by:

flushRepositoryIndex in interface ElasticSearchAdmin

refresh

public void refresh()

Description copied from interface: ElasticSearchAdmin

Refresh all document indexes, immediately after the operation occurs, so that the updated document appears in search results immediately. There is no fsync thus doesn't guarantee durability.

Specified by:

refresh in interface ElasticSearchAdmin

flush

public void flush()

Description copied from interface: ElasticSearchAdmin

Elasticsearch flush on all document indexes, triggers a lucene commit, empties the transaction log. Data is flushed to disk.

Specified by:

flush in interface ElasticSearchAdmin

optimizeIndex

public void optimizeIndex(String indexName)

Description copied from interface: ElasticSearchAdmin

Elasticsearch optimize operation allows to reduce the number of segments to one, Note that this can potentially be a very heavy operation.

Specified by:

optimizeIndex in interface ElasticSearchAdmin

optimizeRepositoryIndex

public void optimizeRepositoryIndex(String repositoryName)

Description copied from interface: ElasticSearchAdmin

Elasticsearch optimize operation allows to reduce the number of segments to one, Note that this can potentially be a very heavy operation.

Specified by:

optimizeRepositoryIndex in interface ElasticSearchAdmin

optimize

public void optimize()

Description copied from interface: ElasticSearchAdmin

Elasticsearch run ElasticSearchAdmin.optimizeRepositoryIndex(java.lang.String) on all document indexes,

Specified by:

optimize in interface ElasticSearchAdmin

getClient

public ESClient getClient()

Description copied from interface: ElasticSearchAdmin

Retrieves the Client that can be used to access Elasticsearch API

Specified by:

getClient in interface ElasticSearchAdmin

initIndexes

public void initIndexes(boolean dropIfExists)

Description copied from interface: ElasticSearchAdmin

Initialize Elasticsearch indexes. Setup the index settings and mapping for each index that has been registered.

Specified by:

initIndexes in interface ElasticSearchAdmin

Parameters:

dropIfExists - if {true} remove an existing index

dropAndInitIndex

public void dropAndInitIndex(String indexName)

Description copied from interface: ElasticSearchAdmin

Reinitialize an index. This will drop the existing index, recreate it with its settings and mapping, the index will be empty.

Specified by:

dropAndInitIndex in interface ElasticSearchAdmin

dropAndInitRepositoryIndex

public void dropAndInitRepositoryIndex(String repositoryName,
 boolean syncAlias)

Description copied from interface: ElasticSearchAdmin

Reinitialize the index of a repository. This will drop the existing index, recreate it with its settings and mapping, the index will be empty. When syncAlias is false then search alias is not updated with the new index, you need to explicitly call ElasticSearchAdmin.syncSearchAndWriteAlias(String)

Specified by:

dropAndInitRepositoryIndex in interface ElasticSearchAdmin

initRepositoryIndexWithAliases

public void initRepositoryIndexWithAliases(String repositoryName)

Description copied from interface: ElasticSearchAdmin

Creates a new index for the repository applying the mapping and settings. Update the write alias to point to this new index. The search alias is updated to the new index only for the initial creation. Otherwise, there are two write indexes until an explicit call to ElasticSearchAdmin.syncSearchAndWriteAlias(String).

Specified by:

initRepositoryIndexWithAliases in interface ElasticSearchAdmin

getRepositoryNames

public List<String> getRepositoryNames()

Description copied from interface: ElasticSearchAdmin

List repository names that have Elasticsearch support.

Specified by:

getRepositoryNames in interface ElasticSearchAdmin

initIndex

protected void initIndex(ElasticSearchIndexConfig conf,
 boolean dropIfExists)

initIndex

protected void initIndex(ElasticSearchIndexConfig conf,
 boolean dropIfExists,
 boolean syncAlias)

initWriteAlias

protected void initWriteAlias(ElasticSearchIndexConfig conf,
 boolean create)

initSearchAlias

protected void initSearchAlias(ElasticSearchIndexConfig conf)

syncSearchAndWriteAlias

protected void syncSearchAndWriteAlias(ElasticSearchIndexConfig conf)

Update the search index to point to the write index.

initIndex

protected void initIndex(String indexName,
 ElasticSearchIndexConfig conf,
 boolean dropIfExists)

getPendingWorkerCount

public long getPendingWorkerCount()

Description copied from interface: ElasticSearchAdmin

Returns the number of indexing worker scheduled waiting to be executed.

Specified by:

getPendingWorkerCount in interface ElasticSearchAdmin

getRunningWorkerCount

public long getRunningWorkerCount()

Description copied from interface: ElasticSearchAdmin

Returns the number of indexing worker that are currently running.

Specified by:

getRunningWorkerCount in interface ElasticSearchAdmin

getTotalCommandProcessed

public int getTotalCommandProcessed()

Description copied from interface: ElasticSearchAdmin

Returns the total number of command processed by Elasticsearch for this Nuxeo instance. Useful for test assertion.

Specified by:

getTotalCommandProcessed in interface ElasticSearchAdmin

isEmbedded

public boolean isEmbedded()

Description copied from interface: ElasticSearchAdmin

Returns true if the Elasticsearch is embedded with Nuxeo, sharing the same JVM.

Specified by:

isEmbedded in interface ElasticSearchAdmin

useExternalVersion

public boolean useExternalVersion()

Description copied from interface: ElasticSearchAdmin

When true use an external version for Elasticsearch document, this enable an optimistic concurrency control ensuring that an older version of a document never overwrites a newer version.

Specified by:

useExternalVersion in interface ElasticSearchAdmin

isIndexingInProgress

public boolean isIndexingInProgress()

Description copied from interface: ElasticSearchAdmin

Returns true if there are indexing activities scheduled or running.

Specified by:

isIndexingInProgress in interface ElasticSearchAdmin

prepareWaitForIndexing

public com.google.common.util.concurrent.ListenableFuture<Boolean> prepareWaitForIndexing()

Description copied from interface: ElasticSearchAdmin

A Future that accepts callback on completion when all the indexing worker are done.

Specified by:

prepareWaitForIndexing in interface ElasticSearchAdmin

getSearchIndexes

protected String[] getSearchIndexes(List<String> searchRepositories)

Get the elastic search indexes for searches

isReady

public boolean isReady()

getIncludeSourceFields

protected String[] getIncludeSourceFields()

getExcludeSourceFields

protected String[] getExcludeSourceFields()

getRepositoryMap

protected Map<String,String> getRepositoryMap()

getInitializedRepositories

public List<String> getInitializedRepositories()

Get the list of repository names that have their index created.

getHintByOperator

public Optional<ESHintQueryBuilder> getHintByOperator(String name)

Description copied from interface: ElasticSearchAdmin

Returns the hint by the Elasticsearch operator name.

Specified by:

getHintByOperator in interface ElasticSearchAdmin

getKvStore

protected KeyValueStore getKvStore()