Merged RETURN-OF-THE-API (5.2.0) to 5.2.N (5.2.1)

129004 adavis: REPO-243 People Live Search
      - First cut of this code
      - Includes a re-factor of the code used by GET /queries/live-search-nodes as there is much in common.
      - Still have some tests to write and there are bound to be comments from the review.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@129187 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Martin Muller
2016-08-05 13:49:15 +00:00
parent 15f33e6130
commit 83e9fdf964
10 changed files with 906 additions and 235 deletions

View File

@@ -26,31 +26,56 @@
package org.alfresco.rest.api;
import org.alfresco.model.ContentModel;
import org.alfresco.rest.api.model.Node;
import org.alfresco.rest.api.model.Person;
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
import org.alfresco.rest.framework.resource.parameters.Parameters;
import org.alfresco.rest.framework.webscripts.ResourceWebScriptHelper;
/**
* Queries API
*
* @author janv
* @author Alan Davis
*/
public interface Queries
{
// General
static String PARAM_TERM = "term";
static String PARAM_ORDERBY = ResourceWebScriptHelper.PARAM_ORDERBY;
static String PARAM_FIELDS = ResourceWebScriptHelper.PARAM_FILTER_FIELDS;
static String PARAM_INCLUDE = ResourceWebScriptHelper.PARAM_INCLUDE;
// Node query
static String PARAM_ROOT_NODE_ID = "rootNodeId";
static String PARAM_NODE_TYPE = "nodeType";
static String PARAM_NAME = "name";
static String PARAM_CREATEDAT = "createdAt";
static String PARAM_MODIFIEDAT = "modifiedAt";
static int MIN_TERM_LENGTH_NODES = 3;
// People query
static String PARAM_USERNAME = ContentModel.PROP_USERNAME.getLocalName();
static String PARAM_FIRSTNAME = ContentModel.PROP_FIRSTNAME.getLocalName();
static String PARAM_LASTNAME = ContentModel.PROP_LASTNAME.getLocalName();
static int MIN_TERM_LENGTH_PEOPLE = 2;
/**
* Find Nodes
*
* @param queryId currently expects "live-search-nodes"
* @param parameters the {@link Parameters} object to get the parameters passed into the request
*
* @return the search query results
*/
CollectionWithPagingInfo<Node> findNodes(String queryId, Parameters parameters);
CollectionWithPagingInfo<Node> findNodes(Parameters parameters);
String PARAM_TERM = "term";
String PARAM_ROOT_NODE_ID = "rootNodeId";
String PARAM_NODE_TYPE = "nodeType";
String PARAM_NAME = "name";
String PARAM_CREATEDAT = "createdAt";
String PARAM_MODIFIEDAT = "modifiedAt";
/**
* Find People
*
* @param parameters the {@link Parameters} object to get the parameters passed into the request
*
* @return the search query results
*/
CollectionWithPagingInfo<Person> findPeople(Parameters parameters);
}

View File

