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

Class ItemServiceInternalImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.item.internal.ItemServiceInternalImpl

All Implemented Interfaces:

ItemServiceInternal

public class ItemServiceInternalImpl
extends Object
implements ItemServiceInternal

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final String	DISABLED
static final String	INTERNAL_NAME
static final String	LOCALE_CODE

Constructor Summary

Constructors

Constructor	Description
ItemServiceInternalImpl()

Method Summary

Modifier and Type	Method	Description
void	clearPreviousPath(String siteId, String path)	Clear previous path of the content
PublishingDashboardItem	convertHistoryItemToDashboardItem(PublishingHistoryItem historyItem)	Convert Publishing History Item to Publishing Dashboard Item
int	countAllContentItems()	Count all content items
void	deleteItem(String siteId, String path)	Delete item
void	deleteItemForFolder(long siteId, String folderPath)	Delete items for site and paths
void	deleteItemsForSite(long siteId)	Delete all items for site
protected String	getBrowserUri(String uri, String replacePattern, boolean isPage)
String	getBrowserUrl(String site, String path)	Get browser url for given repository item
List<String>	getChangeSetForSubtree(String siteId, String path)	Get change set for subtree
List<String>	getExistingRenamedChildrenOfMandatoryParentsForPublishing(String siteId, List<String> parents)	Get existing renamed children of mandatory parents for publishing
List<Item>	getInProgressItems(String siteId)	Get in progress items for given site
DetailedItem	getItem(String siteId, long id)	Get item by given id
Item	getItem(String siteId, String path)	Get item fir given site and path
Item	getItem(String siteId, String path, boolean preferContent)	Get item fir given site and path
List<Item>	getItems(String siteId, List<String> paths)	Get items for given site and paths
List<Item>	getItems(String siteId, List<String> paths, boolean preferContent)	Get items for given site and paths
List<Item>	getItemStates(String siteId, String path, Long states, List<String> systemTypes, List<org.craftercms.commons.rest.parameters.SortField> sortFields, int offset, int limit)	Get item states for given filters by path regex and states mask
int	getItemStatesTotal(String siteId, String path, Long states, List<String> systemTypes)	Get total number of item states records for given filters by path regex and states mask
List<String>	getMandatoryParentsForPublishing(String siteId, List<String> paths)	Get mandatory parents for publishing for given site and list of paths
protected long	getResetStatesMask(boolean clearSystemProcessing, boolean clearUserLocked, Boolean live, Boolean staged, Boolean isNew, Boolean modified)
protected long	getSetStatesMask(Boolean live, Boolean staged, Boolean isNew, Boolean modified)
List<String>	getSubtreeForDelete(String siteId, String path)	Get subtree for delete
Item.Builder	instantiateItem(String siteName, String path)
boolean	isNew(String siteId, String path)	Check if item is new
boolean	isSystemProcessing(String siteId, String path)	Check if item is in system processing
boolean	isUpdatedOrNew(String siteId, String path)	Check if item is update or new
void	lockItemByPath(String siteId, String path, String username)	Lock item for given lock owner
void	moveItem(String siteId, String oldPath, String newPath, Long parentId, String label)	Move item
void	persistItemAfterCreate(String siteId, String path, String username, String commitId, boolean unlock, Long parentId)	Persist item metadata after create
void	persistItemAfterCreateFolder(String siteId, String folderPath, String folderName, String username, String commitId, Long parentId)	Persist item metadata after create folder
void	persistItemAfterRenameContent(String siteId, String path, String name, String username, String commitId, String contentType)	Persist item metadata after rename folder
void	persistItemAfterWrite(String siteId, String path, String username, String commitId, boolean unlock)	Persist item metadata after write
boolean	previousPathExists(String siteId, String path)	Check if path exists as previous path
void	setContentService(ContentService contentService)
void	setContentServiceInternal(ContentServiceInternal contentServiceInternal)
void	setGeneralLockService(GeneralLockService generalLockService)
void	setItemDao(ItemDAO itemDao)
void	setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setSiteFeedMapper(SiteFeedMapper siteFeedMapper)
void	setSystemProcessing(String siteId, String path, boolean isSystemProcessing)	Set system processing for item
void	setSystemProcessingBulk(String siteId, List<String> paths, boolean isSystemProcessing)	Set system processing for items
void	setUserServiceInternal(UserServiceInternal userServiceInternal)
void	unlockItemByPath(String siteId, String path)	Unlock item
void	updateCommitId(String siteId, String path, String commitId)	Update commit id for item
void	updateItem(Item item)	Update item
void	updateItemStates(String siteId, List<String> paths, boolean clearSystemProcessing, boolean clearUserLocked, Boolean live, Boolean staged, Boolean isNew, Boolean modified)	Update item state flags for given items
void	updateItemStatesByQuery(String siteId, String path, Long states, boolean clearSystemProcessing, boolean clearUserLocked, Boolean live, Boolean staged, Boolean isNew, Boolean modified)	Update item state flags for given path query
void	updateLastPublishedOn(String siteId, String path, ZonedDateTime lastPublishedOn)	Update last published date for item
void	updateNewPageChildren(String siteId, String folderPath)	Updates a new page's children (in case the folder existed before the page was created) to point to the new page.
void	updateStateBits(String siteId, String path, long onStateBitMap, long offStateBitMap)	Update states to flip on list off states and flip off another list of states for item
void	updateStateBitsBulk(String siteId, Collection<String> paths, long onStateBitMap, long offStateBitMap)	Update states to flip on list off states and flip off another list of states for items
void	updateStatesForSite(String siteId, long onStateBitMap, long offStateBitMap)	Update states for all content in the given site
boolean	upsertEntry(Item item)	Insert record for item if it does not exist, otherwise update it

