com.adobe.aem.commons.assetshare.util.assetkit

Interface AssetKitHelper

@ProviderType
public interface AssetKitHelper

Method Summary

Modifier and Type	Method and Description
AssetModel	getAsset(org.apache.sling.api.resource.Resource resource) Gets the asset represented by the resource.
Collection<? extends AssetModel>	getAssets(org.apache.sling.api.resource.Resource[] resources) Gets a collection of assets that at or exist under the paths provided.
Collection<? extends AssetModel>	getAssets(org.apache.sling.api.resource.ResourceResolver resourceResolver, String[] paths) Gets a collection of assets that at or exist under the paths provided.
Collection<? extends AssetModel>	getAssetsFromAssetCollection(org.apache.sling.api.resource.Resource resource) Gets a collection of assets that exist at the collection represented by the resource.
Collection<? extends AssetModel>	getAssetsFromAssetFolder(org.apache.sling.api.resource.Resource resource) Gets a collection of assets that exist at the folder represented by the resource.
boolean	isAsset(org.apache.sling.api.resource.Resource resource) Checks if the resource is an asset.
boolean	isAssetCollection(org.apache.sling.api.resource.Resource resource) Checks if the resource is an assets collection.
boolean	isAssetFolder(org.apache.sling.api.resource.Resource resource) Checks if the resource is an assets folder.
void	updateComponentOnPage(com.day.cq.wcm.api.Page page, String resourceType, String propertyName, String propertyValue) Updates a component on a page (or the page itself).

Method Detail

getAssets

Collection<? extends AssetModel> getAssets(org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                           String[] paths)

Gets a collection of assets that at or exist under the paths provided.

Parameters:

resourceResolver - the resource resolver.

paths - the assets live at or under.

Returns:

a collection of assets.

getAssets

Collection<? extends AssetModel> getAssets(org.apache.sling.api.resource.Resource[] resources)

Gets a collection of assets that at or exist under the paths provided.

Parameters:

resources - an array of resources the assets live at or under.

Returns:

a collection of assets.

getAssetsFromAssetCollection

Collection<? extends AssetModel> getAssetsFromAssetCollection(org.apache.sling.api.resource.Resource resource)

Gets a collection of assets that exist at the collection represented by the resource.

Parameters:

resource - represents the collection.

Returns:

a collection of assets that belong to the collection.

getAssetsFromAssetFolder

Collection<? extends AssetModel> getAssetsFromAssetFolder(org.apache.sling.api.resource.Resource resource)

Gets a collection of assets that exist at the folder represented by the resource.

Parameters:

resource - represents the assets folder.

Returns:

a collection of (immediate) assets that exist in the folder.

getAsset

AssetModel getAsset(org.apache.sling.api.resource.Resource resource)

Gets the asset represented by the resource.

Parameters:

resource - the resource that represents the asset.

Returns:

an asset.

isAssetFolder

boolean isAssetFolder(org.apache.sling.api.resource.Resource resource)

Checks if the resource is an assets folder.

Parameters:

resource - the resource.

Returns:

true if the resource is an assets folder.

isAssetCollection

boolean isAssetCollection(org.apache.sling.api.resource.Resource resource)

Checks if the resource is an assets collection.

Parameters:

resource - the resource.

Returns:

true is the resource is an assets collection.

isAsset

boolean isAsset(org.apache.sling.api.resource.Resource resource)

Checks if the resource is an asset.

Parameters:

resource - the resource

Returns:

true if the asset is an asset.

updateComponentOnPage

void updateComponentOnPage(com.day.cq.wcm.api.Page page,
                           String resourceType,
                           String propertyName,
                           String propertyValue)
                    throws org.apache.sling.api.resource.PersistenceException,
                           javax.jcr.RepositoryException

Updates a component on a page (or the page itself).

Parameters:

page - the page to update.

resourceType - the resource type of the component to update.

propertyName - the component property to update.

propertyValue - the component property value to set.

Throws:

org.apache.sling.api.resource.PersistenceException

javax.jcr.RepositoryException