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

Constructor Summary

Constructors

Constructor and Description
ElasticSearchAdminImpl(ElasticSearchLocalConfig localConfig, ElasticSearchRemoteConfig remoteConfig, Map<String,ElasticSearchIndexConfig> indexConfig) Deprecated. since 9.1, use #ElasticSearchAdminImpl(ElasticSearchLocalConfig, ElasticSearchRemoteConfig, Map, ESClientInitializationService) instead.
ElasticSearchAdminImpl(ElasticSearchLocalConfig localConfig, ElasticSearchRemoteConfig remoteConfig, Map<String,ElasticSearchIndexConfig> indexConfig, ESClientInitializationService clientInitService) Init the admin service, remote configuration if not null will take precedence over local embedded configuration.

Method Summary

Modifier and Type	Method and Description
void	disconnect()
void	dropAndInitIndex(String indexName) Reinitialize an index.
void	dropAndInitRepositoryIndex(String repositoryName) 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.
org.elasticsearch.client.Client	getClient() Retrieves the Client that can be used to access Elasticsearch API
String	getIndexNameForRepository(String repositoryName) Get the index name associated with the repository name.
String	getIndexNameForType(String type) Get the first 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.
long	getPendingWorkerCount() Returns the number of indexing worker scheduled waiting to be executed.
List<String>	getRepositoryNames() List repository names that have Elasticsearch support.
long	getRunningWorkerCount() Returns the number of indexing worker that are currently running.
int	getTotalCommandProcessed() Returns the total number of command processed by Elasticsearch for this Nuxeo instance.
void	initIndexes(boolean dropIfExists) Initialize Elasticsearch indexes.
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.
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

Constructor Detail

ElasticSearchAdminImpl

@Deprecated
public ElasticSearchAdminImpl(ElasticSearchLocalConfig localConfig,
                                          ElasticSearchRemoteConfig remoteConfig,
                                          Map<String,ElasticSearchIndexConfig> indexConfig)

Deprecated. since 9.1, use #ElasticSearchAdminImpl(ElasticSearchLocalConfig, ElasticSearchRemoteConfig, Map, ESClientInitializationService) instead.

Init the admin service, remote configuration if not null will take precedence over local embedded configuration.

ElasticSearchAdminImpl

public ElasticSearchAdminImpl(ElasticSearchLocalConfig localConfig,
                              ElasticSearchRemoteConfig remoteConfig,
                              Map<String,ElasticSearchIndexConfig> indexConfig,
                              ESClientInitializationService clientInitService)

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 Detail

disconnect

public void disconnect()

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 index name associated with the repository name.

Specified by:

getIndexNameForRepository 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 index name with the given type.

Specified by:

getIndexNameForType 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 org.elasticsearch.client.Client 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)

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.

Specified by:

dropAndInitRepositoryIndex 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

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

isReady

public boolean isReady()

getInitializedRepositories

public List<String> getInitializedRepositories()

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