Methods inherited from class java.lang.Object

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

Field Details

INTERNAL_NAME

public static final String INTERNAL_NAME

See Also:

• Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

DISABLED

public static final String DISABLED

See Also:

• Constant Field Values

LOCALE_CODE

public static final String LOCALE_CODE

See Also:

• Constant Field Values

Constructor Details

ItemServiceInternalImpl

public ItemServiceInternalImpl()

Method Details

upsertEntry

public boolean upsertEntry(Item item)

Description copied from interface: ItemServiceInternal

Insert record for item if it does not exist, otherwise update it

Specified by:

upsertEntry in interface ItemServiceInternal

Parameters:

item - item to add or update

getItem

public DetailedItem getItem(String siteId,
 long id)

Description copied from interface: ItemServiceInternal

Get item by given id

Specified by:

getItem in interface ItemServiceInternal

Parameters:

siteId - site identifier

id - item id

Returns:

item

getItem

public Item getItem(String siteId,
 String path)

Description copied from interface: ItemServiceInternal

Get item fir given site and path

Specified by:

getItem in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - item path

Returns:

item

getItem

public Item getItem(String siteId,
 String path,
 boolean preferContent)

Description copied from interface: ItemServiceInternal

Get item fir given site and path

Specified by:

getItem in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - item path

preferContent - if true return content item if available

Returns:

item

getItems

public List<Item> getItems(String siteId,
 List<String> paths)

Description copied from interface: ItemServiceInternal

Get items for given site and paths

Specified by:

getItems in interface ItemServiceInternal

Parameters:

siteId - site identifier

paths - item paths

Returns:

list of items

getItems

public List<Item> getItems(String siteId,
 List<String> paths,
 boolean preferContent)

Description copied from interface: ItemServiceInternal

Get items for given site and paths

Specified by:

getItems in interface ItemServiceInternal

Parameters:

siteId - site identifier

paths - item paths

preferContent - if true return content item if available

Returns:

list of items

deleteItem

public void deleteItem(String siteId,
 String path)

Description copied from interface: ItemServiceInternal

Delete item

Specified by:

deleteItem in interface ItemServiceInternal

Parameters:

siteId - siteIdentifier

path - path of item to be deleted

updateItem

public void updateItem(Item item)

Description copied from interface: ItemServiceInternal

Update item

Specified by:

updateItem in interface ItemServiceInternal

Parameters:

item - item to update

setSystemProcessing

public void setSystemProcessing(String siteId,
 String path,
 boolean isSystemProcessing)

Description copied from interface: ItemServiceInternal

Set system processing for item

Specified by:

setSystemProcessing in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path of the item

isSystemProcessing - true if item is being processed by system, otherwise false

setSystemProcessingBulk

public void setSystemProcessingBulk(String siteId,
 List<String> paths,
 boolean isSystemProcessing)

Description copied from interface: ItemServiceInternal

Set system processing for items

Specified by:

