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

Class DependencyServiceInternalImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.dependency.internal.DependencyServiceInternalImpl

All Implemented Interfaces:

DependencyServiceInternal

public class DependencyServiceInternalImpl
extends Object
implements DependencyServiceInternal

Constructor Summary

Constructors

Constructor	Description
DependencyServiceInternalImpl()

Method Summary

Modifier and Type	Method	Description
void	deleteItemDependencies(String site, String sourcePath)	Delete the dependencies of sourcePath
List<DependencyItem>	getDependentItems(String siteId, String path)	Get list of paths of content items that are dependent on given path
List<String>	getDependentPaths(String siteId, List<String> paths)	Get list of paths of content items that are dependent on given paths
List<String>	getHardDependencies(String site, List<String> paths)	Get a hard dependencies of a item.
List<String>	getItemSpecificDependencies(String siteId, String path)	Get item specific dependencies for given path
List<String>	getItemSpecificDependencies(String siteId, List<String> paths)	Get item specific dependencies for given path
protected List<String>	getItemSpecificDependenciesPatterns()
Collection<String>	getSoftDependencies(String site, List<String> paths)	Get a soft dependencies of a list of items.
void	invalidateDependencies(String siteId, String targetPath)	Mark as invalid the dependency records with the given target path
boolean	isValidDependencySource(String siteId, String path)	Indicate if the given path is a valid dependency source. e.g.: templates, pages, components Some files cannot have dependencies, like images or txt files
Map<String,Set<DependencyResolver.ResolvedDependency>>	resolveDependencies(String siteId, String path)	Resolves dependent files for given content of given path
void	setDependencyDao(DependencyDAO dependencyDao)
void	setDependencyResolver(DependencyResolver dependencyResolver)
void	setGeneralLockService(GeneralLockService generalLockService)
void	setItemServiceInternal(ItemServiceInternal itemServiceInternal)
void	setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
void	upsertDependencies(String site, String path)	Scan item for direct dependencies and synchronize those to the dependencies database adding the new deps, updating existing, and removing what was removed from the item.
void	validateDependencies(String siteId)	Mark as valid/invalid all site dependencies depending on the existence of the target_path in the site
void	validateDependencies(String siteId, String targetPath)	Mark as valid the dependency records with the given target path

Methods inherited from class java.lang.Object

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

Constructor Details

DependencyServiceInternalImpl

public DependencyServiceInternalImpl()

Method Details

getSoftDependencies

public Collection<String> getSoftDependencies(String site,
 List<String> paths)

Description copied from interface: DependencyServiceInternal

Get a soft dependencies of a list of items. A soft dependency is: * an edited, shared (not item specific) dependency

Specified by:

getSoftDependencies in interface DependencyServiceInternal

Parameters:

site - Site to operate on

paths - List of paths to items to retrieve deps for

Returns:

list of soft dependencies

getItemSpecificDependenciesPatterns

protected List<String> getItemSpecificDependenciesPatterns()

getHardDependencies

public List<String> getHardDependencies(String site,
 List<String> paths)

Description copied from interface: DependencyServiceInternal

Get a hard dependencies of a item. A hard dependency is: * Never-published item that this item depends on * Item-specific dependency that has been modified but not published

Specified by:

getHardDependencies in interface DependencyServiceInternal

Parameters:

site - Site to operate on

paths - List of paths to items to retrieve deps for

Returns:

list of hard dependencies

getDependentPaths

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

Description copied from interface: DependencyServiceInternal

Get list of paths of content items that are dependent on given paths

Specified by:

getDependentPaths in interface DependencyServiceInternal

Parameters:

siteId - site identifier

paths - list of paths to get dependent items for

Returns:

list of paths dependent on given paths

getDependentItems

public List<DependencyItem> getDependentItems(String siteId,
 String path)

Description copied from interface: DependencyServiceInternal

Get list of paths of content items that are dependent on given path

Specified by:

getDependentItems in interface DependencyServiceInternal

