Package com.atlassian.confluence.plugins.quicknav.resources

Class QuickNavResource

java.lang.Object

com.atlassian.confluence.plugins.quicknav.resources.QuickNavResource

@Path("/search")
public class QuickNavResource
extends Object

This is the resource that provides QuickNav search endpoints to Confluence Users. Try and keep it light and make the ContentNameSearchService contain the majority of the logic.

Constructor Summary

Constructors

Constructor	Description
QuickNavResource(ContentNameSearchService contentNameSearchService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getQuickNavResults(javax.servlet.http.HttpServletRequest httpServletRequest, String query, List<String> types, String spaceKey, boolean filterUnauthorizedSpaces, int maxPerCategory, int limit)	This is the primary Confluence QuickNav endpoint, it provides the majority (if not all) of the search results in the QuickNav dropdown.

Methods inherited from class java.lang.Object

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

Constructor Details

QuickNavResource

@Inject
public QuickNavResource(ContentNameSearchService contentNameSearchService)

Method Details

getQuickNavResults

@GET
@Produces("application/json")
public javax.ws.rs.core.Response getQuickNavResults(@Context
 javax.servlet.http.HttpServletRequest httpServletRequest,
 @QueryParam("query")
 String query,
 @QueryParam("type")
 List<String> types,
 @QueryParam("spaceKey")
 String spaceKey,
 @DefaultValue("false") @QueryParam("filterUnauthorizedSpaces")
 boolean filterUnauthorizedSpaces,
 @DefaultValue("-1") @QueryParam("maxPerCategory")
 int maxPerCategory,
 @DefaultValue("-1") @QueryParam("limit")
 int limit)

This is the primary Confluence QuickNav endpoint, it provides the majority (if not all) of the search results in the QuickNav dropdown.

Parameters:

httpServletRequest - The HttpServletRequest that was made by this request. Important to know the request context.

query - The actual query string that the user was searching for.

types - Content is grouped by 'type'. This is a list of all of the 'types' of content that you wish to search through.

spaceKey - You can provide the single key of a space to restrict the QuickNav search to results within that space.

maxPerCategory - The maximum results per category/type that will be returned. Pass in null if you wish to use the default maxima.

Returns:

The QuickNav Search results.