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

Class QueryObject

java.lang.Object

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

org.nuxeo.ecm.restapi.server.jaxrs.QueryObject

All Implemented Interfaces:

Resource, Adaptable

public class QueryObject
extends AbstractResource<ResourceTypeImpl>

Since:

6.0 Search endpoint to perform queries on the repository through rest api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueryObject.LangParams
static enum	QueryObject.QueryParams

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CURRENT_PAGE_INDEX
static final String	CURRENT_REPO_PATTERN	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use PageProviderSpec.CURRENT_REPOSITORY_PARAMETER_VALUE instead
static final String	CURRENT_USERID_PATTERN	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use PageProviderSpec.CURRENT_USER_PARAMETER_VALUE instead
protected EnumMap<QueryObject.LangParams,String>	langPathMap
static final String	MAX_RESULTS
static final String	NXQL
static final String	ORDERED_PARAMS
static final String	PAGE_SIZE
protected PageProviderService	pageProviderService
static final String	PATH
static final String	QUERY
protected EnumMap<QueryObject.QueryParams,String>	queryParametersMap
static final String	QUICK_FILTERS
static final String	SORT_BY
static final String	SORT_ORDER

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

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor	Description
QueryObject()

Method Summary

Modifier and Type	Method	Description
Object	doQuery(javax.ws.rs.core.UriInfo uriInfo)	Perform query on the repository.
Object	doSpecificQuery(javax.ws.rs.core.UriInfo uriInfo, String langOrProviderName)	Perform query on the repository in NXQL or specific pageprovider name
protected DocumentModelList	getQuery(javax.ws.rs.core.UriInfo uriInfo, String langOrProviderName)
protected DocumentModel	getSearchDocumentModel(CoreSession session, PageProviderService pps, String providerName, Properties namedParameters)	Deprecated. since 11.1, use PageProviderHelper.getSearchDocumentModel(CoreSession, PageProviderService, String, Map) instead
void	initialize(Object... args)

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, isAdapter, isInstanceOf, isRoot, newAdapter, newObject, newObject, redirect, retrieveWebObjectType, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Field Details

PATH

public static final String PATH

See Also:

• Constant Field Values

NXQL

public static final String NXQL

See Also:

• Constant Field Values

QUERY

public static final String QUERY

See Also:

• Constant Field Values

PAGE_SIZE

public static final String PAGE_SIZE

See Also:

• Constant Field Values

CURRENT_PAGE_INDEX

public static final String CURRENT_PAGE_INDEX

See Also:

• Constant Field Values

MAX_RESULTS

public static final String MAX_RESULTS

See Also:

• Constant Field Values

SORT_BY

public static final String SORT_BY

See Also:

• Constant Field Values

SORT_ORDER

public static final String SORT_ORDER

See Also:

• Constant Field Values

ORDERED_PARAMS

public static final String ORDERED_PARAMS

See Also:

• Constant Field Values

CURRENT_USERID_PATTERN

@Deprecated(since="2025.20",
            forRemoval=true)
public static final String CURRENT_USERID_PATTERN

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

since 2025.20, use PageProviderSpec.CURRENT_USER_PARAMETER_VALUE instead

See Also:

• Constant Field Values

CURRENT_REPO_PATTERN

@Deprecated(since="2025.20",
            forRemoval=true)
public static final String CURRENT_REPO_PATTERN

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

since 2025.20, use PageProviderSpec.CURRENT_REPOSITORY_PARAMETER_VALUE instead

See Also:

• Constant Field Values

QUICK_FILTERS

public static final String QUICK_FILTERS

Since:

8.4

See Also:

• Constant Field Values

queryParametersMap

protected EnumMap<QueryObject.QueryParams,String> queryParametersMap

langPathMap

protected EnumMap<QueryObject.LangParams,String> langPathMap

pageProviderService

protected PageProviderService pageProviderService

Constructor Details

QueryObject

public QueryObject()

Method Details

initialize

public void initialize(Object... args)

Overrides:

initialize in class AbstractResource<ResourceTypeImpl>

getQuery

protected DocumentModelList getQuery(javax.ws.rs.core.UriInfo uriInfo,
 String langOrProviderName)

getSearchDocumentModel

@Deprecated(since="11.1")
protected DocumentModel getSearchDocumentModel(CoreSession session,
 PageProviderService pps,
 String providerName,
 Properties namedParameters)

Deprecated.

since 11.1, use PageProviderHelper.getSearchDocumentModel(CoreSession, PageProviderService, String, Map) instead

doQuery

public Object doQuery(@Context
 javax.ws.rs.core.UriInfo uriInfo)

Perform query on the repository. By default in NXQL.

Parameters:

uriInfo - Query parameters

Returns:

Document Listing

doSpecificQuery

public Object doSpecificQuery(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 String langOrProviderName)

Perform query on the repository in NXQL or specific pageprovider name

Parameters:

uriInfo - Query parameters

langOrProviderName - NXQL or specific provider name

Returns:

Document Listing