setSystemProcessingBulk in interface ItemServiceInternal

Parameters:

siteId - site identifier

paths - paths of items

isSystemProcessing - true if item is being processed by system, otherwise false

updateStateBits

public void updateStateBits(String siteId,
 String path,
 long onStateBitMap,
 long offStateBitMap)

Description copied from interface: ItemServiceInternal

Update states to flip on list off states and flip off another list of states for item

Specified by:

updateStateBits in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path of item

onStateBitMap - states bitmap to flip on

offStateBitMap - stats bitmap to flip off

updateStateBitsBulk

public void updateStateBitsBulk(String siteId,
 Collection<String> paths,
 long onStateBitMap,
 long offStateBitMap)

Description copied from interface: ItemServiceInternal

Update states to flip on list off states and flip off another list of states for items

Specified by:

updateStateBitsBulk in interface ItemServiceInternal

Parameters:

siteId - site identifier

paths - list of paths of items

onStateBitMap - states bitmap to flip on

offStateBitMap - stats bitmap to flip off

instantiateItem

public Item.Builder instantiateItem(String siteName,
 String path)

Specified by:

instantiateItem in interface ItemServiceInternal

deleteItemsForSite

public void deleteItemsForSite(long siteId)

Description copied from interface: ItemServiceInternal

Delete all items for site

Specified by:

deleteItemsForSite in interface ItemServiceInternal

Parameters:

siteId - site id

getBrowserUrl

public String getBrowserUrl(String site,
 String path)

Description copied from interface: ItemServiceInternal

Get browser url for given repository item

Specified by:

getBrowserUrl in interface ItemServiceInternal

Parameters:

site - site identifier

path - path of the content

Returns:

browser url

getBrowserUri

protected String getBrowserUri(String uri,
 String replacePattern,
 boolean isPage)

persistItemAfterCreate

public void persistItemAfterCreate(String siteId,
 String path,
 String username,
 String commitId,
 boolean unlock,
 Long parentId)
                            throws ServiceLayerException,
UserNotFoundException

Description copied from interface: ItemServiceInternal

Persist item metadata after create

Specified by:

persistItemAfterCreate in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path of the content

username - user that executed write operation

commitId - commit id of the write operation

unlock - Indicates if content needs to be unlocked after write (save & close)

parentId - id of parent item

Throws:

ServiceLayerException

UserNotFoundException

persistItemAfterWrite

public void persistItemAfterWrite(String siteId,
 String path,
 String username,
 String commitId,
 boolean unlock)
                           throws ServiceLayerException,
UserNotFoundException

Description copied from interface: ItemServiceInternal

Persist item metadata after write

Specified by:

persistItemAfterWrite in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path of the content

username - user that executed write operation

commitId - commit id of the write operation

unlock - Indicates if content needs to be unlocked after write (save & close)

Throws:

ServiceLayerException

UserNotFoundException

persistItemAfterCreateFolder

public void persistItemAfterCreateFolder(String siteId,
 String folderPath,
 String folderName,
 String username,
 String commitId,
 Long parentId)
                                  throws ServiceLayerException,
UserNotFoundException

Description copied from interface: ItemServiceInternal

Persist item metadata after create folder

Specified by:

persistItemAfterCreateFolder in interface ItemServiceInternal

Parameters:

siteId - site identifier

folderPath - folder path

folderName - folder name

username - user that executed create folder operation

commitId - commit id of the create folder operation

parentId - id of parent item

Throws:

ServiceLayerException

UserNotFoundException

persistItemAfterRenameContent

public void persistItemAfterRenameContent(String siteId,
 String path,
 String name,
 String username,
 String commitId,
 String contentType)
                                   throws ServiceLayerException,
UserNotFoundException

Description copied from interface: ItemServiceInternal

Persist item metadata after rename folder

Specified by:

persistItemAfterRenameContent in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - file path

name - file name

username - user that executed create folder operation

commitId - commit id of the create folder operation

contentType - content type

Throws:

ServiceLayerException

UserNotFoundException

moveItem

public void moveItem(String siteId,
 String oldPath,
 String newPath,
 Long parentId,
 String label)

Description copied from interface: ItemServiceInternal

Move item

Specified by:

moveItem in interface ItemServiceInternal

Parameters:

siteId - site identifier

oldPath - old path

newPath - new path

parentId - new parent ID

label - new label

isNew

