com.atlassian.confluence.rest.client

Interface RemoteSpaceService

All Known Implementing Classes:

RemoteSpaceServiceImpl

@ExperimentalApi
public interface RemoteSpaceService

SpaceService implementation that communicates with Confluence remotely using the Confluence REST api. Provides future returning equivalents for the methods in SpaceService.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RemoteSpaceService.RemoteSpaceContentFinder

Method Summary

Methods

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<Space>	create(Space newSpace, boolean isPrivate) Create a new space.
RemoteSpaceService.RemoteSpaceContentFinder	findContent(Space space, Expansion... expansion) Create a finder to find content in the given space.
com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Option<Space>>	getSpace(java.lang.String spaceKey, Expansion... expansions) Retrieve a space with the given spacekey.
SpaceService.Validator	validator() Get the validator view of the Space Service.

Method Detail

create

com.atlassian.util.concurrent.Promise<Space> create(Space newSpace,
                                                  boolean isPrivate)
                                                    throws ServiceException

Create a new space.

Minimum properties to be valid is a key and name.

Parameters:

newSpace - the space to create

isPrivate - true if the space should only be visible to its creator

Returns:

the space created

Throws:

ServiceException - if the space cannot be created

validator

SpaceService.Validator validator()

Get the validator view of the Space Service.

getSpace

com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Option<Space>> getSpace(java.lang.String spaceKey,
                                                                                Expansion... expansions)

Retrieve a space with the given spacekey. A space key uniquely identifies a space.

Parameters:

spaceKey - - the space key of the space

Returns:

an Option of the space with the given key if one exists.

findContent

RemoteSpaceService.RemoteSpaceContentFinder findContent(Space space,
                                                      Expansion... expansion)

Create a finder to find content in the given space. Content will be returned upon calling one of the fetch methods on the returned finder

Parameters:

space - - the space to fetch content for

expansion - - the expansions to apply to the content in this space

Returns:

a new space content finder with the space and expansions set