Package com.adobe.acs.commons.contentsync

Class ContentCatalog

java.lang.Object

com.adobe.acs.commons.contentsync.ContentCatalog

public class ContentCatalog
extends Object

The ContentCatalog class provides methods to fetch and process content catalogs from a remote instance.

Constructor Summary

Constructors

Constructor	Description
ContentCatalog(RemoteInstance remoteInstance, String catalogServlet)

Method Summary

Modifier and Type	Method	Description
List<CatalogItem>	fetch(String path, String updateStrategy)	Deprecated. use fetch(String, String, boolean)
List<CatalogItem>	fetch(String path, String updateStrategy, boolean recursive)	Fetches the catalog items from the remote instance.
List<CatalogItem>	getDelta(List<CatalogItem> catalog, org.apache.sling.api.resource.ResourceResolver resourceResolver, UpdateStrategy updateStrategy)	Gets the delta between the catalog items and the resources in the resource resolver.
URI	getFetchURI(String path, String updateStrategy)	Deprecated. use getFetchURI(String, String, boolean)
URI	getFetchURI(String path, String updateStrategy, boolean recursive)	Gets the URI to fetch the catalog.

Methods inherited from class java.lang.Object

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

Constructor Details

ContentCatalog

public ContentCatalog(RemoteInstance remoteInstance,
 String catalogServlet)

Method Details

getFetchURI

@Deprecated
public URI getFetchURI(String path,
 String updateStrategy)
                throws URISyntaxException

Deprecated.

use getFetchURI(String, String, boolean)

Throws:

URISyntaxException

getFetchURI

public URI getFetchURI(String path,
 String updateStrategy,
 boolean recursive)
                throws URISyntaxException

Gets the URI to fetch the catalog.

Parameters:

path - the path to fetch the catalog for

updateStrategy - the update strategy to use

recursive - whether to fetch recursively

Returns:

the URI to fetch the catalog

Throws:

URISyntaxException - if the URI syntax is incorrect

fetch

@Deprecated
public List<CatalogItem> fetch(String path,
 String updateStrategy)
                        throws IOException,
URISyntaxException

Deprecated.

use fetch(String, String, boolean)

Throws:

IOException

URISyntaxException

fetch

public List<CatalogItem> fetch(String path,
 String updateStrategy,
 boolean recursive)
                        throws IOException,
URISyntaxException

Fetches the catalog items from the remote instance.

Parameters:

path - the path to fetch the catalog for

updateStrategy - the update strategy to use

recursive - whether to fetch recursively

Returns:

a list of catalog items

Throws:

IOException - if an I/O error occurs

URISyntaxException - if the URI syntax is incorrect

getDelta

public List<CatalogItem> getDelta(List<CatalogItem> catalog,
 org.apache.sling.api.resource.ResourceResolver resourceResolver,
 UpdateStrategy updateStrategy)

Gets the delta between the catalog items and the resources in the resource resolver.

Parameters:

catalog - the list of catalog items

resourceResolver - the resource resolver to check against

updateStrategy - the update strategy to use

Returns:

a list of catalog items that are modified or not present in the resource resolver