public boolean isNew(String siteId,
 String path)

Description copied from interface: ItemServiceInternal

Check if item is new

Specified by:

isNew in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path of the item

Returns:

true if NEW flag is set otherwise false

countAllContentItems

public int countAllContentItems()

Description copied from interface: ItemServiceInternal

Count all content items

Specified by:

countAllContentItems in interface ItemServiceInternal

Returns:

number of content items in the system

clearPreviousPath

public void clearPreviousPath(String siteId,
 String path)

Description copied from interface: ItemServiceInternal

Clear previous path of the content

Specified by:

clearPreviousPath in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path of the content;

convertHistoryItemToDashboardItem

public PublishingDashboardItem convertHistoryItemToDashboardItem(PublishingHistoryItem historyItem)

Description copied from interface: ItemServiceInternal

Convert Publishing History Item to Publishing Dashboard Item

Specified by:

convertHistoryItemToDashboardItem in interface ItemServiceInternal

Parameters:

historyItem - publishing history item

Returns:

publishing dashboard item

getInProgressItems

public List<Item> getInProgressItems(String siteId)

Description copied from interface: ItemServiceInternal

Get in progress items for given site

Specified by:

getInProgressItems in interface ItemServiceInternal

Parameters:

siteId - site identifier

Returns:

list of items

isUpdatedOrNew

public boolean isUpdatedOrNew(String siteId,
 String path)

Description copied from interface: ItemServiceInternal

Check if item is update or new

Specified by:

isUpdatedOrNew in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - item path

Returns:

true if item is new or modified

deleteItemForFolder

public void deleteItemForFolder(long siteId,
 String folderPath)

Description copied from interface: ItemServiceInternal

Delete items for site and paths

Specified by:

deleteItemForFolder in interface ItemServiceInternal

Parameters:

siteId - site id

folderPath - folder path to delete

isSystemProcessing

public boolean isSystemProcessing(String siteId,
 String path)

Description copied from interface: ItemServiceInternal

Check if item is in system processing

Specified by:

isSystemProcessing in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - item path

Returns:

true if item is in system processing

previousPathExists

public boolean previousPathExists(String siteId,
 String path)

Description copied from interface: ItemServiceInternal

Check if path exists as previous path

Specified by:

previousPathExists in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path to check

Returns:

true if item exists with previous path as given path

updateCommitId

public void updateCommitId(String siteId,
 String path,
 String commitId)

Description copied from interface: ItemServiceInternal

Update commit id for item

Specified by:

updateCommitId in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path of the item

commitId - commit id

getMandatoryParentsForPublishing

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

Description copied from interface: ItemServiceInternal

Get mandatory parents for publishing for given site and list of paths

Specified by:

getMandatoryParentsForPublishing in interface ItemServiceInternal

Parameters:

siteId - site identifier

paths - list of paths

Returns:

list of mandatory parents paths

getExistingRenamedChildrenOfMandatoryParentsForPublishing

public List<String> getExistingRenamedChildrenOfMandatoryParentsForPublishing(String siteId,
 List<String> parents)

Description copied from interface: ItemServiceInternal

Get existing renamed children of mandatory parents for publishing

Specified by:

getExistingRenamedChildrenOfMandatoryParentsForPublishing in interface ItemServiceInternal

Parameters:

siteId - site identifier

parents - list of parents paths

Returns:

list of children paths

getChangeSetForSubtree

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

Description copied from interface: ItemServiceInternal

Get change set for subtree

Specified by:

getChangeSetForSubtree in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - root path of the subtree

Returns:

list of items

updateLastPublishedOn

public void updateLastPublishedOn(String siteId,
 String path,
 ZonedDateTime lastPublishedOn)

Description copied from interface: ItemServiceInternal

Update last published date for item

Specified by:

updateLastPublishedOn in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path of the item

lastPublishedOn - published date

lockItemByPath

public void lockItemByPath(String siteId,
 String path,
 String username)
                    throws UserNotFoundException,
ServiceLayerException

Description copied from interface: ItemServiceInternal

Lock item for given lock owner

Specified by:

lockItemByPath in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - item path

username - user that owns the lock

Throws:

UserNotFoundException

ServiceLayerException

unlockItemByPath

public void unlockItemByPath(String siteId,
 String path)

Description copied from interface: ItemServiceInternal

Unlock item

Specified by:

