Package org.nuxeo.ecm.restapi.server.search

Class SearchObject

java.lang.Object

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

org.nuxeo.ecm.restapi.server.search.QueryExecutor

org.nuxeo.ecm.restapi.server.search.SearchObject

All Implemented Interfaces:

Resource, Adaptable

public class SearchObject
extends QueryExecutor

Since:

8.3 Search endpoint to perform queries via rest api, with support to save and execute saved search queries.

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.ecm.restapi.server.search.QueryExecutor

QueryExecutor.LangParams, QueryExecutor.QueryParams

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PAGE_PROVIDER_NAME_PARAM
static final String	SAVED_SEARCHES_PAGE_PROVIDER
static final String	SAVED_SEARCHES_PAGE_PROVIDER_PARAMS
protected SavedSearchService	savedSearchService

Fields inherited from class org.nuxeo.ecm.restapi.server.search.QueryExecutor

CURRENT_PAGE_INDEX, CURRENT_PAGE_OFFSET, CURRENT_REPO_PATTERN, CURRENT_USERID_PATTERN, HIGHLIGHT, MAX_RESULTS, NXQL, ORDERED_PARAMS, PAGE_SIZE, pageProviderService, QUERY, QUERY_LIMIT_PARAM, QUICK_FILTERS, SCROLL_PARAM, skipAggregates, SORT_BY, SORT_ORDER

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
Object	doBulkActionByLang(jakarta.ws.rs.core.UriInfo uriInfo)
Object	doBulkActionByPageProvider(String pageProviderName, jakarta.ws.rs.core.UriInfo uriInfo)
Object	doBulkActionBySavedSearch(String id, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	doDeleteSavedSearch(String id)
jakarta.ws.rs.core.Response	doExecuteSavedSearch(String id, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	doGetPageProviderDefinition(String pageProviderName)
jakarta.ws.rs.core.Response	doGetSavedSearch(String id)
List<SavedSearch>	doGetSavedSearches(jakarta.ws.rs.core.UriInfo uriInfo)
DocumentModelList	doQueryByLang(jakarta.ws.rs.core.UriInfo uriInfo)
DocumentModelList	doQueryByPageProvider(jakarta.ws.rs.core.UriInfo uriInfo, String pageProviderName)
jakarta.ws.rs.core.Response	doSaveSearch(SavedSearchRequest request)
jakarta.ws.rs.core.Response	doUpdateSavedSearch(SavedSearchRequest request, String id)
protected DocumentModelList	executeSavedSearch(SavedSearch search, jakarta.ws.rs.core.MultivaluedMap<String,String> params)
protected PageProvider<?>	getPageProvider(String providerName, jakarta.ws.rs.core.MultivaluedMap<String,String> parameters)	Retrieves the page provider from the given page provider name and/or parameters.
protected String	getQueryString(String providerName, jakarta.ws.rs.core.MultivaluedMap<String,String> parameters)	Retrieves the query string from the given page provider name and/or parameters.
protected String	getQueryString(PageProvider<?> pageProvider)	Retrieves the query string from the given page provider.
void	initialize(Object... args)
protected DocumentModelList	querySavedSearchByLang(String query, Long pageSize, Long currentPageIndex, Long currentPageOffset, Long maxResults, String orderedParams, Map<String,String> namedParameters, List<SortInfo> sortInfo)
protected DocumentModelList	querySavedSearchByPageProvider(String pageProviderName, Long pageSize, Long currentPageIndex, Long currentPageOffset, String orderedParams, Map<String,String> namedParameters, List<SortInfo> sortInfo, List<QuickFilter> quickFilters, DocumentModel searchDocumentModel)
protected void	setSaveSearchParams(Map<String,String> params, SavedSearch search)

Methods inherited from class org.nuxeo.ecm.restapi.server.search.QueryExecutor

asStringList, buildResponse, getCurrentPageIndex, getCurrentPageOffset, getHighlights, getMaxResults, getNamedParameters, getNamedParameters, getPageProviderDefinition, getPageSize, getParameters, getProperties, getQuery, getQuickFilters, getSortInfo, getSortInfo, handleNamedParamVars, initExecutor, queryByLang, queryByLang, queryByLang, queryByPageProvider, queryByPageProvider, queryByPageProvider, replaceParameterPattern

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, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Field Details

SAVED_SEARCHES_PAGE_PROVIDER

public static final String SAVED_SEARCHES_PAGE_PROVIDER

See Also:

• Constant Field Values

SAVED_SEARCHES_PAGE_PROVIDER_PARAMS

public static final String SAVED_SEARCHES_PAGE_PROVIDER_PARAMS

See Also:

• Constant Field Values

PAGE_PROVIDER_NAME_PARAM

public static final String PAGE_PROVIDER_NAME_PARAM

See Also:

• Constant Field Values

savedSearchService

protected SavedSearchService savedSearchService

Constructor Details

SearchObject

public SearchObject()

Method Details

initialize

public void initialize(Object... args)

Overrides:

initialize in class AbstractResource<ResourceTypeImpl>

doQueryByLang

@GET
@Path("execute")
public DocumentModelList doQueryByLang(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Since:

10.3

doBulkActionByLang

@Path("bulk")
public Object doBulkActionByLang(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Since:

10.3

doQueryByPageProvider

@GET
@Path("pp/{pageProviderName}/execute")
public DocumentModelList doQueryByPageProvider(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("pageProviderName")
 String pageProviderName)

doGetPageProviderDefinition

@GET
@Path("pp/{pageProviderName}")
public jakarta.ws.rs.core.Response doGetPageProviderDefinition(@PathParam("pageProviderName")
 String pageProviderName)
                                                        throws IOException

Throws:

IOException

doBulkActionByPageProvider

@Path("pp/{pageProviderName}/bulk")
public Object doBulkActionByPageProvider(@PathParam("pageProviderName")
 String pageProviderName,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

doGetSavedSearches

@GET
@Path("saved")
public List<SavedSearch> doGetSavedSearches(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

doSaveSearch

@POST
@Path("saved")
@Consumes("application/json")
public jakarta.ws.rs.core.Response doSaveSearch(SavedSearchRequest request)

doGetSavedSearch

@GET
@Path("saved/{id}")
public jakarta.ws.rs.core.Response doGetSavedSearch(@PathParam("id")
 String id)

doBulkActionBySavedSearch

@Path("saved/{id}/bulk")
public Object doBulkActionBySavedSearch(@PathParam("id")
 String id,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

doUpdateSavedSearch

@PUT
@Path("saved/{id}")
@Consumes("application/json")
public jakarta.ws.rs.core.Response doUpdateSavedSearch(SavedSearchRequest request,
 @PathParam("id")
 String id)

doDeleteSavedSearch

@DELETE
@Path("saved/{id}")
public jakarta.ws.rs.core.Response doDeleteSavedSearch(@PathParam("id")
 String id)

doExecuteSavedSearch

@GET
@Path("saved/{id}/execute")
public jakarta.ws.rs.core.Response doExecuteSavedSearch(@PathParam("id")
 String id,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

setSaveSearchParams

protected void setSaveSearchParams(Map<String,String> params,
 SavedSearch search)
                            throws IOException

Throws:

IOException

executeSavedSearch

protected DocumentModelList executeSavedSearch(SavedSearch search,
 jakarta.ws.rs.core.MultivaluedMap<String,String> params)

querySavedSearchByLang

protected DocumentModelList querySavedSearchByLang(String query,
 Long pageSize,
 Long currentPageIndex,
 Long currentPageOffset,
 Long maxResults,
 String orderedParams,
 Map<String,String> namedParameters,
 List<SortInfo> sortInfo)

querySavedSearchByPageProvider

protected DocumentModelList querySavedSearchByPageProvider(String pageProviderName,
 Long pageSize,
 Long currentPageIndex,
 Long currentPageOffset,
 String orderedParams,
 Map<String,String> namedParameters,
 List<SortInfo> sortInfo,
 List<QuickFilter> quickFilters,
 DocumentModel searchDocumentModel)

getPageProvider

protected PageProvider<?> getPageProvider(String providerName,
 jakarta.ws.rs.core.MultivaluedMap<String,String> parameters)

Retrieves the page provider from the given page provider name and/or parameters.

Since:

2021.8

getQueryString

protected String getQueryString(String providerName,
 jakarta.ws.rs.core.MultivaluedMap<String,String> parameters)

Retrieves the query string from the given page provider name and/or parameters.

getQueryString

protected String getQueryString(PageProvider<?> pageProvider)

Retrieves the query string from the given page provider.

Since:

2021.8