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

Class ContentServiceInternalImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.content.internal.ContentServiceInternalImpl

All Implemented Interfaces:

ContentServiceInternal

public class ContentServiceInternalImpl
extends Object
implements ContentServiceInternal

Constructor Summary

Constructors

Constructor	Description
ContentServiceInternalImpl()

Method Summary

Modifier and Type	Method	Description
boolean	contentExists(String siteId, String path)	Check the existent of a content path
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.
Optional<org.springframework.core.io.Resource>	getContentByCommitId(String siteId, String path, String commitId)	Get content for commit id
long	getContentSize(String siteId, String path)	Get content size
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 for given path
List<DetailedItem>	getItemsByStates(String siteId, long statesBitMap, List<String> systemTypes, List<org.craftercms.commons.rest.parameters.SortField> sortFields, int offset, int limit)	Get a list of items by state and system types.
List<SandboxItem>	getSandboxItemsById(String siteId, List<Long> ids, List<org.craftercms.commons.rest.parameters.SortField> sortFields, boolean preferContent)	Get sandbox items for given list of paths
List<SandboxItem>	getSandboxItemsByPath(String siteId, Collection<String> paths, boolean preferContent)	Get sandbox items for given list of paths
List<String>	getSubtreeItems(String siteId, String path)	Get subtree items for given path.
List<String>	getSubtreeItems(String siteId, List<String> paths)	Get subtree items for given paths.
boolean	isEditable(String itemPath, String mimeType)	Check if item is editable
void	itemLockByPath(String siteId, String path)	Lock item by path for given site
void	itemUnlockByPath(String siteId, String path)	Unlock item by path for given site
void	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setContentRepository(ContentRepository contentRepository)
void	setItemDao(ItemDAO itemDao)
void	setSecurityService(SecurityService securityService)
void	setSemanticsAvailableActionsResolver(SemanticsAvailableActionsResolver semanticsAvailableActionsResolver)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setSiteFeedMapper(SiteFeedMapper siteFeedMapper)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
boolean	shallowContentExists(String siteId, String path)	This is a faster, but less accurate, version of contentExists.

Methods inherited from class java.lang.Object

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

Constructor Details

ContentServiceInternalImpl

public ContentServiceInternalImpl()

Method Details

contentExists

public boolean contentExists(String siteId,
 String path)

Description copied from interface: ContentServiceInternal

Check the existent of a content path

Specified by:

contentExists in interface ContentServiceInternal

Parameters:

siteId - site identifier

path - content path

Returns:

true if the content exists, false otherwise

shallowContentExists

public boolean shallowContentExists(String siteId,
 String path)

Description copied from interface: ContentServiceInternal

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 ContentServiceInternal

Returns:

true if site has content object at path

getSubtreeItems

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

Description copied from interface: ContentServiceInternal

Get subtree items for given path.

Specified by:

getSubtreeItems in interface ContentServiceInternal

Parameters:

siteId - site identifier

path - path to get subtree items for

Returns:

list of paths of subtree items

getSubtreeItems

public List<String> getSubtreeItems(String siteId,
 List<String> paths)

Description copied from interface: ContentServiceInternal

Get subtree items for given paths.

Specified by:

getSubtreeItems in interface ContentServiceInternal

Parameters:

siteId - site identifier

paths - list of paths to get subtree items for

Returns:

list of paths of subtree items

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: ContentServiceInternal

Get list of children for given path

Specified by:

getChildrenByPath in interface ContentServiceInternal

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 UserNotFoundException,
ServiceLayerException

Description copied from interface: ContentServiceInternal

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 ContentServiceInternal

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:

UserNotFoundException - user not found (when calculating available actions)

ServiceLayerException - general service error

getItem

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

Specified by:

getItem in interface ContentServiceInternal

getContentSize

public long getContentSize(String siteId,
 String path)

Description copied from interface: ContentServiceInternal

Get content size

Specified by:

getContentSize in interface ContentServiceInternal

Parameters:

siteId - site identifier

path - content path

Returns:

size in bytes

getItemsByStates

public List<DetailedItem> getItemsByStates(String siteId,
 long statesBitMap,
 List<String> systemTypes,
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 int offset,
 int limit)
                                    throws UserNotFoundException,
ServiceLayerException

Description copied from interface: ContentServiceInternal

Get a list of items by state and system types.

Specified by:

getItemsByStates in interface ContentServiceInternal

Parameters:

siteId - site identifier

statesBitMap - mask of the states to filter by

systemTypes - list of system types to filter by

sortFields - list of sort fields

offset - number of items to skip

limit - number of items to return

Returns:

list of items

Throws:

UserNotFoundException

ServiceLayerException

getItemByPath

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

Description copied from interface: ContentServiceInternal

Get detailed for given path

Specified by:

getItemByPath in interface ContentServiceInternal

Parameters:

siteId - site identifier

path - item for path

preferContent - if true return content item if available

Returns:

detailed item

Throws:

ServiceLayerException

UserNotFoundException

getSandboxItemsByPath

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

Description copied from interface: ContentServiceInternal

Get sandbox items for given list of paths

Specified by:

getSandboxItemsByPath in interface ContentServiceInternal

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,
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 boolean preferContent)
                                      throws ServiceLayerException,
UserNotFoundException

Description copied from interface: ContentServiceInternal

Get sandbox items for given list of paths

Specified by:

getSandboxItemsById in interface ContentServiceInternal

Parameters:

siteId - site identifier

ids - list of ids to get sandbox items

sortFields -

preferContent - if true return content items if available

Returns:

list of sandbox items

Throws:

ServiceLayerException

UserNotFoundException

isEditable

public boolean isEditable(String itemPath,
 String mimeType)

Description copied from interface: ContentServiceInternal

Check if item is editable

Specified by:

isEditable in interface ContentServiceInternal

Parameters:

itemPath - item path

mimeType - item mime type

Returns:

true if item is editable

itemLockByPath

public void itemLockByPath(String siteId,
 String path)

Description copied from interface: ContentServiceInternal

Lock item by path for given site

Specified by:

itemLockByPath in interface ContentServiceInternal

Parameters:

siteId - site identifier

path - item path to lock

itemUnlockByPath

public void itemUnlockByPath(String siteId,
 String path)

Description copied from interface: ContentServiceInternal

Unlock item by path for given site

Specified by:

itemUnlockByPath in interface ContentServiceInternal

Parameters:

siteId - site identifier

path - item path

getContentByCommitId

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

Description copied from interface: ContentServiceInternal

Get content for commit id

Specified by:

getContentByCommitId in interface ContentServiceInternal

Parameters:

siteId - site identifier

path - path of the content

commitId - commit id of the content version

Returns:

the resource if available

Throws:

ContentNotFoundException

getContentVersionHistory

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

Description copied from interface: ContentServiceInternal

Get the version history for a given content item.

Specified by:

getContentVersionHistory in interface ContentServiceInternal

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

setContentRepository

public void setContentRepository(ContentRepository contentRepository)

setItemDao

public void setItemDao(ItemDAO itemDao)

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

setSiteFeedMapper

public void setSiteFeedMapper(SiteFeedMapper siteFeedMapper)

setSecurityService

public void setSecurityService(SecurityService securityService)

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

setSemanticsAvailableActionsResolver

public void setSemanticsAvailableActionsResolver(SemanticsAvailableActionsResolver semanticsAvailableActionsResolver)

setAuditServiceInternal

public void setAuditServiceInternal(AuditServiceInternal auditServiceInternal)