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

java.lang.Object
  com.atlassian.confluence.plugins.rest.resources.AbstractResource
      com.atlassian.confluence.plugins.spacedirectory.rest.SpaceDirectoryResource

public class SpaceDirectoryResource
extends AbstractResource

Field Summary

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

authContext, uriInfo, userAccessor

Constructor Summary

SpaceDirectoryResource(UserAccessor userAccessor, SpacePermissionManager spacePermissionManager, PredefinedSearchBuilder predefinedSearchBuilder, SearchManager searchManager, SpaceDirectoryEntityBuilder builder)

Method Summary

javax.ws.rs.core.Response

doSearch(java.lang.String query, int startIndex, java.lang.Integer pageSize, java.util.Set<java.lang.String> label, java.lang.String typeStr, java.lang.String status) Search for spaces within the directory.

Methods inherited from class com.atlassian.confluence.plugins.rest.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 Detail

SpaceDirectoryResource

public SpaceDirectoryResource(UserAccessor userAccessor,
                              SpacePermissionManager spacePermissionManager,
                              PredefinedSearchBuilder predefinedSearchBuilder,
                              SearchManager searchManager,
                              SpaceDirectoryEntityBuilder builder)

Method Detail

doSearch

public javax.ws.rs.core.Response doSearch(java.lang.String query,
                                          int startIndex,
                                          java.lang.Integer pageSize,
                                          java.util.Set<java.lang.String> label,
                                          java.lang.String typeStr,
                                          java.lang.String status)

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 look up all spaces.

Returns:

the appropriate REST response.