public class ElasticSearchComponent extends DefaultComponent implements ElasticSearchAdmin, ElasticSearchIndexing, ElasticSearchService
Modifier and Type | Field and Description |
---|---|
protected JsonESDocumentWriter |
jsonESDocumentWriter |
lastModified
Constructor and Description |
---|
ElasticSearchComponent() |
Modifier and Type | Method and Description |
---|---|
void |
applicationStarted(ComponentContext context)
Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.
|
void |
deactivate(ComponentContext context)
Deactivates the component.
|
protected void |
dispatchWork(List<IndexingCommand> cmds)
Dispatch jobs between sync and async worker
|
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.
|
int |
getApplicationStartedOrder()
The component notification order for
Component.applicationStarted(org.nuxeo.runtime.model.ComponentContext) . |
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.
|
int |
getPendingWorkerCount()
Returns the number of indexing worker scheduled waiting to be executed.
|
List<String> |
getRepositoryNames()
List repository names that have Elasticsearch support.
|
int |
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 |
indexNonRecursive(IndexingCommand cmd)
Process the
IndexingCommand . |
void |
indexNonRecursive(List<IndexingCommand> cmds)
Same as
ElasticSearchIndexing.indexNonRecursive(org.nuxeo.elasticsearch.commands.IndexingCommand) but
process the list command using a bulk request. |
void |
initIndexes(boolean dropIfExists)
Initialize Elasticsearch indexes.
|
protected void |
initListenerThreadPool() |
protected boolean |
isElasticsearchEnabled() |
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.
|
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. |
DocumentModelList |
query(CoreSession session,
org.elasticsearch.index.query.QueryBuilder queryBuilder,
int limit,
int offset,
SortInfo... sortInfos)
Deprecated.
|
DocumentModelList |
query(CoreSession session,
String nxql,
int limit,
int offset,
SortInfo... sortInfos)
Deprecated.
|
DocumentModelList |
query(NxQueryBuilder queryBuilder)
Returns a document list using an
NxQueryBuilder . |
EsResult |
queryAndAggregate(NxQueryBuilder queryBuilder)
Returns documents and aggregates.
|
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 |
runIndexingSyncWorker(Map<String,List<IndexingCommand>> syncCommands) |
void |
runIndexingWorker(List<IndexingCommand> cmds)
Run a worker to process the
IndexingCommand . |
void |
runReindexingWorker(String repositoryName,
String nxql)
Reindex documents matching the NXQL query, This is done in an asynchronous job.
|
protected void |
scheduleIndexingAsyncWorker(Map<String,List<IndexingCommand>> asyncCommands) |
protected void |
stackCommands(List<IndexingCommand> cmds) |
activate, getAdapter, getLastModified, registerExtension, setLastModified, setModifiedNow, unregisterContribution, unregisterExtension
protected JsonESDocumentWriter jsonESDocumentWriter
public ElasticSearchComponent()
public void registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
registerContribution
in class DefaultComponent
public void applicationStarted(ComponentContext context)
Component
applicationStarted
in interface Component
applicationStarted
in class DefaultComponent
protected boolean isElasticsearchEnabled()
public void deactivate(ComponentContext context)
Component
This method is called by the runtime when a component is deactivated.
deactivate
in interface Component
deactivate
in class DefaultComponent
context
- the runtime contextpublic int getApplicationStartedOrder()
Component
Component.applicationStarted(org.nuxeo.runtime.model.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.
getApplicationStartedOrder
in interface Component
getApplicationStartedOrder
in class DefaultComponent
public org.elasticsearch.client.Client getClient()
ElasticSearchAdmin
Client
that can be used to access Elasticsearch APIgetClient
in interface ElasticSearchAdmin
public void initIndexes(boolean dropIfExists)
ElasticSearchAdmin
initIndexes
in interface ElasticSearchAdmin
dropIfExists
- if {true} remove an existing indexpublic void dropAndInitIndex(String indexName)
ElasticSearchAdmin
dropAndInitIndex
in interface ElasticSearchAdmin
public void dropAndInitRepositoryIndex(String repositoryName)
ElasticSearchAdmin
dropAndInitRepositoryIndex
in interface ElasticSearchAdmin
public List<String> getRepositoryNames()
ElasticSearchAdmin
getRepositoryNames
in interface ElasticSearchAdmin
public String getIndexNameForRepository(String repositoryName)
ElasticSearchAdmin
getIndexNameForRepository
in interface ElasticSearchAdmin
public List<String> getIndexNamesForType(String type)
ElasticSearchAdmin
getIndexNamesForType
in interface ElasticSearchAdmin
public String getIndexNameForType(String type)
ElasticSearchAdmin
getIndexNameForType
in interface ElasticSearchAdmin
public int getPendingWorkerCount()
ElasticSearchAdmin
getPendingWorkerCount
in interface ElasticSearchAdmin
public int getRunningWorkerCount()
ElasticSearchAdmin
getRunningWorkerCount
in interface ElasticSearchAdmin
public int getTotalCommandProcessed()
ElasticSearchAdmin
getTotalCommandProcessed
in interface ElasticSearchAdmin
public boolean isEmbedded()
ElasticSearchAdmin
isEmbedded
in interface ElasticSearchAdmin
public boolean isIndexingInProgress()
ElasticSearchAdmin
isIndexingInProgress
in interface ElasticSearchAdmin
public com.google.common.util.concurrent.ListenableFuture<Boolean> prepareWaitForIndexing()
ElasticSearchAdmin
Future
that accepts callback on completion when all the indexing worker are done.prepareWaitForIndexing
in interface ElasticSearchAdmin
protected void initListenerThreadPool()
public void refresh()
ElasticSearchAdmin
refresh
in interface ElasticSearchAdmin
public void refreshRepositoryIndex(String repositoryName)
ElasticSearchAdmin
refreshRepositoryIndex
in interface ElasticSearchAdmin
public void flush()
ElasticSearchAdmin
flush
in interface ElasticSearchAdmin
public void flushRepositoryIndex(String repositoryName)
ElasticSearchAdmin
flushRepositoryIndex
in interface ElasticSearchAdmin
public void optimize()
ElasticSearchAdmin
ElasticSearchAdmin.optimizeRepositoryIndex(java.lang.String)
on all document indexes,optimize
in interface ElasticSearchAdmin
public void optimizeRepositoryIndex(String repositoryName)
ElasticSearchAdmin
optimizeRepositoryIndex
in interface ElasticSearchAdmin
public void optimizeIndex(String indexName)
ElasticSearchAdmin
optimizeIndex
in interface ElasticSearchAdmin
public void indexNonRecursive(IndexingCommand cmd)
ElasticSearchIndexing
IndexingCommand
.
Send indexing command to Elasticsearch, if the command is synchronous the index is refreshed so the document is searchable immediately. Recursive indexing is not taken in account except for deletion. This is not a transactional operation, a rollback will not discard the executed commands.
indexNonRecursive
in interface ElasticSearchIndexing
public void indexNonRecursive(List<IndexingCommand> cmds)
ElasticSearchIndexing
ElasticSearchIndexing.indexNonRecursive(org.nuxeo.elasticsearch.commands.IndexingCommand)
but
process the list command using a bulk request.indexNonRecursive
in interface ElasticSearchIndexing
protected void stackCommands(List<IndexingCommand> cmds)
public void runIndexingWorker(List<IndexingCommand> cmds)
ElasticSearchIndexing
IndexingCommand
.
Asynchronous command schedules an indexing job and return.
Synchronous command execute an indexing job using a new Tx then refresh the index so the document is searchable immediately. if the command is also recursive the children are processed asynchronously.
If there is more than one cmd the elasticsearch request is done in bulk mode.
runIndexingWorker
in interface ElasticSearchIndexing
protected void dispatchWork(List<IndexingCommand> cmds)
protected void scheduleIndexingAsyncWorker(Map<String,List<IndexingCommand>> asyncCommands)
protected void runIndexingSyncWorker(Map<String,List<IndexingCommand>> syncCommands)
public void runReindexingWorker(String repositoryName, String nxql)
ElasticSearchIndexing
runReindexingWorker
in interface ElasticSearchIndexing
public DocumentModelList query(NxQueryBuilder queryBuilder)
ElasticSearchService
NxQueryBuilder
.query
in interface ElasticSearchService
public EsResult queryAndAggregate(NxQueryBuilder queryBuilder)
ElasticSearchService
queryAndAggregate
in interface ElasticSearchService
@Deprecated public DocumentModelList query(CoreSession session, String nxql, int limit, int offset, SortInfo... sortInfos)
ElasticSearchService
query
in interface ElasticSearchService
@Deprecated public DocumentModelList query(CoreSession session, org.elasticsearch.index.query.QueryBuilder queryBuilder, int limit, int offset, SortInfo... sortInfos)
ElasticSearchService
QueryBuilder
. Fetch documents from the VCS repository.query
in interface ElasticSearchService
Copyright © 2015 Nuxeo SA. All rights reserved.