Package org.nuxeo.ecm.core.search

Class SearchServiceImpl

java.lang.Object

org.nuxeo.ecm.core.search.SearchServiceImpl

All Implemented Interfaces:

SearchIndexingService, SearchService

public class SearchServiceImpl
extends Object
implements SearchService, SearchIndexingService

Since:

2025.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	defaultRepository
protected final Map<String,IndexingJsonWriter>	indexToJsonWriter
protected static final int	LOAD_SOURCES_TIMEOUT
protected static final com.fasterxml.jackson.databind.ObjectMapper	MAPPER
protected static final String	NXQL_ALL_DOCUMENTS
protected final Map<String,String>	repoToDefaultIndex
protected final Map<String,List<String>>	repoToIndexes
protected final Map<String,SearchClient>	searchClients
protected final Map<String,SearchIndex>	searchIndexes
protected static final String	SELECT_DOCUMENTS_IN

Constructor Summary

Constructors

Constructor	Description
SearchServiceImpl(List<SearchClientDescriptor> clients, List<SearchIndexDescriptor> indexes)

Method Summary

Modifier and Type	Method	Description
boolean	await(Duration duration)	Waits for completion of all indexing activities.
protected void	checkAllIndexInRepo(String repository, List<String> indexNames)
boolean	clearSearchScroll(SearchScrollContext scrollContext)	Explicit clear the search scroll context, without waiting for the scroll keep alive to timeout.
SearchClient	getClient(String clientName)	Internal: Retrieves a search client by name.
String	getDefaultIndexName(String repository)	Gets the default index for the given repository.
String	getDefaultRepositoryName()	Gets the default repository name.
SearchIndex	getDefaultSearchIndexForRepository(String repository)	Gets the default SearchIndex for a given repository.
List<String>	getIndexNames(String repository)	Gets all available indexes for a repository.
Set<String>	getRepositoryNames()	Gets the set of repository names.
SearchIndex	getSearchIndex(String indexName)	Gets the SearchIndex for the given index name.
List<SearchIndex>	getSearchIndexForRepository(String repository)	Gets the list of SearchIndex for a given repository.
BulkIndexingResponse	indexDocuments(BulkIndexingRequest request)	Internal: Indexes documents according to the specified bulk indexing request.
protected String	json(IndexingJsonWriter writer, DocumentModel doc)
protected DocumentModelList	loadDocuments(CoreSession session, List<String> documentIds)
protected DocumentModelList	loadDocumentsOneByOne(CoreSession session, List<String> documentIds)
protected void	loadSources(BulkIndexingRequest bulk)
void	refresh(SearchIndex index)	Refreshes a search index to make newly indexed documents immediately searchable.
String	reindexDocuments(String repository, String nxql, long queryLimit)	Reindexes documents matching the specified NXQL query up to the given limit for all search indexes of the repository.
String	reindexDocuments(String repository, String nxql, long queryLimit, List<String> indexNames)	Reindexes documents matching the specified NXQL query for the given limit only for the specified indexes.
String	reindexRepository(String repository)	Internal: Reindexes the entire repository by dropping and recreating all associated search indexes.
String	reindexRepository(String repository, List<String> indexNames)	Internal: Reindexes the entire repository by dropping and recreating the given search indexes.
SearchResponse	search(SearchQuery query)	Executes a search query.
SearchResponse	searchScroll(SearchScrollContext scrollContext)	Iterate on results for a scroll search.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.search.SearchIndexingService

reindexDocuments

Methods inherited from interface org.nuxeo.ecm.core.search.SearchService

getDefaultIndexName, getDefaultSearchIndex

Field Details

LOAD_SOURCES_TIMEOUT

protected static final int LOAD_SOURCES_TIMEOUT

MAPPER

protected static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

SELECT_DOCUMENTS_IN

protected static final String SELECT_DOCUMENTS_IN

See Also:

• Constant Field Values

NXQL_ALL_DOCUMENTS

protected static final String NXQL_ALL_DOCUMENTS

See Also:

• Constant Field Values

searchClients

protected final Map<String,SearchClient> searchClients

searchIndexes

protected final Map<String,SearchIndex> searchIndexes

repoToDefaultIndex

protected final Map<String,String> repoToDefaultIndex

repoToIndexes

protected final Map<String,List<String>> repoToIndexes

indexToJsonWriter

protected final Map<String,IndexingJsonWriter> indexToJsonWriter

defaultRepository

protected final String defaultRepository

Constructor Details

SearchServiceImpl

public SearchServiceImpl(List<SearchClientDescriptor> clients,
 List<SearchIndexDescriptor> indexes)

Method Details

getDefaultRepositoryName

public String getDefaultRepositoryName()

Description copied from interface: SearchService

Gets the default repository name.

Specified by:

getDefaultRepositoryName in interface SearchService

getRepositoryNames

public Set<String> getRepositoryNames()

Description copied from interface: SearchService

Gets the set of repository names.

Specified by:

getRepositoryNames in interface SearchService

getDefaultIndexName

public String getDefaultIndexName(String repository)

Description copied from interface: SearchService

Gets the default index for the given repository.

Specified by:

getDefaultIndexName in interface SearchService

getIndexNames

public List<String> getIndexNames(String repository)

