Package org.craftercms.studio.api.v1.service.dependency

Interface DependencyService

All Known Implementing Classes:

DependencyServiceImpl

public interface DependencyService

Dependency Service is the sole custodian of the dependency database and provide the interface to add, sync, delete and retrieve dependencies across the system.

Author:

Sumer Jabri

Method Summary

Modifier and Type	Method	Description
Map<String,List<CalculateDependenciesEntityTO>>	calculateDependencies(String site, List<String> paths)	Calculate dependencies for publishing
Set<String>	calculateDependenciesPaths(String site, List<String> paths)	Calculate dependencies paths for publishing
void	deleteItemDependencies(String site, String path)	Delete an item dependencies from the database.
void	deleteSiteDependencies(String site)	Delete all dependencies from the database for a given site.
Set<String>	getDeleteDependencies(String site, String path)
Set<String>	getDeleteDependencies(String site, List<String> paths)
Set<String>	getItemDependencies(String site, String path, int depth)	Get all item dependencies of an item.
Set<String>	getItemsDependingOn(String site, String path, int depth)	Get all items that depend on this item.
Set<String>	getItemSpecificDependencies(String site, String path, int depth)	Get item-specific dependencies of an item.
List<String>	getPublishingDependencies(String site, String path)	Get a all publishing dependencies of a list of items.
List<String>	getPublishingDependencies(String site, List<String> paths)	Get a all publishing dependencies of a list of items.
Set<String>	moveDependencies(String site, String oldPath, String newPath)	Move an item and make sure dependency paths remain correct.
Set<String>	upsertDependencies(String site, String path)	Scan item for direct dependencies and synchronize those to the depenencies database adding the new deps, updating existing, and removing what was removed from the item.
Set<String>	upsertDependencies(String site, List<String> paths)	Scan a list of items for direct dependencies and synchroniz those to the depenencies database adding the new deps, updating existing, and removing what was removed from the item.

Method Detail

upsertDependencies

Set<String> upsertDependencies(String site,
                               String path)
                        throws SiteNotFoundException,
                               ContentNotFoundException,
                               ServiceLayerException

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

Parameters:

site - Site to operate on

path - Path to item to scan

Returns:

set of upserted dependencies

Throws:

SiteNotFoundException - Site doesn't exist

ContentNotFoundException - Path doesn't exist

ServiceLayerException - Internal error, see exception details

upsertDependencies

Set<String> upsertDependencies(String site,
                               List<String> paths)
                        throws SiteNotFoundException,
                               ContentNotFoundException,
                               ServiceLayerException

Scan a list of items for direct dependencies and synchroniz those to the depenencies database adding the new deps, updating existing, and removing what was removed from the item.

Parameters:

site - Site to operate on

paths - List of paths to items to scan

Returns:

set of upserted dependencies

Throws:

SiteNotFoundException - Site doesn't exist

ContentNotFoundException - One or more paths doesn't exist (database won't be updated for any of the items)

ServiceLayerException - Internal error, see exception details

getPublishingDependencies

List<String> getPublishingDependencies(String site,
                                       String path)
                                throws SiteNotFoundException,
                                       ContentNotFoundException,
                                       ServiceLayerException

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

Parameters:

site - Site to operate on

path - Paths to item to retrieve deps for

Returns:

list of mandatory dependencies paths for publishing

Throws:

SiteNotFoundException - Site doesn't exist

ContentNotFoundException - Path doesn't exist

ServiceLayerException - Internal error, see exception details

getPublishingDependencies

List<String> getPublishingDependencies(String site,
                                       List<String> paths)
                                throws SiteNotFoundException,
                                       ContentNotFoundException,
                                       ServiceLayerException

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

Parameters:

site - Site to operate on

paths - List of paths to items to retrieve deps for

Returns:

list of mandatory dependencies paths for publishing

Throws:

SiteNotFoundException - Site doesn't exist

ContentNotFoundException - One or more paths doesn't exist

ServiceLayerException - Internal error, see exception details

getItemSpecificDependencies

Set<String> getItemSpecificDependencies(String site,
                                        String path,
                                        int depth)
                                 throws SiteNotFoundException,
                                        ContentNotFoundException,
                                        ServiceLayerException

Get item-specific dependencies of an item. An item-specific dependency is: * Only referenced by the parent item * Sits in a special path pattern defined during content modeling

