Class SpaceDirectoryResource
java.lang.Object
com.atlassian.confluence.plugins.rest.jackson2.resources.AbstractResource
com.atlassian.confluence.plugins.spacedirectory.rest.SpaceDirectoryResource
-
Field Summary
Fields inherited from class com.atlassian.confluence.plugins.rest.jackson2.resources.AbstractResource
authContext, uriInfo, userAccessor
-
Constructor Summary
ConstructorDescriptionSpaceDirectoryResource
(UserAccessor userAccessor, SpacePermissionManager spacePermissionManager, PredefinedSearchBuilder predefinedSearchBuilder, SearchManager searchManager, SpaceDirectoryEntityBuilder builder) -
Method Summary
Methods inherited from class com.atlassian.confluence.plugins.rest.jackson2.resources.AbstractResource
createRequestContext, getAnonymousUserUriBuilder, getAttachmentUriBuilder, getContentUriBuilder, getCurrentUser, getMissingUserUriBuilder, getSpaceUriBuilder, getUserUriBuilder
-
Constructor Details
-
SpaceDirectoryResource
@Inject public SpaceDirectoryResource(UserAccessor userAccessor, SpacePermissionManager spacePermissionManager, PredefinedSearchBuilder predefinedSearchBuilder, SearchManager searchManager, SpaceDirectoryEntityBuilder builder)
-
-
Method Details
-
doSearch
public javax.ws.rs.core.Response doSearch(String query, int startIndex, Integer pageSize, Set<String> label, String typeStr, String status) Search for spaces within the directory.- Parameters:
query
- Text query by space name and keystartIndex
- the index of the first result to returnpageSize
- the maximum number of results to returnlabel
- the set of labels that must be applied to the spacestypeStr
- 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.- Returns:
- the appropriate REST response.
-