Package org.nuxeo.ecm.restapi.server.jaxrs.management

Class ElasticsearchObject

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.restapi.server.jaxrs.management.ElasticsearchObject

All Implemented Interfaces:

Resource, Adaptable

public class ElasticsearchObject
extends AbstractResource<ResourceTypeImpl>

Endpoint to manage Elasticsearch.

Since:

11.3

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DEFAULT_CHECK_SEARCH_NXQL
protected static final Long	DEFAULT_CHECK_SEARCH_PAGE_SIZE
static final String	GET_ALL_DOCUMENTS_QUERY
protected static final com.fasterxml.jackson.databind.ObjectMapper	MAPPER

Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor	Description
ElasticsearchObject()

Method Summary

Modifier and Type	Method	Description
String	checkSearch(String nxql, Long pageSize)	Check discrepancies between elastic and repository search.
void	doFlush()	Executes an ES flush on document index of a given repository.
BulkStatus	doIndexing(String query, Long queryLimit)	Performs an ES indexing on documents matching the optional NXQL query.
BulkStatus	doIndexingOnDocument(String documentId, Long queryLimit)	Performs an ES indexing on the given document and his children.
void	doOptimize()	Executes an ES optimize on document index of a given repository.
protected Map<String,Serializable>	extractResultInfo(String ppName, String nxql, long pageSize)
protected BulkStatus	performIndexing(String query)	Deprecated, for removal: This API element is subject to removal in a future version. since 2023.36 use performIndexing(String, long) instead
protected BulkStatus	performIndexing(String query, long queryLimit)	Performs an ES indexing on documents matching the optional NXQL query.

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, initialize, isAdapter, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Field Details

GET_ALL_DOCUMENTS_QUERY

public static final String GET_ALL_DOCUMENTS_QUERY

See Also:

• Constant Field Values

MAPPER

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

DEFAULT_CHECK_SEARCH_NXQL

protected static final String DEFAULT_CHECK_SEARCH_NXQL

See Also:

• Constant Field Values

DEFAULT_CHECK_SEARCH_PAGE_SIZE

protected static final Long DEFAULT_CHECK_SEARCH_PAGE_SIZE

Constructor Details

ElasticsearchObject

public ElasticsearchObject()

Method Details

doIndexing

public BulkStatus doIndexing(String query,
 Long queryLimit)

Performs an ES indexing on documents matching the optional NXQL query.

See Also:

• performIndexing(String)

doIndexingOnDocument

public BulkStatus doIndexingOnDocument(String documentId,
 Long queryLimit)

Performs an ES indexing on the given document and his children.

Parameters:

documentId - the id of the document that will be indexed and his children recursively

See Also:

• performIndexing(String)

doFlush

public void doFlush()

Executes an ES flush on document index of a given repository.

doOptimize

public void doOptimize()

Executes an ES optimize on document index of a given repository.

checkSearch

public String checkSearch(String nxql,
 Long pageSize)

Check discrepancies between elastic and repository search.

Since:

2023.7

extractResultInfo

protected Map<String,Serializable> extractResultInfo(String ppName,
 String nxql,
 long pageSize)

performIndexing

@Deprecated(since="2023.36",
            forRemoval=true)
protected BulkStatus performIndexing(String query)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2023.36 use performIndexing(String, long) instead

performIndexing

protected BulkStatus performIndexing(String query,
 long queryLimit)

Performs an ES indexing on documents matching the optional NXQL query.

Parameters:

query - the NXQL query that documents must match to be indexed, can be null or empty, in this case all documents of the given repository will be indexed GET_ALL_DOCUMENTS_QUERY

queryLimit - the limit of documents to index, -1 for no limit, not taken into account for full reindex

Returns:

the BulkStatus of the ES indexing

Since:

2023.36