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

public class ContentServiceImpl
extends Object
implements ContentService

Constructor Summary

Constructors

Constructor	Description
ContentServiceImpl()

Method Summary

Modifier and Type	Method	Description
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.
AuditServiceInternal	getAuditServiceInternal()
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	getChildrenById(String siteId, String id, String locale, String keyword, List<String> excludes, String sortStrategy, String order, int offset, int limit)	Get list of children for given item id
GetChildrenResult	getChildrenByPath(String siteId, String path, String locale, String keyword, List<String> excludes, String sortStrategy, String order, int offset, int limit)	Get list of children for given path
InputStream	getContentByCommitId(String siteId, String path, String commitId)	Get content for commit id
ContentServiceInternal	getContentServiceInternal()
ContentTypeServiceInternal	getContentTypeServiceInternal()
DependencyServiceInternal	getDependencyServiceInternal()
DeploymentService	getDeploymentService()
GeneralLockService	getGeneralLockService()
org.craftercms.core.service.Item	getItem(String siteId, String path, boolean flatten)
DetailedItem	getItemById(String siteId, long id, boolean preferContent)	Get detailed item for given id
DetailedItem	getItemByPath(String siteId, String path, boolean preferContent)	Get detailed item for given path
ItemServiceInternal	getItemServiceInternal()
List<QuickCreateItem>	getQuickCreatableContentTypes(String siteId)	Get list of content types marked as quick creatable for given site
List<SandboxItem>	getSandboxItemsById(String siteId, List<Long> ids, boolean preferContent)	Get sandbox items for given list of ids
List<SandboxItem>	getSandboxItemsByPath(String siteId, List<String> paths, boolean preferContent)	Get sandbox items for given list of paths
SecurityService	getSecurityService()
SiteService	getSiteService()
UserService	getUserService()
void	lockContent(String siteId, String path)	Lock item by path for given site
void	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setContentServiceInternal(ContentServiceInternal contentServiceInternal)
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	setUserService(UserService userService)
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 Detail

ContentServiceImpl

public ContentServiceImpl()

Method Detail

getQuickCreatableContentTypes

public List<QuickCreateItem> getQuickCreatableContentTypes(String siteId)

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

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)

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

deleteContent

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

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

deleteContent

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

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

getChildrenByPath

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

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

excludes - exclude items by regular expression patterns

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

ContentNotFoundException

getChildrenById

public GetChildrenResult getChildrenById(String siteId,
                                         String id,
                                         String locale,
                                         String keyword,
                                         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 item id

Specified by:

getChildrenById in interface ContentService

Parameters:

siteId - site identifier

id - item id to get children for

locale - filter children by locale

keyword - filter children by keyword

excludes - exclude items by regular expression patterns

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

getItem

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

Specified by:

getItem in interface ContentService

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

getItemById

public DetailedItem getItemById(String siteId,
                                long id,
                                boolean preferContent)
                         throws ServiceLayerException,
                                UserNotFoundException

Description copied from interface: ContentService

Get detailed item for given id

Specified by:

getItemById in interface ContentService

Parameters:

siteId - site identifier

id - item id

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

getSandboxItemsById

public List<SandboxItem> getSandboxItemsById(String siteId,
                                             List<Long> ids,
                                             boolean preferContent)
                                      throws ServiceLayerException,
                                             UserNotFoundException

Description copied from interface: ContentService

Get sandbox items for given list of ids

Specified by:

getSandboxItemsById in interface ContentService

Parameters:

siteId - site identifier

ids - list of ids 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

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

getContentByCommitId

public InputStream getContentByCommitId(String siteId,
                                        String path,
                                        String commitId)
                                 throws ContentNotFoundException,
                                        IOException

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:

Throws:

ContentNotFoundException

IOException

getContentServiceInternal

public ContentServiceInternal getContentServiceInternal()

setContentServiceInternal

public void setContentServiceInternal(ContentServiceInternal contentServiceInternal)

getContentTypeServiceInternal

public ContentTypeServiceInternal getContentTypeServiceInternal()

setContentTypeServiceInternal

public void setContentTypeServiceInternal(ContentTypeServiceInternal contentTypeServiceInternal)

getDependencyServiceInternal

public DependencyServiceInternal getDependencyServiceInternal()

setDependencyServiceInternal

public void setDependencyServiceInternal(DependencyServiceInternal dependencyServiceInternal)

getDeploymentService

public DeploymentService getDeploymentService()

setDeploymentService

public void setDeploymentService(DeploymentService deploymentService)

getUserService

public UserService getUserService()

setUserService

public void setUserService(UserService userService)

getSiteService

public SiteService getSiteService()

setSiteService

public void setSiteService(SiteService siteService)

getAuditServiceInternal

public AuditServiceInternal getAuditServiceInternal()

setAuditServiceInternal

public void setAuditServiceInternal(AuditServiceInternal auditServiceInternal)

getItemServiceInternal

public ItemServiceInternal getItemServiceInternal()

setItemServiceInternal

public void setItemServiceInternal(ItemServiceInternal itemServiceInternal)

getSecurityService

public SecurityService getSecurityService()

setSecurityService

public void setSecurityService(SecurityService securityService)

getGeneralLockService

public GeneralLockService getGeneralLockService()

setGeneralLockService

public void setGeneralLockService(GeneralLockService generalLockService)