com.atlassian.confluence.plugins.rest.resources
Class SpaceResource

java.lang.Object
  com.atlassian.confluence.plugins.rest.resources.AbstractResource
      com.atlassian.confluence.plugins.rest.resources.SpaceResource

public class SpaceResource
extends AbstractResource

Rest layer for accessing Confluence spaces. Currently, only read access to spaces is supported.

Field Summary

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

authContext, userAccessor

Constructor Summary

SpaceResource(UserAccessor userAccessor, RestSpaceManager restSpaceManager, SpacePermissionManager spacePermissionManager)

Method Summary

javax.ws.rs.core.Response	get(java.lang.String spaceTypeString, java.lang.String startIndexString, java.lang.String maxResultsString) Retrieves a list of spaces visible to the currently logged in user, alphabetically by space name.
javax.ws.rs.core.Response	getSpace(java.lang.String key)

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

createRequestContext, getAttachmentUriBuilder, getContentUriBuilder, getCurrentUser, getSpaceUriBuilder, getUserUriBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

SpaceResource

public SpaceResource(UserAccessor userAccessor,
                     RestSpaceManager restSpaceManager,
                     SpacePermissionManager spacePermissionManager)

Method Detail

get

public javax.ws.rs.core.Response get(java.lang.String spaceTypeString,
                                     java.lang.String startIndexString,
                                     java.lang.String maxResultsString)

Retrieves a list of spaces visible to the currently logged in user, alphabetically by space name. An optional parameter "type" allows filtering on space type. The standard paging parameters "start-index" and "max-results" can be used to page through the list. A maximum of 50 (defined by DefaultRestSpaceManager.DEFAULT_MAX_SIZE) spaces will be listed.

Parameters:

spaceTypeString - the space type paramater to filter the list by space

startIndexString - the start-index paramater

maxResultsString - the max-results paramater

getSpace

public javax.ws.rs.core.Response getSpace(java.lang.String key)