Package com.atlassian.confluence.rest.client

Class AbstractRemoteContentService

java.lang.Object

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

com.atlassian.confluence.rest.client.AbstractRemoteContentService

All Implemented Interfaces:

RemoteContentService

Direct Known Subclasses:

GraphQLRemoteContentServiceImpl, RemoteContentServiceImpl

public abstract class AbstractRemoteContentService
extends AbstractRemoteService<ContentService>
implements RemoteContentService

ContentService implementation that communicates with Confluence remotely.

Since:

9.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractRemoteContentService.AbstractRemoteContentFinder

Nested classes/interfaces inherited from interface com.atlassian.confluence.rest.client.RemoteContentService

RemoteContentService.RemoteContentFetcher, RemoteContentService.RemoteContentFinder, RemoteContentService.RemoteParameterContentFinder, RemoteContentService.RemoteSingleContentFetcher

Field Summary

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

provider

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRemoteContentService(AuthenticatedWebResourceProvider provider, ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
protected boolean	containsExperimentalExpansion(Expansion[] expansions)
CompletionStage<Content>	createCompletionStage(Content newContent)	Create a piece of content.
CompletionStage<Content>	createCompletionStage(Content newContent, Expansion... expansions)	Create a piece of content.
CompletionStage<Void>	deleteCompletionStage(Content content)	Removes an item of Content from the system.
CompletionStage<PageResponse<Content>>	getChildrenCompletionStage(Content parent, PageRequest pageRequest, Expansion... expansions)	Retrieve the children of an item of Content.
javax.ws.rs.client.WebTarget	newContentWebResource()
javax.ws.rs.client.WebTarget	newExperimentalContentWebResource()
CompletionStage<Void>	purgeCompletionStage(Content content)	Permanently delete a trashed piece of content.
CompletionStage<Content>	restoreCompletionStage(Content content)	Restore a trashed piece of content.
CompletionStage<Content>	trashCompletionStage(Content content)	Trash a piece of content.
CompletionStage<Content>	updateCompletionStage(Content content)	Updates 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

Methods inherited from interface com.atlassian.confluence.rest.client.RemoteContentService

find

Constructor Details

AbstractRemoteContentService

protected AbstractRemoteContentService(AuthenticatedWebResourceProvider provider,
 ExecutorService executor)

Since:

9.0

Method Details

createCompletionStage

public CompletionStage<Content> createCompletionStage(Content newContent)

Description copied from interface: RemoteContentService

Create a piece of content.

Valid ContentRepresentations for the ContentBody can be found in the documentation on the ContentBodyConversionService.

Specified by:

createCompletionStage in interface RemoteContentService

Parameters:

newContent - the content to create

Returns:

the content created

createCompletionStage

public CompletionStage<Content> createCompletionStage(Content newContent,
 Expansion... expansions)
                                               throws ServiceException

Description copied from interface: RemoteContentService

Create a piece of content.

Valid ContentRepresentations for the ContentBody can be found in the documentation on the ContentBodyConversionService.

Specified by:

createCompletionStage in interface RemoteContentService

Parameters:

newContent - the content to create

expansions - the particular expansions will be applied to the new created content

Returns:

the content created

Throws:

ServiceException - if the content cannot be created

updateCompletionStage

public CompletionStage<Content> updateCompletionStage(Content content)

Description copied from interface: RemoteContentService

Updates a piece of content.

Valid ContentRepresentations for the ContentBody can be found in the documentation on the ContentBodyConversionService.

Specified by:

updateCompletionStage in interface RemoteContentService

Parameters:

content - the updated Content with metadata about the change

Returns:

the updated content after being persisted

trashCompletionStage

public CompletionStage<Content> trashCompletionStage(Content content)

Description copied from interface: RemoteContentService

Trash a piece of content.

The #delete(Content) method should be used for content that doesn't support trashing. Currently Pages and Blogposts support trashing.

Specified by:

trashCompletionStage in interface RemoteContentService

Parameters:

content - the content to be trashed

Returns:

the content after being trashed

restoreCompletionStage

public CompletionStage<Content> restoreCompletionStage(Content content)

Description copied from interface: RemoteContentService

Restore a trashed piece of content.

Specified by:

restoreCompletionStage in interface RemoteContentService

Parameters:

content - the content to be restored

Returns:

the content after being restored

purgeCompletionStage

public CompletionStage<Void> purgeCompletionStage(Content content)

Description copied from interface: RemoteContentService

Permanently delete a trashed piece of content.

Specified by:

purgeCompletionStage in interface RemoteContentService

Parameters:

content - the content to be purged

deleteCompletionStage

public CompletionStage<Void> deleteCompletionStage(Content content)

Description copied from interface: RemoteContentService

Removes an item of Content from the system.

Specified by:

deleteCompletionStage in interface RemoteContentService

Parameters:

content - if of the content to remove

getChildrenCompletionStage

public CompletionStage<PageResponse<Content>> getChildrenCompletionStage(Content parent,
 PageRequest pageRequest,
 Expansion... expansions)

Description copied from interface: RemoteContentService

Retrieve the children of an item of Content.

Children will be Content items of the same type as the parent.

The pageRequest limit is restricted to a maximum page size.

Specified by:

getChildrenCompletionStage in interface RemoteContentService

Parameters:

parent - - the content to retrieve the children for

pageRequest - - a pageRequest indicating how much content to retrieve.

Returns:

a partial list of the top level content in this space.

newContentWebResource

public javax.ws.rs.client.WebTarget newContentWebResource()

newExperimentalContentWebResource

public javax.ws.rs.client.WebTarget newExperimentalContentWebResource()

containsExperimentalExpansion

protected boolean containsExperimentalExpansion(Expansion[] expansions)