com.atlassian.confluence.rest.client

Class RemoteSpaceServiceImpl

java.lang.Object

com.atlassian.confluence.rest.client.AbstractRemoteService<SpaceService>

com.atlassian.confluence.rest.client.RemoteSpaceServiceImpl

All Implemented Interfaces:

RemoteSpaceService

public class RemoteSpaceServiceImpl
extends AbstractRemoteService<SpaceService>
implements RemoteSpaceService

SpaceService implementation that communicates with Confluence remotely using the Confluence REST api

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteSpaceServiceImpl.RemoteSpaceContentFinderImpl

Nested classes/interfaces inherited from interface com.atlassian.confluence.rest.client.RemoteSpaceService

RemoteSpaceService.RemoteSpaceContentFinder

Constructor Summary

Constructors

Constructor and Description
RemoteSpaceServiceImpl(AuthenticatedWebResourceProvider provider, com.google.common.util.concurrent.ListeningExecutorService executor)

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... expansions) 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.

Methods inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

addExpansions, addPageRequest, addPageRequestParams, deleteFuture, getFutureGenericCollection, getFutureMapOfPageResponses, getFutureOption, getFuturePageResponseList, newRestWebResource, postFuture, postFuture, postFuture, postFutureToPageResponse, putFuture

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteSpaceServiceImpl

public RemoteSpaceServiceImpl(AuthenticatedWebResourceProvider provider,
                      com.google.common.util.concurrent.ListeningExecutorService executor)

Method Detail

getSpace

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

Description copied from interface: RemoteSpaceService

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

Specified by:

getSpace in interface RemoteSpaceService

Parameters:

spaceKey - - the space key of the space

Returns:

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

getContent

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

Description copied from interface: RemoteSpaceService

Retrieve the top level content contained in this space.

The pageRequest limit is restricted to a maximum page size.

Specified by:

getContent in interface RemoteSpaceService

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

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

Description copied from interface: RemoteSpaceService

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

Specified by:

findContent in interface RemoteSpaceService

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