com.atlassian.confluence.api.service.content
Interface ContentService

All Known Implementing Classes:

ContentServiceImpl

@ExperimentalApi
public interface ContentService

Provides methods for creating, reading, updating and deleting Confluence Content objects such as Pages, BlogPosts and Comments.

Since:

5.5

Nested Class Summary

static interface	ContentService.ContentFetcher A content fetcher that also allows fetching many, this exists as a separate interface to allow the type system to only offer fetchMany methods when appropriate.
static interface	ContentService.ContentFinder A finder for locating content
static interface	ContentService.ParameterContentFinder A content finder allowing various parameters to be set to restrict the fetched content.
static interface	ContentService.SingleContentFetcher
static interface	ContentService.Validator Provides methods for validating the create, update and delete methods.

Method Summary

Content	create(Content newContent) Create a piece of content.
void	delete(Content content) Removes an item of Content from the system.
ContentService.ContentFinder	find(Expansion... expansions) Create a ContentFinder for locating content, the expansions will be applied to each piece of content that matches the finder.
Content	update(Content content) Updates a piece of content.
ContentService.Validator	validator() get the validator view of the ContentService.

Method Detail

find

ContentService.ContentFinder find(Expansion... expansions)

Create a ContentFinder for locating content, the expansions will be applied to each piece of content that matches the finder. Content will be retrieved by using the fetch methods on the returned ContentFinder. For example, to fetch the first 50 blog posts in the DEV Space :

     contentService.find()
     .withSpace("DEV")
     .withType(ContentType.BLOG_POST)
     .fetchMany(new SimplePageRequest(0,50);
     
 

Parameters:

expansions -

Returns:

create

Content create(Content newContent)
               throws ServiceException

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

Content update(Content content)
               throws ServiceException

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

Throws:

ServiceException

delete

void delete(Content content)
            throws ServiceException

Removes an item of Content from the system.

Parameters:

content - the content to remove

Throws:

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

validator

ContentService.Validator validator()

get the validator view of the ContentService.

Returns:

a validator for validating actions performed by the ContentService