Description copied from interface: SearchService

Gets all available indexes for a repository.

Specified by:

getIndexNames in interface SearchService

getSearchIndex

public SearchIndex getSearchIndex(String indexName)

Description copied from interface: SearchService

Gets the SearchIndex for the given index name.

Specified by:

getSearchIndex in interface SearchService

getDefaultSearchIndexForRepository

public SearchIndex getDefaultSearchIndexForRepository(String repository)

Description copied from interface: SearchService

Gets the default SearchIndex for a given repository.

Specified by:

getDefaultSearchIndexForRepository in interface SearchService

getSearchIndexForRepository

public List<SearchIndex> getSearchIndexForRepository(String repository)

Description copied from interface: SearchService

Gets the list of SearchIndex for a given repository.

Specified by:

getSearchIndexForRepository in interface SearchService

search

public SearchResponse search(SearchQuery query)

Description copied from interface: SearchService

Executes a search query.

var response = searchService.search(SearchQuery.builder("SELECT * FROM Document", session).build());

Specified by:

search in interface SearchService

searchScroll

public SearchResponse searchScroll(SearchScrollContext scrollContext)

Description copied from interface: SearchService

Iterate on results for a scroll search. The end of scroll is reached when there is no more hit, i.e. SearchResponse.getHitsCount() returns 0.

Specified by:

searchScroll in interface SearchService

Parameters:

scrollContext - provided by the previous SearchResponse.getScrollContext();

clearSearchScroll

public boolean clearSearchScroll(SearchScrollContext scrollContext)

Description copied from interface: SearchService

Explicit clear the search scroll context, without waiting for the scroll keep alive to timeout.

Specified by:

clearSearchScroll in interface SearchService

Returns:

true if the context is successfully cleared.

indexDocuments

public BulkIndexingResponse indexDocuments(BulkIndexingRequest request)

Description copied from interface: SearchIndexingService

Internal: Indexes documents according to the specified bulk indexing request.

Specified by:

indexDocuments in interface SearchIndexingService

Parameters:

request - the bulk indexing request containing documents to index

Returns:

the indexing response with operation details

loadSources

protected void loadSources(BulkIndexingRequest bulk)

loadDocuments

protected DocumentModelList loadDocuments(CoreSession session,
 List<String> documentIds)

loadDocumentsOneByOne

protected DocumentModelList loadDocumentsOneByOne(CoreSession session,
 List<String> documentIds)

json

protected String json(IndexingJsonWriter writer,
 DocumentModel doc)

reindexRepository

public String reindexRepository(String repository)

Description copied from interface: SearchIndexingService

Internal: Reindexes the entire repository by dropping and recreating all associated search indexes.

Specified by:

reindexRepository in interface SearchIndexingService

Parameters:

repository - the repository name

Returns:

the bulk command id for the reindexing operation

reindexRepository

public String reindexRepository(String repository,
 List<String> indexNames)

Description copied from interface: SearchIndexingService

Internal: Reindexes the entire repository by dropping and recreating the given search indexes.

Specified by:

reindexRepository in interface SearchIndexingService

Parameters:

indexNames - the list of indexes to reindex, all indexes must be on the same repository

Returns:

the bulk command id for the reindexing operation

reindexDocuments

public String reindexDocuments(String repository,
 String nxql,
 long queryLimit)

Description copied from interface: SearchIndexingService

Reindexes documents matching the specified NXQL query up to the given limit for all search indexes of the repository.

Specified by:

reindexDocuments in interface SearchIndexingService

Parameters:

repository - the repository name

nxql - the NXQL query to select documents

queryLimit - maximum number of documents to index, or -1 for no limit

Returns:

the bulk command id for the reindexing operation

reindexDocuments

public String reindexDocuments(String repository,
 String nxql,
 long queryLimit,
 List<String> indexNames)

Description copied from interface: SearchIndexingService

Reindexes documents matching the specified NXQL query for the given limit only for the specified indexes.

Specified by:

reindexDocuments in interface SearchIndexingService

Parameters:

repository - the repository name

nxql - the NXQL query to select documents

queryLimit - maximum number of documents to index, or -1 for no limit

indexNames - search indexes to reindex, all search indexes must point to the same repository

Returns:

the bulk command id for the reindexing operation

checkAllIndexInRepo

protected void checkAllIndexInRepo(String repository,
 List<String> indexNames)

refresh

public void refresh(SearchIndex index)

Description copied from interface: SearchIndexingService

Refreshes a search index to make newly indexed documents immediately searchable.

Specified by:

refresh in interface SearchIndexingService

Parameters:

index - the search index to refresh

getClient

public SearchClient getClient(String clientName)

Description copied from interface: SearchIndexingService

Internal: Retrieves a search client by name.

Specified by:

getClient in interface SearchIndexingService

Parameters:

clientName - the name of the search client

Returns:

the search client instance

await

public boolean await(Duration duration)
              throws InterruptedException

Description copied from interface: SearchIndexingService

Waits for completion of all indexing activities. Intended for testing purposes only.

Specified by:

await in interface SearchIndexingService

Parameters:

duration - the maximum duration to wait

Returns:

true if all indexing operations completed, false if timeout occurred

Throws:

InterruptedException - if the current thread is interrupted while waiting