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

Interface ComponentUpdater

All Known Implementing Classes:

AssetKitComponentUpdaterImpl, BannerComponentUpdaterImpl, PageMetadataComponentUpdaterImpl

@ConsumerType
public interface ComponentUpdater

Method Summary

Modifier and Type	Method and Description
default String	getId() The id of the component updater.
String	getName() The name of the component updater.
void	updateComponent(com.day.cq.wcm.api.Page assetKitPage, org.apache.sling.api.resource.Resource assetKit) Entry point for updating the @{code assetKitPage} based on the @{code assetKit} payload resource.

Method Detail

getName

String getName()

The name of the component updater. Displays in the Asset kit creator workflow dialog's dropdown.

Returns:

the name of the component updater. Ideally is unique across all component updaters, so you can tell which is which.

getId

default String getId()

The id of the component updater. Used to identify the component updater in the workflow dialog. Must be unique across all component updaters. Defaults to the component's full class name. No need to change the default implementation.

Returns:

updateComponent

void updateComponent(com.day.cq.wcm.api.Page assetKitPage,
                     org.apache.sling.api.resource.Resource assetKit)
              throws org.apache.sling.api.resource.PersistenceException,
                     javax.jcr.RepositoryException

Entry point for updating the @{code assetKitPage} based on the @{code assetKit} payload resource. This can do anything, it can find and updated existing components created by the template's initial content, or it can create new resources under the page (or anywhere it has write access).

Parameters:

assetKitPage - the asset kit page being updated.

assetKit - the resource (folder, collection) that represents the asset kit's contents.

Throws:

org.apache.sling.api.resource.PersistenceException

javax.jcr.RepositoryException