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

Class ContentServiceImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.content.ContentServiceImpl

All Implemented Interfaces:

ContentService, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ContentServiceImpl
extends Object
implements ContentService, org.springframework.context.ApplicationContextAware

Constructor Summary

Constructors

Constructor	Description
ContentServiceImpl()

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> systemTypes, 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.
@Valid 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
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setContentServiceInternal(ContentServiceInternal contentServiceInternal)
void	setContentServiceV1(ContentService contentService)
void	setContentTypeServiceInternal(ContentTypeServiceInternal contentTypeServiceInternal)
void	setDependencyServiceInternal(DependencyServiceInternal dependencyServiceInternal)
void	setDeploymentService(DeploymentService deploymentService)
void	setGeneralLockService(GeneralLockService generalLockService)
void	setItemServiceInternal(ItemServiceInternal itemServiceInternal)
void	setSecurityService(SecurityService securityService)
void	setSiteService(SiteService siteService)
void	setUserServiceInternal(UserServiceInternal userServiceInternal)
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ContentServiceImpl

public ContentServiceImpl()

Method Details

contentExists

public boolean contentExists(String siteId,
 String path)
                      throws SiteNotFoundException

Description copied from interface: ContentService

Check the existent of a content path

Specified by:

contentExists in interface ContentService

Parameters:

siteId - site identifier

path - content path

Returns:

true if the content exists, false otherwise

Throws:

SiteNotFoundException

shallowContentExists

public boolean shallowContentExists(String site,
 String path)
                             throws SiteNotFoundException

Description copied from interface: ContentService

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.

Specified by:

shallowContentExists in interface ContentService

Returns:

true if site has content object at path

Throws:

SiteNotFoundException

getQuickCreatableContentTypes

public List<QuickCreateItem> getQuickCreatableContentTypes(String siteId)
                                                    throws SiteNotFoundException

Description copied from interface: ContentService

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

Specified by:

getQuickCreatableContentTypes in interface ContentService

Parameters:

siteId - site id to use

Returns:

list of content types

Throws:

SiteNotFoundException

getChildItems

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

Description copied from interface: ContentService

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

Specified by:

getChildItems in interface ContentService

Parameters:

siteId - site identifier

path - path to get child items for

Returns:

list of paths of child items

getChildItems

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

Description copied from interface: ContentService

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

Specified by:

getChildItems in interface ContentService

Parameters:

siteId - site identifier

paths - list of paths to get child items for

Returns:

list of paths of child items

Throws:

SiteNotFoundException

deleteContent

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

Description copied from interface: ContentService

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

Specified by:

deleteContent in interface ContentService

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

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

Description copied from interface: ContentService

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

Specified by:

deleteContent in interface ContentService

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

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

Description copied from interface: ContentService

Get list of children for given path

Specified by:

getChildrenByPath in interface ContentService

Parameters:

siteId - site identifier

path - item path to children for

locale - filter children by locale

keyword - filter children by keyword

systemTypes - 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

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

Description copied from interface: ContentService

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.

Specified by:

getChildrenByPaths in interface ContentService

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

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

Specified by:

getItem in interface ContentService

Throws:

SiteNotFoundException

ContentNotFoundException

getItemDescriptor

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

Specified by:

getItemDescriptor in interface ContentService

Throws:

SiteNotFoundException

ContentNotFoundException

getItemByPath

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

Description copied from interface: ContentService

Get detailed item for given path

Specified by:

getItemByPath in interface ContentService

Parameters:

siteId - site identifier

path - item path

preferContent - if true return content item if available

Returns:

detailed item

Throws:

ServiceLayerException

UserNotFoundException

getSandboxItemsByPath

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

Description copied from interface: ContentService

Get sandbox items for given list of paths

Specified by:

getSandboxItemsByPath in interface ContentService

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

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

Description copied from interface: ContentService

Lock item by path for given site

Specified by:

lockContent in interface ContentService

Parameters:

siteId - site identifier

path - path to lock

Throws:

UserNotFoundException

ServiceLayerException

unlockContent

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

Description copied from interface: ContentService

Unlock item by path for given site

Specified by:

unlockContent in interface ContentService

Parameters:

siteId - site identifier

path - item path

Throws:

ContentNotFoundException

ContentAlreadyUnlockedException

SiteNotFoundException

getContentByCommitId

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

Description copied from interface: ContentService

Get content for commit id

Specified by:

getContentByCommitId in interface ContentService

Parameters:

siteId - site identifier

path - path of the content

commitId - commit id of the content version

Returns:

the content if available

Throws:

ContentNotFoundException

renameContent

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

Description copied from interface: ContentService

Rename content for given path

Specified by:

renameContent in interface ContentService

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

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

Description copied from interface: ContentService

Returns content wrapped as a Resource instance

Specified by:

getContentAsResource in interface ContentService

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

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

Description copied from interface: ContentService

Get the version history for a given content item.

Specified by:

getContentVersionHistory in interface ContentService

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

setApplicationContext

public void setApplicationContext(@NonNull
 org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

setContentServiceInternal

public void setContentServiceInternal(ContentServiceInternal contentServiceInternal)

setContentTypeServiceInternal

public void setContentTypeServiceInternal(ContentTypeServiceInternal contentTypeServiceInternal)

setDependencyServiceInternal

public void setDependencyServiceInternal(DependencyServiceInternal dependencyServiceInternal)

setDeploymentService

public void setDeploymentService(DeploymentService deploymentService)

setUserServiceInternal

public void setUserServiceInternal(UserServiceInternal userServiceInternal)

setSiteService

public void setSiteService(SiteService siteService)

setAuditServiceInternal

public void setAuditServiceInternal(AuditServiceInternal auditServiceInternal)

setItemServiceInternal

public void setItemServiceInternal(ItemServiceInternal itemServiceInternal)

setSecurityService

public void setSecurityService(SecurityService securityService)

setGeneralLockService

public void setGeneralLockService(GeneralLockService generalLockService)

setContentServiceV1

public void setContentServiceV1(ContentService contentService)