com.atlassian.confluence.api.service.content

Interface ContentService

@ExperimentalApi
public interface ContentService

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ContentService.ContentFetcher
static interface	ContentService.ContentFinder
static interface	ContentService.ParameterContentFinder
static interface	ContentService.SingleContentFetcher
static interface	ContentService.Validator Provides methods for validating the create, update and delete methods.

Method Summary

Methods

Modifier and Type	Method and Description
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.
com.atlassian.fugue.Option<Macro>	findMacroByHash(ContentId contentId, java.lang.String versionId, java.lang.String hash, Expansion... expansions) Retrieve details about a macro matching the page, version and macro hash.
Content	update(Content content) Updates a piece of content.
ContentService.Validator	validator() get the validator view of the ContentService.

Method Detail

findMacroByHash

com.atlassian.fugue.Option<Macro> findMacroByHash(ContentId contentId,
                                                java.lang.String versionId,
                                                java.lang.String hash,
                                                Expansion... expansions)
                                                  throws ServiceException

Retrieve details about a macro matching the page, version and macro hash.

Parameters:

contentId - The content to scan for the macro

versionId - The version of the page to scan for the macro

hash - The hash identifying the body of the macro

Returns:

Optionally return a Macro matching the given criteria

Throws:

ServiceException

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.

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. //TODO current naming will lead to calls of the form validator().validateCreate(content), would validate().create(content) be better (it's terser at least)?

Returns: