Package org.nuxeo.elasticsearch

Class ElasticSearchComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.elasticsearch.ElasticSearchComponent

All Implemented Interfaces:

ElasticSearchAdmin, Adaptable, Component, Extensible, TimestampedService

public class ElasticSearchComponent
extends DefaultComponent
implements ElasticSearchAdmin

Component used to configure and manage ElasticSearch integration

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	EP_INDEX
protected ElasticSearchAdminImpl	esa
protected final Map<String,ElasticSearchIndexConfig>	indexConfig
protected com.google.common.util.concurrent.ListeningExecutorService	waiterExecutorService

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
ElasticSearchComponent()

Method Summary

Modifier and Type	Method	Description
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.
int	getApplicationStartedOrder()	The component notification order for Component.start(ComponentContext).
OpenSearchClient	getClient()	Retrieves the Client that can be used to access Elasticsearch API
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.
String	getRepositoryForIndex(String indexName)	Gets the repository name associated with the index.
List<String>	getRepositoryNames()	List repository names that have Elasticsearch support.
String	getSecondaryWriteIndexName(String searchIndexName)	Returns the secondary write index used during re-indexing with aliases.
String	getWriteIndexName(String searchIndexName)	Returns the index to use for any write operations.
void	initIndexes(boolean dropIfExists)	Initialize Elasticsearch indexes.
protected void	initListenerThreadPool()
void	initRepositoryIndexWithAliases(String repositoryName)	Creates a new index for the repository applying the mapping and settings.
protected boolean	isElasticsearchEnabled()
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	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
protected void	shutdownListenerThreadPool()
void	start(ComponentContext context)	Start the component.
void	stop(ComponentContext context)	Stop the component.
void	syncSearchAndWriteAlias(String searchIndexName)	Make sure that the search alias point to the same index as the write alias.
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 org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerExtension, setLastModified, setModifiedNow, setName, unregister, unregisterContribution, unregisterExtension

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

EP_INDEX

protected static final String EP_INDEX

See Also:

• Constant Field Values

indexConfig

protected final Map<String,ElasticSearchIndexConfig> indexConfig

esa

protected ElasticSearchAdminImpl esa

waiterExecutorService

protected com.google.common.util.concurrent.ListeningExecutorService waiterExecutorService

Constructor Details

ElasticSearchComponent

public ElasticSearchComponent()

Method Details

registerContribution

public void registerContribution(Object contribution,
 String extensionPoint,
 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

stop

public void stop(ComponentContext context)

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

isElasticsearchEnabled

protected boolean isElasticsearchEnabled()

getApplicationStartedOrder

public int getApplicationStartedOrder()

Description copied from interface: Component

The component notification order for Component.start(ComponentContext).

Components are notified in increasing order. Order 1000 is the default order for components that don't care. Order 100 is the repository initialization.

Specified by:

getApplicationStartedOrder in interface Component

Returns:

the order, 1000 by default

getClient

public OpenSearchClient 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

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

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

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

initListenerThreadPool

protected void initListenerThreadPool()

shutdownListenerThreadPool

protected void shutdownListenerThreadPool()

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

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

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

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

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

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

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

isReady

public boolean isReady()