Package com.atlassian.confluence.plugins.spacedirectory.rest

Class SpaceDirectoryResource

java.lang.Object

com.atlassian.confluence.plugins.rest.jackson2.resources.AbstractResource

com.atlassian.confluence.plugins.spacedirectory.rest.SpaceDirectoryResource

@Path("/")
@Produces({"application/xml","application/json"})
public class SpaceDirectoryResource
extends AbstractResource

Field Summary

Fields inherited from class com.atlassian.confluence.plugins.rest.jackson2.resources.AbstractResource

authContext, uriInfo, userAccessor

Constructor Summary

Constructors

Constructor	Description
SpaceDirectoryResource(UserAccessor userAccessor, SpacePermissionManager spacePermissionManager, SpaceService spaceService, PredefinedSearchBuilder predefinedSearchBuilder, SearchManager searchManager, com.atlassian.sal.api.ApplicationProperties applicationProperties, SpaceDirectoryEntityBuilder builder)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	doLimitedSearch(String query, int startIndex, Integer pageSize, Set<String> label, String typeStr, String status, String sort, String sortField, boolean filterUnauthorizedSpaces)	Search for spaces within the directory, returning a limited set of fields for each space.
jakarta.ws.rs.core.Response	doSearch(String query, int startIndex, Integer pageSize, Set<String> label, String typeStr, String status, boolean filterUnauthorizedSpaces)	Search for spaces within the directory.

Methods inherited from class com.atlassian.confluence.plugins.rest.jackson2.resources.AbstractResource

createRequestContext, getAnonymousUserUriBuilder, getAttachmentUriBuilder, getContentUriBuilder, getCurrentUser, getMissingUserUriBuilder, getSpaceUriBuilder, getUserUriBuilder

Methods inherited from class java.lang.Object

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

Constructor Details

SpaceDirectoryResource

@Inject
public SpaceDirectoryResource(UserAccessor userAccessor,
 SpacePermissionManager spacePermissionManager,
 SpaceService spaceService,
 PredefinedSearchBuilder predefinedSearchBuilder,
 SearchManager searchManager,
 com.atlassian.sal.api.ApplicationProperties applicationProperties,
 SpaceDirectoryEntityBuilder builder)

Method Details

doSearch

@GET
@Path("/search")
public jakarta.ws.rs.core.Response doSearch(@QueryParam("query")
 String query,
 @DefaultValue("0") @QueryParam("startIndex")
 int startIndex,
 @QueryParam("pageSize")
 Integer pageSize,
 @QueryParam("label")
 Set<String> label,
 @QueryParam("type")
 String typeStr,
 @QueryParam("status")
 String status,
 @DefaultValue("false") @QueryParam("filterUnauthorizedSpaces")
 boolean filterUnauthorizedSpaces)

Search for spaces within the directory.

Parameters:

query - Text query by space name and key

startIndex - the index of the first result to return

pageSize - the maximum number of results to return

label - the set of labels that must be applied to the spaces

typeStr - the type of space to look up (or null to look up all spaces)

status - the status (current or archived) of space to look up, or null to

filterUnauthorizedSpaces - Whether to filter out unauthorized labels for system admins look up all spaces.

Returns:

the appropriate REST response.

doLimitedSearch

@GET
@Path("/limitedsearch")
public jakarta.ws.rs.core.Response doLimitedSearch(@QueryParam("query")
 String query,
 @DefaultValue("0") @QueryParam("startIndex")
 int startIndex,
 @QueryParam("pageSize")
 Integer pageSize,
 @QueryParam("label")
 Set<String> label,
 @QueryParam("type")
 String typeStr,
 @QueryParam("status")
 String status,
 @DefaultValue("ascending") @QueryParam("sort")
 String sort,
 @DefaultValue("spaceKey") @QueryParam("sortField")
 String sortField,
 @DefaultValue("false") @QueryParam("filterUnauthorizedSpaces")
 boolean filterUnauthorizedSpaces)

Search for spaces within the directory, returning a limited set of fields for each space.

Parameters:

query - Text query by space name and key

startIndex - The index of the first result to return

pageSize - The maximum number of results to return

label - The set of labels that must be applied to the spaces

typeStr - The type of space to look up (or null to look up all spaces)

status - The status (current or archived) of space to look up, or null to look up all spaces

sort - The order to sort result spaceKeys by, either "ascending" or "descending" (default is "ascending")

sortField - The field to sort by, either "spaceName" or "spaceKey" (default is "spaceKey")

filterUnauthorizedSpaces - Whether to filter out unauthorized spaces for system admins (default is false)

Returns:

A list of limited space representations matching the query, in the requested order

Since:

9.2.7