com.atlassian.confluence.plugins.rest.manager

Interface RestContentManager

All Known Implementing Classes:

DefaultRestContentManager

public interface RestContentManager

Responsible for managing ContentEntity objects.

This manager responsible for

• doing any permission checking
• conversion from Confluence's API objects (eg Page, BlogPost) to a REST level ContentEntity.
• providing a generic content interface

Method Summary

Modifier and Type	Method and Description
ContentEntity	convertToContentEntity(ContentEntityObject object) Convert a Confluence model object into its REST representation.
ContentEntity	expand(ContentEntity contentEntity) Expands and returns the given ContentEntity.
ContentEntity	getContentEntity(Long id, boolean expand) Gets the ContentEntity object for the given id and expands it if requested to.

Method Detail

getContentEntity

ContentEntity getContentEntity(Long id,
                               boolean expand)

Gets the ContentEntity object for the given id and expands it if requested to. A convenience method that packages up retrieving the Confluence content, converting it to a REST object and then optionally expanding it.

null is returned if the current user is not permitted to view the content or if no content object can be found for the given id

Parameters:

id - the id of the content entity to retrieve

Returns:

the converted content object or null if not permitted or doesn't exist

convertToContentEntity

ContentEntity convertToContentEntity(ContentEntityObject object)

Convert a Confluence model object into its REST representation. The ContentEntity returned from this method will not be expanded.

Parameters:

object - the ContentEntityObject representation of some Confluence content

Returns:

the equivalent unexpanded ContentEntity

expand

ContentEntity expand(ContentEntity contentEntity)

Expands and returns the given ContentEntity.

Parameters:

contentEntity - the content entity to expand

Returns:

the expanded content entity