Parameters:

siteId - site identifier

path - path to get dependent items for

Returns:

list of DependencyItem dependent on given path

getItemSpecificDependencies

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

Description copied from interface: DependencyServiceInternal

Get item specific dependencies for given path

Specified by:

getItemSpecificDependencies in interface DependencyServiceInternal

Parameters:

siteId - site identifier

path - path to get item specific dependencies for

Returns:

list of item specific dependencies

getItemSpecificDependencies

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

Description copied from interface: DependencyServiceInternal

Get item specific dependencies for given path

Specified by:

getItemSpecificDependencies in interface DependencyServiceInternal

Parameters:

siteId - site identifier

paths - path to get item specific dependencies for

Returns:

list of item specific dependencies

resolveDependencies

public Map<String,Set<DependencyResolver.ResolvedDependency>> resolveDependencies(String siteId,
 String path)

Description copied from interface: DependencyServiceInternal

Resolves dependent files for given content of given path

Specified by:

resolveDependencies in interface DependencyServiceInternal

Parameters:

siteId - the site id

path - the path to resolve dependencies for

Returns:

Map of ResolvedDependency's of files that content is dependent on by type

upsertDependencies

@Transactional
public void upsertDependencies(String site,
 String path)
                        throws ServiceLayerException

Description copied from interface: DependencyServiceInternal

Scan item for direct dependencies and synchronize those to the dependencies database adding the new deps, updating existing, and removing what was removed from the item.

Specified by:

upsertDependencies in interface DependencyServiceInternal

Parameters:

site - Site to operate on

path - Path to item to scan

Throws:

ServiceLayerException - Internal error, see exception details

deleteItemDependencies

public void deleteItemDependencies(String site,
 String sourcePath)
                            throws ServiceLayerException

Description copied from interface: DependencyServiceInternal

Delete the dependencies of sourcePath

Specified by:

deleteItemDependencies in interface DependencyServiceInternal

Parameters:

site - the site id

sourcePath - the source path of the dependencies to delete

Throws:

ServiceLayerException

invalidateDependencies

public void invalidateDependencies(String siteId,
 String targetPath)
                            throws ServiceLayerException

Description copied from interface: DependencyServiceInternal

Mark as invalid the dependency records with the given target path

Specified by:

invalidateDependencies in interface DependencyServiceInternal

Parameters:

siteId - the site id

targetPath - the target path of the dependencies to invalidate

Throws:

ServiceLayerException

validateDependencies

public void validateDependencies(String siteId,
 String targetPath)
                          throws ServiceLayerException

Description copied from interface: DependencyServiceInternal

Mark as valid the dependency records with the given target path

Specified by:

validateDependencies in interface DependencyServiceInternal

Parameters:

siteId - the site id

targetPath - the target path of the dependencies to validate

Throws:

ServiceLayerException

validateDependencies

public void validateDependencies(String siteId)

Description copied from interface: DependencyServiceInternal

Mark as valid/invalid all site dependencies depending on the existence of the target_path in the site

Specified by:

validateDependencies in interface DependencyServiceInternal

Parameters:

siteId - the site id

isValidDependencySource

public boolean isValidDependencySource(String siteId,
 String path)

Description copied from interface: DependencyServiceInternal

Indicate if the given path is a valid dependency source. e.g.: templates, pages, components Some files cannot have dependencies, like images or txt files

Specified by:

isValidDependencySource in interface DependencyServiceInternal

Parameters:

siteId - the site id

path - the path to check

Returns:

true if the path is a valid dependency source, false otherwise

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

setDependencyDao

public void setDependencyDao(DependencyDAO dependencyDao)

setItemServiceInternal

public void setItemServiceInternal(ItemServiceInternal itemServiceInternal)

setDependencyResolver

public void setDependencyResolver(DependencyResolver dependencyResolver)

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

setGeneralLockService

public void setGeneralLockService(GeneralLockService generalLockService)

setRetryingDatabaseOperationFacade

public void setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)