@@ -26,15 +26,30 @@
package org.alfresco.rest.api.impl;
import static org.alfresco.rest.api.impl.QueriesImpl.AbstractQuery.Sort.IN_QUERY_SORT;
import static org.alfresco.rest.api.impl.QueriesImpl.AbstractQuery.Sort.POST_QUERY_SORT;
import java.io.Serializable;
import java.text.Collator;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.alfresco.model.ContentModel;
import org.alfresco.query.PagingRequest;
import org.alfresco.rest.api.Nodes;
import org.alfresco.rest.api.People;
import org.alfresco.rest.api.Queries;
import org.alfresco.rest.api.model.Node;
import org.alfresco.rest.api.model.Person;
import org.alfresco.rest.api.model.UserInfo;
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
import org.alfresco.rest.framework.core.exceptions.NotFoundException;
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
import org.alfresco.rest.framework.resource.parameters.Paging;
import org.alfresco.rest.framework.resource.parameters.Parameters;
@@ -46,8 +61,8 @@ import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.Path;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.search.PermissionEvaluationMode;
import org.alfresco.service.cmr.search.ResultSet;
import org.alfresco.service.cmr.search.ResultSetRow;
import org.alfresco.service.cmr.search.SearchParameters;
import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.namespace.NamespaceService;
@@ -55,68 +70,78 @@ import org.alfresco.service.namespace.QName;
import org.alfresco.util.ISO9075;
import org.alfresco.util.ParameterCheck;
import org.springframework.beans.factory.InitializingBean;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.springframework.extensions.surf.util.I18NUtil;
/**
* Queries implementation
*
* @author janv
* @author Alan Davis
*/
public class QueriesImpl implements Queries, InitializingBean
{
private final static Map<String,QName> NODE_SORT_PARAMS_TO_QNAMES = sortParamsToQNames(
PARAM_NAME, ContentModel.PROP_NAME,
PARAM_CREATEDAT, ContentModel.PROP_CREATED,
PARAM_MODIFIEDAT, ContentModel.PROP_MODIFIED);
private final static Map<String, QName> PEOPLE_SORT_PARAMS_TO_QNAMES = sortParamsToQNames(
ContentModel.PROP_USERNAME,
ContentModel.PROP_FIRSTNAME,
ContentModel.PROP_LASTNAME);
/**
* Helper method to build a map of sort parameter names to QNames. This method iterates through
* the parameters. If a parameter is a String it is assumed to be a sort parameter name and will
* be followed by a QName to which it maps. If however it is a QName the local name of the OName
* is used as the sort parameter name.
* @param parameters to build up the map.
* @return the map
*/
private static Map<String, QName> sortParamsToQNames(Object... parameters)
{
Map<String, QName> map = new HashMap<>();
for (int i=0; i<parameters.length; i++)
{
map.put(
parameters[i] instanceof String
? (String)parameters[i++]
: ((QName)parameters[i]).getLocalName(),
(QName)parameters[i]);
}
return Collections.unmodifiableMap(map);
}
private ServiceRegistry sr;
private SearchService searchService;
private NodeService nodeService;
private NamespaceService namespaceService;
private DictionaryService dictionaryService;
private final static String QT_FIELD = "keywords";
private final static String QUERY_LIVE_SEARCH_NODES = "live-search-nodes";
private static int TERM_MIN_LEN = 3;
private final static Map<String,QName> MAP_PARAM_SORT_QNAME;
static
{
Map<String,QName> aMap = new HashMap<>(3);
aMap.put(PARAM_NAME, ContentModel.PROP_NAME);
aMap.put(PARAM_CREATEDAT, ContentModel.PROP_CREATED);
aMap.put(PARAM_MODIFIEDAT, ContentModel.PROP_MODIFIED);
MAP_PARAM_SORT_QNAME = Collections.unmodifiableMap(aMap);
}
private Nodes nodes;
private People people;
public void setServiceRegistry(ServiceRegistry sr)
{
this.sr = sr;
}
public void setTermMinLength(int termMinLength)
{
TERM_MIN_LEN = termMinLength;
}
public void setNodes(Nodes nodes)
{
this.nodes = nodes;
}
public void setPeople(People people)
{
this.people = people;
}
@Override
public void afterPropertiesSet()
{
ParameterCheck.mandatory("sr", this.sr);
ParameterCheck.mandatory("nodes", this.nodes);
ParameterCheck.mandatory("people", this.people);
this.searchService = sr.getSearchService();
this.nodeService = sr.getNodeService();
@@ -125,100 +150,287 @@ public class QueriesImpl implements Queries, InitializingBean
}
@Override
public CollectionWithPagingInfo<Node> findNodes(String queryId, Parameters parameters)
public CollectionWithPagingInfo<Node> findNodes(Parameters parameters)
{
if (! QUERY_LIVE_SEARCH_NODES.equals(queryId))
return new AbstractQuery<Node>(nodeService, searchService)
{
throw new NotFoundException(queryId);
}
StringBuilder sb = new StringBuilder();
String term = parameters.getParameter(PARAM_TERM);
if (term == null)
{
throw new InvalidArgumentException("Query 'term' not specified");
}
else
{
String s = term.trim();
int cnt = 0;
for (int i = 0; i < s.length(); i++)
private final Map<String, UserInfo> mapUserInfo = new HashMap<>(10);
@Override
protected void buildQuery(StringBuilder query, String term, SearchParameters sp, String queryTemplateName)
{
char c = s.charAt(i);
sp.addQueryTemplate(queryTemplateName, "%(cm:name cm:title cm:description TEXT TAG)");
String rootNodeId = parameters.getParameter(PARAM_ROOT_NODE_ID);
if (rootNodeId != null)
{
NodeRef nodeRef = nodes.validateOrLookupNode(rootNodeId, null);
query.append("PATH:\"").append(getQNamePath(nodeRef.getId())).append("//*\" AND (");
}
query.append(term);
if (rootNodeId != null)
{
query.append(")");
}
String nodeTypeStr = parameters.getParameter(PARAM_NODE_TYPE);
if (nodeTypeStr != null)
{
QName filterNodeTypeQName = nodes.createQName(nodeTypeStr);
if (dictionaryService.getType(filterNodeTypeQName) == null)
{
throw new InvalidArgumentException("Unknown filter nodeType: "+nodeTypeStr);
}
query.append(" AND (+TYPE:\"").append(nodeTypeStr).append(("\")"));
query.append(" AND -ASPECT:\"sys:hidden\" AND -cm:creator:system AND -QNAME:comment\\-* ");
}
else
{
query.append(" AND (+TYPE:\"cm:content\" OR +TYPE:\"cm:folder\")");
query.append(" AND -TYPE:\"cm:thumbnail\" AND -TYPE:\"cm:failedThumbnail\" AND -TYPE:\"cm:rating\" AND -TYPE:\"fm:post\"");
query.append(" AND -TYPE:\"st:site\" AND -ASPECT:\"st:siteContainer\"");
query.append(" AND -ASPECT:\"sys:hidden\" AND -cm:creator:system AND -QNAME:comment\\-* ");
}
}
private String getQNamePath(String nodeId)
{
NodeRef nodeRef = new NodeRef(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE, nodeId);
Map<String, String> cache = new HashMap<>();
StringBuilder buf = new StringBuilder(128);
Path path = null;
try
{
path = nodeService.getPath(nodeRef);
}
catch (InvalidNodeRefException inre)
{
throw new EntityNotFoundException(nodeId);
}
for (Path.Element e : path)
{
if (e instanceof Path.ChildAssocElement)
{
QName qname = ((Path.ChildAssocElement) e).getRef().getQName();
if (qname != null)
{
String prefix = cache.get(qname.getNamespaceURI());
if (prefix == null)
{
// first request for this namespace prefix, get and cache result
Collection<String> prefixes = namespaceService.getPrefixes(qname.getNamespaceURI());
prefix = prefixes.size() != 0 ? prefixes.iterator().next() : "";
cache.put(qname.getNamespaceURI(), prefix);
}
buf.append('/').append(prefix).append(':').append(ISO9075.encode(qname.getLocalName()));
}
}
else
{
buf.append('/').append(e.toString());
}
}
return buf.toString();
}
@Override
protected List<Node> newList(int capacity)
{
return new ArrayList<Node>(capacity);
}
@Override
protected Node convert(NodeRef nodeRef, List<String> includeParam)
{
return nodes.getFolderOrDocument(nodeRef, null, null, includeParam, mapUserInfo);
}
}.find(parameters, PARAM_TERM, MIN_TERM_LENGTH_NODES, "keywords",
IN_QUERY_SORT, NODE_SORT_PARAMS_TO_QNAMES,
new SortColumn(PARAM_MODIFIEDAT, false));
}
@Override
public CollectionWithPagingInfo<Person> findPeople(Parameters parameters)
{
return new AbstractQuery<Person>(nodeService, searchService)
{
@Override
protected void buildQuery(StringBuilder query, String term, SearchParameters sp, String queryTemplateName)
{
sp.addQueryTemplate(queryTemplateName, "|%firstName OR |%lastName OR |%userName");
sp.setExcludeTenantFilter(false);
sp.setPermissionEvaluation(PermissionEvaluationMode.EAGER);
query.append("TYPE:\"").append(ContentModel.TYPE_PERSON).append("\" AND (\"*");
query.append(term);
query.append("*\")");
}
@Override
protected List<Person> newList(int capacity)
{
return new ArrayList<Person>(capacity);
}
@Override
protected Person convert(NodeRef nodeRef, List<String> includeParam)
{
String personId = (String) nodeService.getProperty(nodeRef, ContentModel.PROP_USERNAME);
Person person = people.getPerson(personId);
return person;
}
// TODO Do the sort in the query on day. A comment in the code for the V0 API used for live people
// search says adding sort values for this query don't work - tried it and they really don't.
}.find(parameters, PARAM_TERM, MIN_TERM_LENGTH_PEOPLE, "_PERSON",
POST_QUERY_SORT, PEOPLE_SORT_PARAMS_TO_QNAMES,
new SortColumn(PARAM_FIRSTNAME, true), new SortColumn(PARAM_LASTNAME, true));
}
public abstract static class AbstractQuery<T>
{
public enum Sort
{
IN_QUERY_SORT, POST_QUERY_SORT
}
private final NodeService nodeService;
private final SearchService searchService;
public AbstractQuery(NodeService nodeService, SearchService searchService)
{
this.nodeService = nodeService;
this.searchService = searchService;
}
public CollectionWithPagingInfo<T> find(Parameters parameters,
String termName, int minTermLength, String queryTemplateName, Sort sort, Map<String, QName> sortParamsToQNames, SortColumn... defaultSort)
{
SearchParameters sp = new SearchParameters();
sp.setLanguage(SearchService.LANGUAGE_FTS_ALFRESCO);
sp.addStore(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE);
sp.setDefaultFieldName(queryTemplateName);
String term = getTerm(parameters, termName, minTermLength);
StringBuilder query = new StringBuilder();
buildQuery(query, term, sp, queryTemplateName);
sp.setQuery(query.toString());
List<SortColumn> defaultSortCols = Arrays.asList(defaultSort);
if (sort == IN_QUERY_SORT)
{
addSortOrder(parameters, sortParamsToQNames, defaultSortCols, sp);
}
Paging paging = parameters.getPaging();
PagingRequest pagingRequest = Util.getPagingRequest(paging);
sp.setSkipCount(pagingRequest.getSkipCount());
sp.setMaxItems(pagingRequest.getMaxItems());
ResultSet queryResults = null;
List<T> colection = null;
try
{
queryResults = searchService.query(sp);
List<NodeRef> nodeRefs = queryResults.getNodeRefs();
if (sort == POST_QUERY_SORT)
{
nodeRefs = postQuerySort(parameters, sortParamsToQNames, defaultSortCols, nodeRefs);
}
colection = newList(nodeRefs.size());
List<String> includeParam = parameters.getInclude();
for (NodeRef nodeRef : nodeRefs)
{
T t = convert(nodeRef, includeParam);
colection.add(t);
}
}
finally
{
if (queryResults != null)
{
queryResults.close();
}
}
return CollectionWithPagingInfo.asPaged(paging, colection, queryResults.hasMore(), new Long(queryResults.getNumberFound()).intValue());
}
/**
* Builds up the query and is expected to call {@link SearchParameters#setDefaultFieldName(String)}
* and {@link SearchParameters#addQueryTemplate(String, String)}
* @param query StringBuilder into which the query should be built.
* @param term to be searched for
* @param sp SearchParameters
* @param queryTemplateName
*/
protected abstract void buildQuery(StringBuilder query, String term, SearchParameters sp, String queryTemplateName);
/**
* Returns a list of the correct type.
* @param capacity of the list
* @return a new list.
*/
protected abstract List<T> newList(int capacity);
/**
* Converts a nodeRef into the an object of the required type.
* @param nodeRef to be converted
* @param includeParam additional fields to be included
* @return the object
*/
protected abstract T convert(NodeRef nodeRef, List<String> includeParam);
private String getTerm(Parameters parameters, String termName, int minTermLength)
{
String term = parameters.getParameter(termName);
if (term == null)
{
throw new InvalidArgumentException("Query '"+termName+"' not specified");
}
term = term.trim();
term = term.replace("\"", "");
int cnt = 0;
for (int i = 0; i < term.length(); i++)
{
char c = term.charAt(i);
if (Character.isLetterOrDigit(c))
{
cnt++;
if (cnt == TERM_MIN_LEN)
if (cnt == minTermLength)
{
break;
}
}
}
if (cnt < TERM_MIN_LEN)
if (cnt < minTermLength)
{
throw new InvalidArgumentException("Query 'term' is too short. Must have at least "+TERM_MIN_LEN+" alphanumeric chars");
}
}
String rootNodeId = parameters.getParameter(PARAM_ROOT_NODE_ID);
if (rootNodeId != null)
{
NodeRef nodeRef = nodes.validateOrLookupNode(rootNodeId, null);
sb.append("PATH:\"").append(getQNamePath(nodeRef.getId())).append("//*\" AND (");
}
// this will be expanded via query template (+ default field name)
sb.append(term);
if (rootNodeId != null)
{
sb.append(")");
}
String nodeTypeStr = parameters.getParameter(PARAM_NODE_TYPE);
if (nodeTypeStr != null)
{
QName filterNodeTypeQName = nodes.createQName(nodeTypeStr);
if (dictionaryService.getType(filterNodeTypeQName) == null)
{
throw new InvalidArgumentException("Unknown filter nodeType: "+nodeTypeStr);
throw new InvalidArgumentException("Query '"+termName+"' is too short. Must have at least "+minTermLength+" alphanumeric chars");
}
sb.append(" AND (+TYPE:\"").append(nodeTypeStr).append(("\")"));
sb.append(" AND -ASPECT:\"sys:hidden\" AND -cm:creator:system AND -QNAME:comment\\-* ");
}
else
{
sb.append(" AND (+TYPE:\"cm:content\" OR +TYPE:\"cm:folder\")");
sb.append(" AND -TYPE:\"cm:thumbnail\" AND -TYPE:\"cm:failedThumbnail\" AND -TYPE:\"cm:rating\" AND -TYPE:\"fm:post\"")
.append(" AND -TYPE:\"st:site\" AND -ASPECT:\"st:siteContainer\"")
.append(" AND -ASPECT:\"sys:hidden\" AND -cm:creator:system AND -QNAME:comment\\-* ");
return term;
}
SearchParameters sp = new SearchParameters();
sp.setLanguage(SearchService.LANGUAGE_FTS_ALFRESCO);
sp.setQuery(sb.toString());
sp.addStore(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE);
// query template / default field name
sp.addQueryTemplate(QT_FIELD, "%(cm:name cm:title cm:description TEXT TAG)");
sp.setDefaultFieldName(QT_FIELD);
Paging paging = parameters.getPaging();
PagingRequest pagingRequest = Util.getPagingRequest(paging);
sp.setSkipCount(pagingRequest.getSkipCount());
sp.setMaxItems(pagingRequest.getMaxItems());
List<SortColumn> sortCols = parameters.getSorting();
if ((sortCols != null) && (sortCols.size() > 0))
/**
* Adds sort order to the SearchParameters.
*/
protected void addSortOrder(Parameters parameters, Map<String, QName> sortParamsToQNames,
List<SortColumn> defaultSortCols, SearchParameters sp)
{
List<SortColumn> sortCols = getSorting(parameters, defaultSortCols);
for (SortColumn sortCol : sortCols)
{
QName sortPropQName = MAP_PARAM_SORT_QNAME.get(sortCol.column);
QName sortPropQName = sortParamsToQNames.get(sortCol.column);
if (sortPropQName == null)
{
throw new InvalidArgumentException("Invalid sort field: "+sortCol.column);
@@ -226,72 +438,70 @@ public class QueriesImpl implements Queries, InitializingBean
sp.addSort("@" + sortPropQName, sortCol.asc);
}
}
else
private List<SortColumn> getSorting(Parameters parameters, List<SortColumn> defaultSortCols)
{
// default sort order
sp.addSort("@" + ContentModel.PROP_MODIFIED, false);
}
ResultSet results = searchService.query(sp);
List<Node> nodeList = new ArrayList<>(results.length());
final Map<String, UserInfo> mapUserInfo = new HashMap<>(10);
List<String> includeParam = parameters.getInclude();
for (ResultSetRow row : results)
{
NodeRef nodeRef = row.getNodeRef();
// minimal info by default (unless "include"d otherwise)
nodeList.add(nodes.getFolderOrDocument(nodeRef, null, null, includeParam, mapUserInfo));
}
results.close();
return CollectionWithPagingInfo.asPaged(paging, nodeList, results.hasMore(), new Long(results.getNumberFound()).intValue());
}
private String getQNamePath(String nodeId)
{
NodeRef nodeRef = new NodeRef(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE, nodeId);
Map<String, String> cache = new HashMap<>();
StringBuilder buf = new StringBuilder(128);
Path path = null;
try
{
path = nodeService.getPath(nodeRef);
}
catch (InvalidNodeRefException inre)
{
throw new EntityNotFoundException(nodeId);
}
for (Path.Element e : path)
{
if (e instanceof Path.ChildAssocElement)
List<SortColumn> sortCols = parameters.getSorting();
if (sortCols == null || sortCols.size() == 0)
{
QName qname = ((Path.ChildAssocElement) e).getRef().getQName();
if (qname != null)
sortCols = defaultSortCols == null ? Collections.emptyList() : defaultSortCols;
}
return sortCols;
}
protected List<NodeRef> postQuerySort(Parameters parameters, Map<String, QName> sortParamsToQNames,
List<SortColumn> defaultSortCols, List<NodeRef> nodeRefs)
{
final List<SortColumn> sortCols = getSorting(parameters, defaultSortCols);
int sortColCount = sortCols.size();
if (sortColCount > 0)
{
// make copy of nodeRefs because it can be unmodifiable list.
nodeRefs = new ArrayList<NodeRef>(nodeRefs);
List<QName> sortPropQNames = new ArrayList<>(sortColCount);
for (SortColumn sortCol : sortCols)
{
String prefix = cache.get(qname.getNamespaceURI());
if (prefix == null)
{
// first request for this namespace prefix, get and cache result
Collection<String> prefixes = namespaceService.getPrefixes(qname.getNamespaceURI());
prefix = prefixes.size() != 0 ? prefixes.iterator().next() : "";
cache.put(qname.getNamespaceURI(), prefix);
}
buf.append('/').append(prefix).append(':').append(ISO9075.encode(qname.getLocalName()));
QName sortPropQName = sortParamsToQNames.get(sortCol.column);
sortPropQNames.add(sortPropQName);
}
final Collator col = Collator.getInstance(I18NUtil.getLocale());
Collections.sort(nodeRefs, new Comparator<NodeRef>()
{
@Override
public int compare(NodeRef n1, NodeRef n2)
{
int result = 0;
for (SortColumn sortCol : sortCols)
{
QName sortPropQName = sortParamsToQNames.get(sortCol.column);
Serializable p1 = getProperty(n1, sortPropQName);
Serializable p2 = getProperty(n2, sortPropQName);
result = ((p1 instanceof Long) && (p2 instanceof Long)
? Long.compare((Long)p1, (Long)p2)
: col.compare(p1.toString(), p2))
* (sortCol.asc ? 1 : -1);
if (result != 0)
{
break;
}
}
return result;
}
private Serializable getProperty(NodeRef nodeRef, QName sortPropQName)
{
Serializable result = nodeService.getProperty(nodeRef, sortPropQName);
return result == null ? "" : result;
}
});
}
else
{
buf.append('/').append(e.toString());
}
return nodeRefs;
}
return buf.toString();
}
}

View File

@@ -26,8 +26,8 @@
package org.alfresco.rest.api.queries;
import org.alfresco.rest.api.Queries;
import org.alfresco.rest.api.model.Node;
import org.alfresco.rest.framework.WebApiDescription;
import org.alfresco.rest.framework.core.exceptions.NotFoundException;
import org.alfresco.rest.framework.resource.EntityResource;
import org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction;
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
@@ -41,8 +41,13 @@ import org.springframework.beans.factory.InitializingBean;
* @author janv
*/
@EntityResource(name="queries", title = "Queries")
public class QueriesEntityResource implements EntityResourceAction.ReadById<CollectionWithPagingInfo<Node>>, InitializingBean
public class QueriesEntityResource implements
EntityResourceAction.ReadById<CollectionWithPagingInfo<? extends Object>>,
InitializingBean
{
private final static String QUERY_LIVE_SEARCH_NODES = "live-search-nodes";
private final static String QUERY_LIVE_SEARCH_PEOPLE = "live-search-people";
private Queries queries;
public void setQueries(Queries queries)
@@ -59,8 +64,16 @@ public class QueriesEntityResource implements EntityResourceAction.ReadById<Coll
// hmm - a little unorthodox
@Override
@WebApiDescription(title="Find results", description = "Find & list search results for given query id")
public CollectionWithPagingInfo<Node> readById(String queryId, Parameters parameters)
public CollectionWithPagingInfo<? extends Object> readById(String queryId, Parameters parameters)
{
return queries.findNodes(queryId, parameters);
switch (queryId)
{
case QUERY_LIVE_SEARCH_NODES:
return queries.findNodes(parameters);
case QUERY_LIVE_SEARCH_PEOPLE:
return queries.findPeople(parameters);
default:
throw new NotFoundException(queryId);
}
}
}