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<SearchIndex,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,SearchIndex>	repoToDefaultSearchIndex
protected final Map<String,List<SearchIndex>>	repoToSearchIndexes
protected final Map<String,SearchClient>	searchClients
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 indexing activity for testing purpose only.
boolean	clearSearchScroll(SearchScrollContext scrollContext)	Explicit clear the search scroll context, without waiting for the scroll keep alive to timeout.
SearchClient	getClient(String clientName)	Internal: Gets a given search client.
String	getDefaultRepositoryName()	Gets the default repository name.
SearchIndex	getDefaultSearchIndexForRepository(String repository)	Gets the default SearchIndex for a given repository.
Set<String>	getRepositoryNames()	Gets the set of repository names.
List<SearchIndex>	getSearchIndexForRepository(String repository)	Gets the list of SearchIndex for a given repository.
BulkIndexingResponse	indexDocuments(BulkIndexingRequest request)	Internal: index documents.
protected void	initIndexes(SearchClient client, List<SearchIndexDescriptor> indexes)
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 an index so newly indexed documents are searchable.
String	reindexDocuments(String repository, String nxql)	Internal: reindex documents of the given repository according to the given NXQL query.
String	reindexRepository(String repository)	Internal: reindex the repository
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.SearchService

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

repoToDefaultSearchIndex

protected final Map<String,SearchIndex> repoToDefaultSearchIndex

repoToSearchIndexes

protected final Map<String,List<SearchIndex>> repoToSearchIndexes

indexToJsonWriter

protected final Map<SearchIndex,IndexingJsonWriter> indexToJsonWriter

defaultRepository

protected final String defaultRepository

Constructor Details

SearchServiceImpl

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

Method Details

initIndexes

protected void initIndexes(SearchClient client,
 List<SearchIndexDescriptor> indexes)

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

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(session, "SELECT * FROM Document").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: index documents.

Specified by:

indexDocuments in interface SearchIndexingService

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: reindex the repository

Specified by:

reindexRepository in interface SearchIndexingService

Returns:

the bulk command id in charge of reindexing

reindexDocuments

public String reindexDocuments(String repository,
 String nxql)

Description copied from interface: SearchIndexingService

Internal: reindex documents of the given repository according to the given NXQL query.

Specified by:

reindexDocuments in interface SearchIndexingService

Returns:

the bulk command id in charge of reindexing

refresh

public void refresh(SearchIndex index)

Description copied from interface: SearchIndexingService

Refreshes an index so newly indexed documents are searchable.

Specified by:

refresh in interface SearchIndexingService

getClient

public SearchClient getClient(String clientName)

Description copied from interface: SearchIndexingService

Internal: Gets a given search client.

Specified by:

getClient in interface SearchIndexingService

await

public boolean await(Duration duration)
              throws InterruptedException

Description copied from interface: SearchIndexingService

Waits for completion of indexing activity for testing purpose only.

Specified by:

await in interface SearchIndexingService

Parameters:

duration - the duration to wait

Returns:

true if all indexing processing completed or false if one or more has not finished after the timeout

Throws:

InterruptedException