Parameters:

site - Site to operate on

path - Path to items to retrieve deps for

depth - Depth of tree to traverse. Depth of -1 disables depth limits

Returns:

set of hard dependencies

Throws:

SiteNotFoundException - Site doesn't exist

ContentNotFoundException - Path doesn't exist

ServiceLayerException - Internal error, see exception details

getItemDependencies

Set<String> getItemDependencies(String site,
                                String path,
                                int depth)
                         throws SiteNotFoundException,
                                ContentNotFoundException,
                                ServiceLayerException

Get all item dependencies of an item.

Parameters:

site - Site to operate on

path - Path to items to retrieve deps for

depth - Depth of tree to traverse. Depth of -1 disables depth limits

Returns:

set of items that given item depends on

Throws:

SiteNotFoundException - Site doesn't exist

ContentNotFoundException - Path doesn't exist

ServiceLayerException - Internal error, see exception details

getItemsDependingOn

Set<String> getItemsDependingOn(String site,
                                String path,
                                int depth)
                         throws SiteNotFoundException,
                                ContentNotFoundException,
                                ServiceLayerException

Get all items that depend on this item.

Parameters:

site - Site to operate on

path - Path to items to retrieve deps for

depth - Depth of tree to traverse. Depth of -1 disables depth limits

Returns:

set of items depending on given item path

Throws:

SiteNotFoundException - Site doesn't exist

ContentNotFoundException - Path doesn't exist

ServiceLayerException - Internal error, see exception details

moveDependencies

Set<String> moveDependencies(String site,
                             String oldPath,
                             String newPath)
                      throws SiteNotFoundException,
                             ContentNotFoundException,
                             ServiceLayerException

Move an item and make sure dependency paths remain correct.

Parameters:

site - Site to operate on

oldPath - Path to item to move

newPath - Path the item moves to

Returns:

set of updated dependencies

Throws:

SiteNotFoundException - Site doesn't exist

ContentNotFoundException - Path doesn't exist

ServiceLayerException - Internal error, see exception details

deleteItemDependencies

void deleteItemDependencies(String site,
                            String path)
                     throws SiteNotFoundException,
                            ContentNotFoundException,
                            ServiceLayerException

Delete an item dependencies from the database.

Parameters:

site - Site to operate on

path - Path to items to retrieve deps for

Throws:

SiteNotFoundException - Site doesn't exist

ContentNotFoundException - Path doesn't exist

ServiceLayerException - Internal error, see exception details

deleteSiteDependencies

void deleteSiteDependencies(String site)
                     throws ServiceLayerException

Delete all dependencies from the database for a given site.

Parameters:

site - Site to operate on

Throws:

ServiceLayerException - Internal error, see exception details

getDeleteDependencies

Set<String> getDeleteDependencies(String site,
                                  String path)
                           throws SiteNotFoundException,
                                  ContentNotFoundException,
                                  ServiceLayerException

Parameters:

site - Site to operate on

path - Path to item to retrieve delete dependencies for

Returns:

Set of paths included as delete dependencies

Throws:

SiteNotFoundException - Site doesn't exist

ContentNotFoundException - Content doesn't exist

ServiceLayerException - Internal error

getDeleteDependencies

Set<String> getDeleteDependencies(String site,
                                  List<String> paths)
                           throws SiteNotFoundException,
                                  ContentNotFoundException,
                                  ServiceLayerException

Parameters:

site - Site to operate on

paths - Paths to items to retrieve delete dependencies for

Returns:

Set of paths included as delete dependencies

Throws:

SiteNotFoundException - Site doesn't exist

ContentNotFoundException - Content doesn't exist

ServiceLayerException - Internal error

calculateDependencies

Map<String,List<CalculateDependenciesEntityTO>> calculateDependencies(String site,
                                                                            List<String> paths)
                                                                     throws ServiceLayerException

Calculate dependencies for publishing

Parameters:

site - Site to operate on

paths - List of items to calculate dependencies for

Returns:

Formatted result set

Throws:

ServiceLayerException - general service error

calculateDependenciesPaths

Set<String> calculateDependenciesPaths(String site,
                                       List<String> paths)
                                throws ServiceLayerException

Calculate dependencies paths for publishing

Parameters:

site - site to use

paths - list of items to calculate dependencies for

Returns:

dependencies paths

Throws:

ServiceLayerException - general service error