Package org.craftercms.studio.api.v2.service.content

Interface ContentService

All Known Implementing Classes:

ContentServiceImpl

public interface ContentService

Method Summary

Modifier and Type	Method	Description
boolean	contentExists(String siteId, String path)	Check the existent of a content path
boolean	deleteContent(String siteId, String path, String submissionComment)	Delete content for given path.
boolean	deleteContent(String siteId, List<String> paths, String submissionComment)	Delete content for given paths.
List<String>	getChildItems(String siteId, String path)	Get child items for given path.
List<String>	getChildItems(String siteId, List<String> paths)	Get child items for given paths.
GetChildrenResult	getChildrenByPath(String siteId, String path, String locale, String keyword, List<String> types, List<String> excludes, String sortStrategy, String order, int offset, int limit)	Get list of children for given path
GetChildrenByPathsBulkResult	getChildrenByPaths(String siteId, List<String> paths, Map<String,GetChildrenBulkRequest.PathParams> pathParams)	Get children for paths bulk.
org.springframework.core.io.Resource	getContentAsResource(String site, String path)	Returns content wrapped as a Resource instance
Optional<org.springframework.core.io.Resource>	getContentByCommitId(String siteId, String path, String commitId)	Get content for commit id
List<ItemVersion>	getContentVersionHistory(String siteId, String path)	Get the version history for a given content item.
org.craftercms.core.service.Item	getItem(String siteId, String path, boolean flatten)
DetailedItem	getItemByPath(String siteId, String path, boolean preferContent)	Get detailed item for given path
org.dom4j.Document	getItemDescriptor(String siteId, String path, boolean flatten)
List<QuickCreateItem>	getQuickCreatableContentTypes(String siteId)	Get list of content types marked as quick creatable for given site
List<SandboxItem>	getSandboxItemsByPath(String siteId, List<String> paths, boolean preferContent)	Get sandbox items for given list of paths
void	lockContent(String siteId, String path)	Lock item by path for given site
boolean	renameContent(String site, String path, String name)	Rename content for given path
boolean	shallowContentExists(String site, String path)	This is a faster, but less accurate, version of contentExists.
void	unlockContent(String siteId, String path)	Unlock item by path for given site

Method Details

contentExists

boolean contentExists(String siteId,
 String path)
               throws SiteNotFoundException

Check the existent of a content path

Parameters:

siteId - site identifier

path - content path

Returns:

true if the content exists, false otherwise

Throws:

SiteNotFoundException

shallowContentExists

boolean shallowContentExists(String site,
 String path)
                      throws SiteNotFoundException

This is a faster, but less accurate, version of contentExists. This prioritizes performance over checking the actual underlying repository if the content is actually in the store or we simply hold a reference to the object in the actual store.

Returns:

true if site has content object at path

Throws:

SiteNotFoundException

getQuickCreatableContentTypes

List<QuickCreateItem> getQuickCreatableContentTypes(String siteId)
                                             throws SiteNotFoundException

Get list of content types marked as quick creatable for given site

Parameters:

siteId - site id to use

Returns:

list of content types

Throws:

SiteNotFoundException

getChildItems

List<String> getChildItems(String siteId,
 String path)

Get child items for given path. Child item is - belongs to item subtree - is item specific dependency

Parameters:

siteId - site identifier

path - path to get child items for

Returns:

list of paths of child items

getChildItems

List<String> getChildItems(String siteId,
 List<String> paths)
                    throws SiteNotFoundException

Get child items for given paths. Child item is - belongs to item subtree - is item specific dependency

Parameters:

siteId - site identifier

paths - list of paths to get child items for

Returns:

list of paths of child items

Throws:

SiteNotFoundException

deleteContent

boolean deleteContent(String siteId,
 String path,
 String submissionComment)
               throws ServiceLayerException,
AuthenticationException,
DeploymentException,
UserNotFoundException

Delete content for given path. Following content will be deleted: - given path - child items for given path

Parameters:

siteId - site identifier

path - content to be deleted

submissionComment - submission comment

Returns:

true if success, otherwise false

Throws:

ServiceLayerException - general service error

AuthenticationException - authentication error

DeploymentException - deployment error caused by delete

UserNotFoundException

deleteContent

boolean deleteContent(String siteId,
 List<String> paths,
 String submissionComment)
               throws ServiceLayerException,
AuthenticationException,
DeploymentException,
UserNotFoundException

Delete content for given paths. Following content will be deleted: - given paths - child items for given paths

Parameters:

siteId - site identifier

paths - content to be deleted

submissionComment - submission comment

Returns:

true if success, otherwise false

Throws:

ServiceLayerException - general service error

AuthenticationException - authentication error

DeploymentException - deployment error caused by delete

