Package 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	Description
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

Fields

Modifier and Type	Field	Description
static final String	PERSONAL_SPACE_SUBPATH
static final String	PRIVATE_SPACE_SUBPATH
static final String	SPACE_RESOURCE_PATH

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

provider

Constructor Summary

Constructors

Constructor	Description
RemoteSpaceServiceImpl(AuthenticatedWebResourceProvider provider, ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	archive(String spaceKey)	Archives a space.
CompletionStage<Space>	createCompletionStage(Space newSpace, boolean isPrivate)	Create a new space.
CompletionStage<Space>	createPersonalSpaceForSelf(PersonalSpaceDetailsForCreation spaceDetails)	Create a personal space for self.
CompletionStage<Space>	createPersonalSpaceForUser(PersonalSpaceDetailsForCreation spaceDetails, String username)	Create a personal space for a user by username.
CompletionStage<Void>	deleteCompletionStage(long spaceId)	Deletes space.
CompletionStage<LongTaskSubmission>	deleteCompletionStage(Space space)	Delete the given space.
CompletionStage<Void>	deleteSynchronouslyCompletionStage(long spaceId)	Deletes space synchronously.
CompletionStage<Void>	emptyTrash(String spaceKey)	Purge all the trash in a given space.
RemoteSpaceService.RemoteSpaceFinder	find(Expansion... expansions)
CompletionStage<PageResponse<Label>>	findAllContentLabelsPaginated(String spaceKey, PageRequest pageRequest)	Returns a paginated list of all Labels used by Content within the given Space.
RemoteSpaceService.RemoteSpaceContentFinder	findContent(Space space, Expansion... expansion)	Create a finder to find content in the given space.
CompletionStage<PageResponse<Label>>	findPopularContentLabelsPaginated(String spaceKey, PageRequest pageRequest)	Returns a paginated list of the popular Labels used by Content within the given Space.
CompletionStage<PageResponse<Label>>	findRecentContentLabelsPaginated(String spaceKey, PageRequest pageRequest)	Returns a paginated list of the recent Labels used by Content within the given Space.
CompletionStage<PageResponse<Label>>	findRelatedContentLabelsPaginated(String spaceKey, String labelName, PageRequest pageRequest)	Returns a paginated list of related Labels used by Content within the given Space.
CompletionStage<Void>	restore(String spaceKey)	Un-archives a space.
CompletionStage<Space>	updateCompletionStage(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, deleteCompletionStage, deleteCompletionStage, getCompletionStage, getCompletionStageGenericCollection, getCompletionStageMap, getCompletionStageMapOfGenericListResponse, getCompletionStageMapOfPageResponses, getCompletionStageOptional, getCompletionStagePageResponseList, getCompletionStageSearchPageResponseList, getExecutor, newExperimentalRestWebTarget, newWebTarget, postCompletionStage, postCompletionStage, postCompletionStage, postCompletionStageToPageResponse, postVoidCompletionStage, putCompletionStage, putVoidCompletionStage

Methods inherited from class java.lang.Object

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

Field Details

SPACE_RESOURCE_PATH

public static final String SPACE_RESOURCE_PATH

See Also:

• Constant Field Values

PRIVATE_SPACE_SUBPATH

public static final String PRIVATE_SPACE_SUBPATH

See Also:

• Constant Field Values

PERSONAL_SPACE_SUBPATH

public static final String PERSONAL_SPACE_SUBPATH

See Also:

• Constant Field Values

Constructor Details

RemoteSpaceServiceImpl

public RemoteSpaceServiceImpl(AuthenticatedWebResourceProvider provider,
 ExecutorService executor)

Since:

9.0

Method Details

createCompletionStage

public CompletionStage<Space> createCompletionStage(Space newSpace,
 boolean isPrivate)
                                             throws ServiceException

Description copied from interface: RemoteSpaceService

Create a new space.

Minimum properties to be valid is a key and name.

Specified by:

createCompletionStage in interface RemoteSpaceService

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

createPersonalSpaceForSelf

public CompletionStage<Space> createPersonalSpaceForSelf(PersonalSpaceDetailsForCreation spaceDetails)
                                                  throws ServiceException

Description copied from interface: RemoteSpaceService

Create a personal space for self.

If the "isPrivate" flag is set to true the personal space will only be visible to the owner.

Specified by:

createPersonalSpaceForSelf in interface RemoteSpaceService

Parameters:

spaceDetails - Details of a Personal Space to be created

Returns:

the space created

Throws:

ServiceException - if the space cannot be created

createPersonalSpaceForUser

public CompletionStage<Space> createPersonalSpaceForUser(PersonalSpaceDetailsForCreation spaceDetails,
 String username)
                                                  throws ServiceException

Description copied from interface: RemoteSpaceService

Create a personal space for a user by username.

If the "isPrivate" flag is set to true the personal space will only be visible to the owner.

Specified by:

createPersonalSpaceForUser in interface RemoteSpaceService

Parameters:

spaceDetails - Details of a Personal Space to be created

username - Username of the user to create personal space for

Returns:

the space created

Throws:

ServiceException - if the space cannot be created

updateCompletionStage

public CompletionStage<Space> updateCompletionStage(Space space)
                                             throws ServiceException

Description copied from interface: RemoteSpaceService

Updates a space.

Currently limited to changing the space name, description and homepage.

Specified by:

updateCompletionStage in interface RemoteSpaceService

Parameters:

space - the updated Space

Returns:

the updated space after being persisted

Throws:

ServiceException

find

public RemoteSpaceService.RemoteSpaceFinder find(Expansion... expansions)

Specified by:

find in interface RemoteSpaceService

findAllContentLabelsPaginated

public CompletionStage<PageResponse<Label>> findAllContentLabelsPaginated(String spaceKey,
 PageRequest pageRequest)

Description copied from interface: RemoteSpaceService

Returns a paginated list of all Labels used by Content within the given Space.

Specified by:

findAllContentLabelsPaginated in interface RemoteSpaceService

Parameters:

spaceKey - the key of the Space the User is attempting to search.

pageRequest - the pagination parameters.

Returns:

Paginated list of labels.

findPopularContentLabelsPaginated

public CompletionStage<PageResponse<Label>> findPopularContentLabelsPaginated(String spaceKey,
 PageRequest pageRequest)

Description copied from interface: RemoteSpaceService

Returns a paginated list of the popular Labels used by Content within the given Space.

Specified by:

findPopularContentLabelsPaginated in interface RemoteSpaceService

Parameters:

spaceKey - the key of the Space the User is attempting to search.

pageRequest - the pagination parameters.

Returns:

Paginated list of labels.

findRecentContentLabelsPaginated

public CompletionStage<PageResponse<Label>> findRecentContentLabelsPaginated(String spaceKey,
 PageRequest pageRequest)

Description copied from interface: RemoteSpaceService

Returns a paginated list of the recent Labels used by Content within the given Space.

Specified by:

findRecentContentLabelsPaginated in interface RemoteSpaceService

Parameters:

spaceKey - the key of the Space the User is attempting to search.

pageRequest - the pagination parameters.

Returns:

Paginated list of labels.

findRelatedContentLabelsPaginated

public CompletionStage<PageResponse<Label>> findRelatedContentLabelsPaginated(String spaceKey,
 String labelName,
 PageRequest pageRequest)

Description copied from interface: RemoteSpaceService

Returns a paginated list of related Labels used by Content within the given Space. A Label is defined as being related to another when it is found attached to the same Content as the Label specified in the request.

Specified by:

findRelatedContentLabelsPaginated in interface RemoteSpaceService

Parameters:

spaceKey - the key of the Space the User is attempting to search.

labelName - the Label to match on.

pageRequest - the pagination parameters.

Returns:

Paginated list of labels.

archive

public CompletionStage<Void> archive(String spaceKey)

Description copied from interface: RemoteSpaceService

Archives a space. If the space is already archived, this method does nothing.

Specified by:

archive in interface RemoteSpaceService

restore

public CompletionStage<Void> restore(String spaceKey)

Description copied from interface: RemoteSpaceService

Un-archives a space. If the space is already unarchived, this method does nothing.

Specified by:

restore in interface RemoteSpaceService

emptyTrash

public CompletionStage<Void> emptyTrash(String spaceKey)

Description copied from interface: RemoteSpaceService

Purge all the trash in a given space.

Specified by:

emptyTrash in interface RemoteSpaceService

Parameters:

spaceKey - the key of the space to empty trash

validator

public SpaceService.Validator validator()

Description copied from interface: RemoteSpaceService

Get the validator view of the Space Service.

Specified by:

validator in interface RemoteSpaceService

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

deleteCompletionStage

public CompletionStage<LongTaskSubmission> deleteCompletionStage(Space space)

Description copied from interface: RemoteSpaceService

Delete the given space.

The deletion happens asynchronously so a LongTaskSubmission is returned, that can be used to request status.

Specified by:

deleteCompletionStage in interface RemoteSpaceService

Parameters:

space - the space to delete

Returns:

a LongTaskStatus describing the space-removal operation

deleteCompletionStage

public CompletionStage<Void> deleteCompletionStage(long spaceId)

Description copied from interface: RemoteSpaceService

Deletes space. It removes space permissions and rename the space key, so the space key can be re-used immediately. Alter that, all remaining space content will be removed in background. Neither instance restart nor problems with the database will not prevent data deletion. It will not leave partial data in the database.

Specified by:

deleteCompletionStage in interface RemoteSpaceService

Parameters:

spaceId - space id

deleteSynchronouslyCompletionStage

public CompletionStage<Void> deleteSynchronouslyCompletionStage(long spaceId)

Description copied from interface: RemoteSpaceService

Deletes space synchronously. It is NOT RECOMMENDED to use in production code, this method should be used in tests to remove space data quickly. Using regular space deletion is not recommended in tests because while one test is being running, data from the previous test could be still being deleted. It could be a source of flakiness. Instance restart will interrupt the process, so some space content can remain in the database.

Specified by:

deleteSynchronouslyCompletionStage in interface RemoteSpaceService

Parameters:

spaceId - space id