com.adobe.cq.commerce.api.asset

Interface ProductAssetHandler

public interface ProductAssetHandler

OSGi Service interface for managing product assets.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAssetProperties(ResourceResolver resolver, java.lang.String assetReference) Returns the rendering properties associated with the referenced asset.
java.lang.String	getHandlerName() Returns the handler name.
java.lang.String	getReferencedAsset(Resource productAssetResource) Returns the path of the asset that is referenced in the product asset.
java.lang.String	getThumbnailUrl(Resource productAssetResource, java.lang.String selectorString) Returns the URL to the product's thumbnail image, based on the given selector string.
boolean	isActive() Indicates whether the handler is active or not.
boolean	isSupportedAsset(Resource productAssetResource) Indicates whether the product asset is supported or not.
boolean	isSupportedReferencedAsset(ResourceResolver resolver, java.lang.String assetReference) Indicates whether the asset (referenced by its path) is supported or not.

Method Detail

getHandlerName

java.lang.String getHandlerName()

Returns the handler name.

Returns:

getAssetProperties

java.util.Map<java.lang.String,java.lang.Object> getAssetProperties(ResourceResolver resolver,
                                                                    java.lang.String assetReference)

Returns the rendering properties associated with the referenced asset.

Parameters:

resolver - The resource resolver

assetReference - The path to the referenced asset

Returns:

getReferencedAsset

java.lang.String getReferencedAsset(Resource productAssetResource)

Returns the path of the asset that is referenced in the product asset.

Parameters:

productAssetResource - The product asset resource

Returns:

isSupportedReferencedAsset

boolean isSupportedReferencedAsset(ResourceResolver resolver,
                                   java.lang.String assetReference)

Indicates whether the asset (referenced by its path) is supported or not.

Parameters:

resolver - The resource resolver

assetReference - The path to the referenced asset

Returns:

isSupportedAsset

boolean isSupportedAsset(Resource productAssetResource)

Indicates whether the product asset is supported or not.

Parameters:

productAssetResource - The product asset resource

Returns:

getThumbnailUrl

java.lang.String getThumbnailUrl(Resource productAssetResource,
                                 java.lang.String selectorString)

Returns the URL to the product's thumbnail image, based on the given selector string.

Parameters:

productAssetResource - The product asset

selectorString - The selector string

Returns:

isActive

boolean isActive()

Indicates whether the handler is active or not.

Returns: