|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.rest.client.AbstractRemoteService<SpaceService> com.atlassian.confluence.rest.client.RemoteSpaceServiceImpl
public class RemoteSpaceServiceImpl
SpaceService implementation that communicates with Confluence remotely using the Confluence REST api
Nested Class Summary | |
---|---|
class |
RemoteSpaceServiceImpl.RemoteSpaceContentFinderImpl
|
class |
RemoteSpaceServiceImpl.RemoteSpaceFinderImpl
|
Nested classes/interfaces inherited from interface com.atlassian.confluence.rest.client.RemoteSpaceService |
---|
RemoteSpaceService.RemoteSpaceContentFinder, RemoteSpaceService.RemoteSpaceFinder, RemoteSpaceService.RemoteSpaceSingleFetcher |
Field Summary | |
---|---|
static String |
PRIVATE_SPACE_SUBPATH
|
static String |
SPACE_RESOURCE_PATH
|
Constructor Summary | |
---|---|
RemoteSpaceServiceImpl(AuthenticatedWebResourceProvider provider,
com.google.common.util.concurrent.ListeningExecutorService executor)
|
Method Summary | |
---|---|
com.atlassian.util.concurrent.Promise<Space> |
create(Space newSpace,
boolean isPrivate)
Create a new space. |
com.atlassian.util.concurrent.Promise<LongTaskSubmission> |
delete(Space space)
Delete the given space. |
RemoteSpaceService.RemoteSpaceFinder |
find(Expansion... expansions)
|
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(String spaceKey,
Expansion... expansions)
Deprecated. |
com.atlassian.util.concurrent.Promise<Space> |
update(Space space)
Updates a space. |
SpaceService.Validator |
validator()
Get the validator view of the Space Service. |
Methods inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService |
---|
addExpansions, addPageRequest, addPageRequestParams, deleteFuture, deleteFuture, getFuture, getFutureGenericCollection, getFutureMap, getFutureMapOfPageResponses, getFutureOption, getFuturePageResponseList, newExperimentalRestWebResource, newRestWebResource, postFuture, postFuture, postFuture, postFutureToPageResponse, putFuture |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String SPACE_RESOURCE_PATH
public static final String PRIVATE_SPACE_SUBPATH
Constructor Detail |
---|
public RemoteSpaceServiceImpl(AuthenticatedWebResourceProvider provider, com.google.common.util.concurrent.ListeningExecutorService executor)
Method Detail |
---|
public com.atlassian.util.concurrent.Promise<Space> create(Space newSpace, boolean isPrivate) throws ServiceException
RemoteSpaceService
Minimum properties to be valid is a key and name.
create
in interface RemoteSpaceService
newSpace
- the space to createisPrivate
- true if the space should only be visible to its creator
ServiceException
- if the space cannot be createdpublic com.atlassian.util.concurrent.Promise<Space> update(Space space) throws ServiceException
RemoteSpaceService
Currently limited to changing the space name, description and homepage.
update
in interface RemoteSpaceService
space
- the updated Space
ServiceException
public SpaceService.Validator validator()
RemoteSpaceService
validator
in interface RemoteSpaceService
@Deprecated public com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Option<Space>> getSpace(String spaceKey, Expansion... expansions)
getSpace
in interface RemoteSpaceService
public RemoteSpaceService.RemoteSpaceFinder find(Expansion... expansions)
find
in interface RemoteSpaceService
public RemoteSpaceService.RemoteSpaceContentFinder findContent(Space space, Expansion... expansion)
RemoteSpaceService
findContent
in interface RemoteSpaceService
space
- - the space to fetch content forexpansion
- - the expansions to apply to the content in this space
public com.atlassian.util.concurrent.Promise<LongTaskSubmission> delete(Space space)
RemoteSpaceService
The deletion happens asynchronously so a LongTaskSubmission is returned, that can be used to request status.
delete
in interface RemoteSpaceService
space
- the space to delete
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |