Package com.atlassian.confluence.plugins.restapi.resources

Class SpaceResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.SpaceResource

public class SpaceResource
extends Object

REST wrapper for the SpaceService.

Constructor Summary

Constructors

Constructor	Description
SpaceResource(SpaceService spaceService, RestNavigationService navigationService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	archive(String spaceKey)
Map<ContentType,RestList<Content>>	contents(String spaceKey, String depth, String expand, int start, int limit)
RestList<Content>	contentsWithType(String spaceKey, String type, String depth, String expand, int start, int limit, javax.ws.rs.core.UriInfo uriInfo)
Space	createPrivateSpace(Space newSpace)
Space	createSpace(Space newSpace)
javax.ws.rs.core.Response	delete(String spaceKey)
javax.ws.rs.core.Response	restore(String spaceKey)
Space	space(String spaceKey, String expand)
PageResponse<Space>	spaces(String spaceKey, List<String> spaceKeys, String type, String status, List<String> labelNames, Boolean favourite, Boolean hasRetentionPolicy, String expand, int offset, String afterOffset, int limit, javax.ws.rs.core.UriInfo uriInfo)
Space	update(String spaceKey, Space space)

Methods inherited from class java.lang.Object

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

Constructor Details

SpaceResource

@Inject
public SpaceResource(SpaceService spaceService,
 RestNavigationService navigationService)

Method Details

createSpace

@PublicApi
public Space createSpace(Space newSpace)
                  throws ServiceException

Throws:

ServiceException

createPrivateSpace

@PublicApi
public Space createPrivateSpace(Space newSpace)
                         throws ServiceException

Throws:

ServiceException

update

@PublicApi
public Space update(String spaceKey,
 Space space)
             throws ServiceException

Throws:

ServiceException

delete

@PublicApi
public javax.ws.rs.core.Response delete(String spaceKey)
                                 throws ServiceException,
URISyntaxException

Throws:

ServiceException

URISyntaxException

space

@PublicApi
public Space space(String spaceKey,
 String expand)

spaces

@PublicApi
public PageResponse<Space> spaces(String spaceKey,
 List<String> spaceKeys,
 String type,
 String status,
 List<String> labelNames,
 Boolean favourite,
 Boolean hasRetentionPolicy,
 String expand,
 int offset,
 String afterOffset,
 int limit,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                           throws ServiceException

Throws:

ServiceException

contents

@PublicApi
public Map<ContentType,RestList<Content>> contents(String spaceKey,
 String depth,
 String expand,
 int start,
 int limit)
                                            throws ServiceException

Throws:

ServiceException

contentsWithType

@PublicApi
public RestList<Content> contentsWithType(String spaceKey,
 String type,
 String depth,
 String expand,
 int start,
 int limit,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                                   throws ServiceException

Throws:

ServiceException

archive

public javax.ws.rs.core.Response archive(String spaceKey)

restore

public javax.ws.rs.core.Response restore(String spaceKey)