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
RemoteSpaceService.RemoteSpaceContentFinder	findContent(Space space, Expansion... expansion) Create a finder to find content in the given space.
java.util.concurrent.Future<PageResponse<Content>>	getContent(Space space, PageRequest pageRequest, Expansion... expansion) Retrieve the top level content contained in this space.
java.util.concurrent.Future<com.atlassian.fugue.Option<Space>>	getSpace(java.lang.String spaceKey, Expansion... expansions) Retrieve a space with the given spacekey.

Method Detail

getSpace

java.util.concurrent.Future<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.

getContent

java.util.concurrent.Future<PageResponse<Content>> getContent(Space space,
                                                            PageRequest pageRequest,
                                                            Expansion... expansion)

Retrieve the top level content contained in this space.

The pageRequest limit is restricted to a maximum page size.

Parameters:

space - - the space to retrieve the content for

pageRequest - - a pageRequest indicating how much content to retrieve.

Returns:

a partial list of the top level content in this space.

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