UserNotFoundException

getChildrenByPath

GetChildrenResult getChildrenByPath(String siteId,
 String path,
 String locale,
 String keyword,
 List<String> types,
 List<String> excludes,
 String sortStrategy,
 String order,
 int offset,
 int limit)
                             throws ServiceLayerException,
UserNotFoundException

Get list of children for given path

Parameters:

siteId - site identifier

path - item path to children for

locale - filter children by locale

keyword - filter children by keyword

types - filter children by type

excludes - exclude items by path

sortStrategy - sort order

order - ascending or descending

offset - offset of the first child in the result

limit - number of children to return

Returns:

list of children

Throws:

ServiceLayerException

UserNotFoundException

getChildrenByPaths

GetChildrenByPathsBulkResult getChildrenByPaths(String siteId,
 List<String> paths,
 Map<String,GetChildrenBulkRequest.PathParams> pathParams)
                                         throws ServiceLayerException,
UserNotFoundException

Get children for paths bulk. This method will return children for a list of paths. Result items will also include a SandboxItem object for the item itself.

Parameters:

siteId - the site id

paths - paths to get children for. Notice that this parameter is redundant with the pathParams. This list of paths is used to validate permissions.

pathParams - Map of extra parameters for each path

Returns:

object containing a list of GetChildrenByPathsBulkResult.ChildrenByPathResult

Throws:

ServiceLayerException - general service error

UserNotFoundException - user not found (when calculating available actions)

getItem

org.craftercms.core.service.Item getItem(String siteId,
 String path,
 boolean flatten)
                                  throws SiteNotFoundException,
ContentNotFoundException

Throws:

SiteNotFoundException

ContentNotFoundException

getItemDescriptor

org.dom4j.Document getItemDescriptor(String siteId,
 String path,
 boolean flatten)
                              throws SiteNotFoundException,
ContentNotFoundException

Throws:

SiteNotFoundException

ContentNotFoundException

getItemByPath

DetailedItem getItemByPath(String siteId,
 String path,
 boolean preferContent)
                    throws ServiceLayerException,
UserNotFoundException

Get detailed item for given path

Parameters:

siteId - site identifier

path - item path

preferContent - if true return content item if available

Returns:

detailed item

Throws:

ServiceLayerException

UserNotFoundException

getSandboxItemsByPath

List<SandboxItem> getSandboxItemsByPath(String siteId,
 List<String> paths,
 boolean preferContent)
                                 throws ServiceLayerException,
UserNotFoundException

Get sandbox items for given list of paths

Parameters:

siteId - site identifier

paths - list of paths to get sandbox items

preferContent - if true return content items if available

Returns:

list of sandbox items

Throws:

ServiceLayerException

UserNotFoundException

lockContent

void lockContent(String siteId,
 String path)
          throws UserNotFoundException,
ServiceLayerException

Lock item by path for given site

Parameters:

siteId - site identifier

path - path to lock

Throws:

UserNotFoundException

ServiceLayerException

unlockContent

void unlockContent(String siteId,
 String path)
            throws ContentNotFoundException,
ContentAlreadyUnlockedException,
SiteNotFoundException

Unlock item by path for given site

Parameters:

siteId - site identifier

path - item path

Throws:

ContentNotFoundException

ContentAlreadyUnlockedException

SiteNotFoundException

getContentByCommitId

Optional<org.springframework.core.io.Resource> getContentByCommitId(String siteId,
 String path,
 String commitId)
                                                             throws ContentNotFoundException

Get content for commit id

Parameters:

siteId - site identifier

path - path of the content

commitId - commit id of the content version

Returns:

the content if available

Throws:

ContentNotFoundException

renameContent

boolean renameContent(String site,
 String path,
 String name)
               throws ServiceLayerException,
UserNotFoundException,
org.craftercms.commons.validation.ValidationException

Rename content for given path

Parameters:

site - site identifier

path - path of the content

name - new name of the content

Returns:

true if success, otherwise false

Throws:

ServiceLayerException - general service error

UserNotFoundException - user not found error

org.craftercms.commons.validation.ValidationException

getContentAsResource

org.springframework.core.io.Resource getContentAsResource(String site,
 String path)
                                                   throws ContentNotFoundException

Returns content wrapped as a Resource instance

Parameters:

site - the site id

path - the path of the content

Returns:

the resource object

Throws:

ContentNotFoundException - if there is no content at the given path

getContentVersionHistory

List<ItemVersion> getContentVersionHistory(String siteId,
 String path)
                                    throws ServiceLayerException

Get the version history for a given content item.

Parameters:

siteId - the site id

path - the content path

Returns:

the list of versions

Throws:

ServiceLayerException - if an error occurs while create the list of ItemVersions