Package com.atlassian.confluence.rest.client.impl

Class RemoteContentTrashServiceImpl

java.lang.Object

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

com.atlassian.confluence.rest.client.impl.RemoteContentTrashServiceImpl

All Implemented Interfaces:

RemoteContentTrashService

public class RemoteContentTrashServiceImpl
extends AbstractRemoteService<ContentTrashService>
implements RemoteContentTrashService

ContentTrashService implementation that communicates with Confluence remotely.

Field Summary

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

provider

Constructor Summary

Constructors

Constructor	Description
RemoteContentTrashServiceImpl(AuthenticatedWebResourceProvider provider, ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
CompletionStage<PageResponse<Content>>	getTrashContentsCompletionStage(Space space, LimitedRequest limitedRequest, Expansion... expansions)
CompletionStage<Void>	purgeCompletionStage(Content content)	Permanently delete a piece of content.
CompletionStage<Content>	restoreCompletionStage(Content content)	Restore a trashed piece of content.
CompletionStage<Void>	trashCompletionStage(Content content)	Trash a piece of content.

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

Constructor Details

RemoteContentTrashServiceImpl

public RemoteContentTrashServiceImpl(AuthenticatedWebResourceProvider provider,
 ExecutorService executor)

Since:

9.0

Method Details

trashCompletionStage

public CompletionStage<Void> trashCompletionStage(Content content)

Description copied from interface: RemoteContentTrashService

Trash a piece of content.

The RemoteContentTrashService.purgeCompletionStage(Content) method can be used for content that doesn't support trashing. Currently, only content with types ContentType.PAGE and ContentType.BLOG_POST support trashing.

Specified by:

trashCompletionStage in interface RemoteContentTrashService

Parameters:

content - the content to be trashed

Returns:

the content after being trashed

restoreCompletionStage

public CompletionStage<Content> restoreCompletionStage(Content content)

Description copied from interface: RemoteContentTrashService

Restore a trashed piece of content.

Specified by:

restoreCompletionStage in interface RemoteContentTrashService

Parameters:

content - the content to be restored

Returns:

the content after being restored

purgeCompletionStage

public CompletionStage<Void> purgeCompletionStage(Content content)

Description copied from interface: RemoteContentTrashService

Permanently delete a piece of content.

There are two main cases:

• Trashable content (e.g. Pages, BlogPosts) must have status "trashed" to be purged.
• Non-trashable content (e.g. Comments, Attachment) can be purged with status "current".

Specified by:

purgeCompletionStage in interface RemoteContentTrashService

Parameters:

content - the content to be purged

getTrashContentsCompletionStage

public CompletionStage<PageResponse<Content>> getTrashContentsCompletionStage(Space space,
 LimitedRequest limitedRequest,
 Expansion... expansions)

Specified by:

getTrashContentsCompletionStage in interface RemoteContentTrashService

Parameters:

space - the space where the trash contents belong to

limitedRequest - the pagination request, with a cursor which is an identifier to skip results from a previous query when paginating and limit for the result

expansions - the optional properties to expand on the result

Returns:

the contents of the trash, up to the request limit