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

Constructor Summary

Constructors

Constructor and Description
RemoteSpaceServiceImpl(AuthenticatedWebResourceProvider provider, java.util.concurrent.ExecutorService executor)

Method Summary

Methods

Modifier and Type	Method and Description
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, deleteFuture, getFutureOption, getFuturePageResponseList, newRestWebResource, postFuture, 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,
                      java.util.concurrent.ExecutorService 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.