Package org.nuxeo.ecm.core.search.client.opensearch1

Class OpenSearchSearchClient

java.lang.Object

org.nuxeo.ecm.core.search.AbstractSearchClient

org.nuxeo.ecm.core.search.client.opensearch1.OpenSearchSearchClient

All Implemented Interfaces:

AutoCloseable, SearchClient

public class OpenSearchSearchClient
extends AbstractSearchClient

Since:

2025.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.search.SearchClient

SearchClient.Capability

Field Summary

Fields

Modifier and Type	Field	Description
protected final OpenSearchClient	client
static final String	ECM_ANCESTOR_FIELDS
protected final Map<String,String>	indexes
protected final OpenSearchQueryTransformer	queryTransformer
protected final OpenSearchResponseTransformer	responseTransformer

Fields inherited from class org.nuxeo.ecm.core.search.AbstractSearchClient

name

Fields inherited from interface org.nuxeo.ecm.core.search.SearchClient

DEFAULT_CLIENT_NAME_PROP

Constructor Summary

Constructors

Constructor	Description
OpenSearchSearchClient(OpenSearchSearchClientDescriptor descriptor, Map<String,OpenSearchHintQueryBuilder> hints)

Method Summary

Modifier and Type	Method	Description
boolean	clearScroll(SearchScrollContext scrollContext)	Explicitly clear the search scroll context, without waiting for the scroll keep alive to timeout.
void	close()
protected void	doRecurseDelete(String indexName, org.opensearch.index.query.QueryBuilder queryBuilder)
void	dropAndInitIndex(String indexName)	Recreate an existing index using the same settings and mapping.
void	dropIndex(String name)	Drops an index.
String	getDocument(String indexName, String documentId)	Returns a Json document representation or null if not found.
Long	getDocumentVersion(String indexName, String documentId)	Returns the version which is the timestamp when document was loaded for indexing
Map<String,String>	getTechnicalIndexes()
boolean	hasCapability(SearchClient.Capability capability)	Checks whether the client has the capability.
BulkIndexingResponse	indexDocuments(BulkIndexingRequest request)	Index documents.
boolean	isReady()	Is the client ready and the search engine healthy to serve requests.
void	refresh(String indexName)	Refreshes an index so newly indexed documents are searchable.
SearchResponse	search(SearchQuery query)	Executes a search query.
SearchResponse	searchScroll(SearchScrollContext scrollContext)	Iterate on results for a scroll search.
String	toString()

Methods inherited from class org.nuxeo.ecm.core.search.AbstractSearchClient

getCapabilities, getName

Methods inherited from class java.lang.Object

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

Field Details

ECM_ANCESTOR_FIELDS

public static final String ECM_ANCESTOR_FIELDS

See Also:

• Constant Field Values

responseTransformer

protected final OpenSearchResponseTransformer responseTransformer

client

protected final OpenSearchClient client

indexes

protected final Map<String,String> indexes

queryTransformer

protected final OpenSearchQueryTransformer queryTransformer

Constructor Details

OpenSearchSearchClient

public OpenSearchSearchClient(OpenSearchSearchClientDescriptor descriptor,
 Map<String,OpenSearchHintQueryBuilder> hints)

Method Details

isReady

public boolean isReady()

Description copied from interface: SearchClient

Is the client ready and the search engine healthy to serve requests.

hasCapability

public boolean hasCapability(SearchClient.Capability capability)

Description copied from interface: SearchClient

Checks whether the client has the capability.

dropIndex

public void dropIndex(String name)

Description copied from interface: SearchClient

Drops an index.

dropAndInitIndex

public void dropAndInitIndex(String indexName)

Description copied from interface: SearchClient

Recreate an existing index using the same settings and mapping.

indexDocuments

public BulkIndexingResponse indexDocuments(BulkIndexingRequest request)

Description copied from interface: SearchClient

Index documents. Check the response for possible indexing failure.

refresh

public void refresh(String indexName)

Description copied from interface: SearchClient

Refreshes an index so newly indexed documents are searchable.

doRecurseDelete

protected void doRecurseDelete(String indexName,
 org.opensearch.index.query.QueryBuilder queryBuilder)

getDocument

public String getDocument(String indexName,
 String documentId)

Description copied from interface: SearchClient

Returns a Json document representation or null if not found.

getDocumentVersion

public Long getDocumentVersion(String indexName,
 String documentId)

Description copied from interface: SearchClient

Returns the version which is the timestamp when document was loaded for indexing

search

public SearchResponse search(SearchQuery query)

Description copied from interface: SearchClient

Executes a search query.

searchScroll

public SearchResponse searchScroll(SearchScrollContext scrollContext)

Description copied from interface: SearchClient

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.

Parameters:

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

clearScroll

public boolean clearScroll(SearchScrollContext scrollContext)

Description copied from interface: SearchClient

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

Returns:

true if the context is successfully cleared.

close

public void close()

getTechnicalIndexes

public Map<String,String> getTechnicalIndexes()

toString

public String toString()

Overrides:

toString in class Object