unlockItemByPath in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - item path

getItemStatesTotal

public int getItemStatesTotal(String siteId,
 String path,
 Long states,
 List<String> systemTypes)

Description copied from interface: ItemServiceInternal

Get total number of item states records for given filters by path regex and states mask

Specified by:

getItemStatesTotal in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path regex to filter items

states - states mask to filter items by state

Returns:

number of records

getItemStates

public List<Item> getItemStates(String siteId,
 String path,
 Long states,
 List<String> systemTypes,
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 int offset,
 int limit)

Description copied from interface: ItemServiceInternal

Get item states for given filters by path regex and states mask

Specified by:

getItemStates in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path regex to filter items

states - states mask to filter items by state

systemTypes - system types to filter items

sortFields - sort fields

offset - offset for the first record in result set

limit - number of item states records to return

Returns:

list of sandbox items

updateItemStates

public void updateItemStates(String siteId,
 List<String> paths,
 boolean clearSystemProcessing,
 boolean clearUserLocked,
 Boolean live,
 Boolean staged,
 Boolean isNew,
 Boolean modified)

Description copied from interface: ItemServiceInternal

Update item state flags for given items

Specified by:

updateItemStates in interface ItemServiceInternal

Parameters:

siteId - site identifier

paths - item paths

clearSystemProcessing - if true clear system processing flag, otherwise ignore

clearUserLocked - if true clear user locked flag, otherwise ignore

live - if true set live flag, otherwise reset it

staged - if true set staged flag, otherwise reset it

isNew - value to set the 'new' flag to, or null if the flag should not change

modified - value to set the 'modified' flag to, or null if the flag should not change

getSetStatesMask

protected long getSetStatesMask(Boolean live,
 Boolean staged,
 Boolean isNew,
 Boolean modified)

getResetStatesMask

protected long getResetStatesMask(boolean clearSystemProcessing,
 boolean clearUserLocked,
 Boolean live,
 Boolean staged,
 Boolean isNew,
 Boolean modified)

updateItemStatesByQuery

public void updateItemStatesByQuery(String siteId,
 String path,
 Long states,
 boolean clearSystemProcessing,
 boolean clearUserLocked,
 Boolean live,
 Boolean staged,
 Boolean isNew,
 Boolean modified)

Description copied from interface: ItemServiceInternal

Update item state flags for given path query

Specified by:

updateItemStatesByQuery in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - path regex to identify items

clearSystemProcessing - if true clear system processing flag, otherwise ignore

clearUserLocked - if true clear user locked flag, otherwise ignore

live - if true set live flag, otherwise reset it

staged - if true set staged flag, otherwise reset it

isNew - value to set the 'new' flag to, or null if the flag should not change

modified - value to set the 'modified' flag to, or null if the flag should not change

getSubtreeForDelete

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

Description copied from interface: ItemServiceInternal

Get subtree for delete

Specified by:

getSubtreeForDelete in interface ItemServiceInternal

Parameters:

siteId - site identifier

path - root path of the subtree

Returns:

list of items

updateStatesForSite

public void updateStatesForSite(String siteId,
 long onStateBitMap,
 long offStateBitMap)

Description copied from interface: ItemServiceInternal

Update states for all content in the given site

Specified by:

updateStatesForSite in interface ItemServiceInternal

Parameters:

siteId - site identifier

onStateBitMap - states bitmap to flip on

offStateBitMap - states bitmap to flip off

updateNewPageChildren

public void updateNewPageChildren(String siteId,
 String folderPath)

Description copied from interface: ItemServiceInternal

Updates a new page's children (in case the folder existed before the page was created) to point to the new page.

Specified by:

updateNewPageChildren in interface ItemServiceInternal

Parameters:

siteId - site identifier

folderPath - path of the folder where the new index.xml has been added

setUserServiceInternal

public void setUserServiceInternal(UserServiceInternal userServiceInternal)

setSiteFeedMapper

public void setSiteFeedMapper(SiteFeedMapper siteFeedMapper)

setItemDao

public void setItemDao(ItemDAO itemDao)

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

setContentServiceInternal

public void setContentServiceInternal(ContentServiceInternal contentServiceInternal)

setContentService

public void setContentService(ContentService contentService)

setGeneralLockService

public void setGeneralLockService(GeneralLockService generalLockService)

setRetryingDatabaseOperationFacade

public void setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)