com.atlassian.confluence.rest.client
Interface RemoteContentService

All Known Implementing Classes:

RemoteContentServiceImpl

@ExperimentalApi
public interface RemoteContentService

ContentService implementation that communicates with Confluence remotely using the Confluence REST API. Provides future returning equivalents for the methods in ContentService.

Nested Class Summary

static interface	RemoteContentService.RemoteContentFetcher
static interface	RemoteContentService.RemoteContentFinder
static interface	RemoteContentService.RemoteParameterContentFinder
static interface	RemoteContentService.RemoteSingleContentFetcher

Method Summary

com.atlassian.util.concurrent.Promise<Content>	create(Content newContent) Create a piece of content.
com.atlassian.util.concurrent.Promise<Void>	delete(Content content) Removes an item of Content from the system.
RemoteContentService.RemoteContentFinder	find(Expansion... expansions) Create a content finder to retrieve content from the remote server
com.atlassian.util.concurrent.Promise<PageResponse<Content>>	getChildren(Content parent, PageRequest pageRequest, Expansion... expansion) Retrieve the children of an item of Content.
com.atlassian.util.concurrent.Promise<Void>	purge(Content content) Permanently delete a trashed piece of content.
com.atlassian.util.concurrent.Promise<Content>	restore(Content content) Restore a trashed piece of content.
com.atlassian.util.concurrent.Promise<Content>	trash(Content content) Trash a piece of content.
com.atlassian.util.concurrent.Promise<Content>	update(Content content) Updates a piece of content.

Method Detail

find

RemoteContentService.RemoteContentFinder find(Expansion... expansions)

Create a content finder to retrieve content from the remote server

Returns:

the content, if one exists matching the id, or none otherwise.

create

com.atlassian.util.concurrent.Promise<Content> create(Content newContent)

Create a piece of content.

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

Parameters:

newContent - the content to create

Returns:

the content created

Throws:

ServiceException - if the content cannot be created

update

com.atlassian.util.concurrent.Promise<Content> update(Content content)

Updates a piece of content.

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

Parameters:

content - the updated Content with metadata about the change

Returns:

the updated content after being persisted

trash

com.atlassian.util.concurrent.Promise<Content> trash(Content content)

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.

Parameters:

content - the content to be trashed

Returns:

the content after being trashed

restore

com.atlassian.util.concurrent.Promise<Content> restore(Content content)

Restore a trashed piece of content.

Parameters:

content - the content to be restored

Returns:

the content after being restored

purge

com.atlassian.util.concurrent.Promise<Void> purge(Content content)

Permanently delete a trashed piece of content.

Parameters:

content - the content to be purged

delete

com.atlassian.util.concurrent.Promise<Void> delete(Content content)

Removes an item of Content from the system.

Parameters:

content - if of the content to remove

Throws:

ServiceException - if the content cannot be found, or cannot be deleted

getChildren

com.atlassian.util.concurrent.Promise<PageResponse<Content>> getChildren(Content parent,
                                                                         PageRequest pageRequest,
                                                                         Expansion... expansion)

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.

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.