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

Class SearchObject

java.lang.Object

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

org.nuxeo.ecm.restapi.server.management.SearchObject

All Implemented Interfaces:

Resource, Adaptable

@Produces("application/json")
public class SearchObject
extends AbstractResource<ResourceTypeImpl>

Since:

2025.0

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CHECK_SEARCH_NXQL_PP
protected static final String	DEFAULT_CHECK_SEARCH_NXQL
protected static final Long	DEFAULT_CHECK_SEARCH_PAGE_SIZE
protected static final Integer	DEFAULT_TIMEOUT_SECONDS
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
SearchObject()

Method Summary

Modifier and Type	Method	Description
String	checkSearch(String nxql, Long pageSize)	Check discrepancies between search indexes.
protected Duration	computeRemainingDuration(long timeout, long start)
BulkStatus	doIndexing(String query, Long queryLimit)	Performs indexing on documents matching the optional NXQL query on the default repository.
BulkStatus	doIndexingOnDocument(String documentId, Long queryLimit)	Performs indexing on the given document and its children.
void	doRefresh()	Executes a refresh on document index of a given repository.
void	doWait(boolean waitForAudit, boolean waitForBulkService, boolean refresh, Integer timeoutSecond)	Wait for indexing and other services only for testing purpose.
protected Map<String,Serializable>	extractResultInfo(SearchIndex searchIndex, String nxql, long pageSize)
protected BulkStatus	performIndexing(String query)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.8 use performIndexing(String, long) instead
protected BulkStatus	performIndexing(String query, long queryLimit)	Performs 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

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

CHECK_SEARCH_NXQL_PP

protected static final String CHECK_SEARCH_NXQL_PP

See Also:

• Constant Field Values

DEFAULT_TIMEOUT_SECONDS

protected static final Integer DEFAULT_TIMEOUT_SECONDS

Constructor Details

SearchObject

public SearchObject()

Method Details

doIndexing

@POST
@Path("reindex")
public BulkStatus doIndexing(@QueryParam("query")
 String query,
 @QueryParam("queryLimit") @DefaultValue("-1")
 Long queryLimit)

Performs indexing on documents matching the optional NXQL query on the default repository. An empty query means reindex all using a new index.

doIndexingOnDocument

@POST
@Path("{documentId}/reindex")
public BulkStatus doIndexingOnDocument(@PathParam("documentId")
 String documentId,
 @QueryParam("queryLimit") @DefaultValue("-1")
 Long queryLimit)

Performs indexing on the given document and its children.

Parameters:

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

doRefresh

@POST
@Path("refresh")
public void doRefresh()

Executes a refresh on document index of a given repository.

performIndexing

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

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

since 2025.8 use performIndexing(String, long) instead

performIndexing

protected BulkStatus performIndexing(String query,
 long queryLimit)

Performs indexing on documents matching the optional NXQL query.

checkSearch

@GET
@Path("checkSearch")
public String checkSearch(@QueryParam("nxql")
 String nxql,
 @QueryParam("pageSize")
 Long pageSize)

Check discrepancies between search indexes.

extractResultInfo

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

doWait

@POST
@Path("wait")
public void doWait(@QueryParam("waitForAudit")
 boolean waitForAudit,
 @QueryParam("waitForBulkService")
 boolean waitForBulkService,
 @QueryParam("refresh")
 boolean refresh,
 @QueryParam("timeoutSecond")
 Integer timeoutSecond)

Wait for indexing and other services only for testing purpose. Returns no content (204) on success, timeout (408) or errors (50x)

computeRemainingDuration

protected Duration computeRemainingDuration(long timeout,
 long start)