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, com.google.common.util.concurrent.ListeningExecutorService executor)
Deprecated.since 8.8RemoteContentTrashServiceImpl(AuthenticatedWebResourceProvider provider, ExecutorService executor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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, deleteFuture, deleteFuture, getCompletionStage, getCompletionStageGenericCollection, getCompletionStageMap, getCompletionStageMapOfPageResponses, getCompletionStageOptional, getCompletionStagePageResponseList, getCompletionStageSearchPageResponseList, getExecutor, getFuture, getFutureGenericCollection, getFutureMap, getFutureMapOfPageResponses, getFutureOption, getFutureOptional, getFuturePageResponseList, newExperimentalRestWebResource, newRestWebResource, postCompletionStage, postCompletionStage, postCompletionStage, postCompletionStageToPageResponse, postFuture, postFuture, postFuture, postFutureToPageResponse, postVoidCompletionStage, putCompletionStage, putFuture
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.atlassian.confluence.rest.client.RemoteContentTrashService
purge, restore, trash
-
-
-
-
Constructor Detail
-
RemoteContentTrashServiceImpl
public RemoteContentTrashServiceImpl(AuthenticatedWebResourceProvider provider, ExecutorService executor)
- Since:
- 8.8
-
RemoteContentTrashServiceImpl
@Deprecated public RemoteContentTrashServiceImpl(AuthenticatedWebResourceProvider provider, com.google.common.util.concurrent.ListeningExecutorService executor)
Deprecated.since 8.8
-
-
Method Detail
-
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 typesContentType.PAGE
andContentType.BLOG_POST
support trashing.- Specified by:
trashCompletionStage
in interfaceRemoteContentTrashService
- 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 interfaceRemoteContentTrashService
- 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 interfaceRemoteContentTrashService
- Parameters:
content
- the content to be purged
-
-