Package com.day.cq.dam.scene7.api

Interface Scene7FileMetadataService

@ProviderType
public interface Scene7FileMetadataService

The Scene7FileMetadataService is responsible for the management of Scene7 specific information for CQ DAM assets.

Method Summary

Modifier and Type	Method	Description
void	removeAssetMetadataProperty(Asset asset, String propertyName)	Removes a metadata property from a CQ DAM asset.
void	setAssetJcrContentProperty(Asset asset, String propertyName, Object propertyValue)	Sets properties on the jcr:content node of a CQ DAM asset.
void	setAssetMetadataOnSync(Asset asset, Scene7Asset scene7Asset, S7Config s7Config, String status)	Sets multiple properties at the same time on a CQ DAM asset to store its relevant Scene7 properties.
void	setAssetMetadataProperty(Asset asset, String propertyName, Object propertyValue)	Sets properties on the metadata node of a CQ DAM asset.
void	setResourceMetadataOnSync(Resource resource, String scene7Handle, S7Config s7Config, String status, Boolean deleteOnFail)	Sets properties on the Resource JCR node to store its relevant Scene7 properties.

Method Details

setAssetMetadataProperty

void setAssetMetadataProperty(Asset asset,
 String propertyName,
 Object propertyValue)
                       throws Exception

Sets properties on the metadata node of a CQ DAM asset. The session must be manually saved.

Parameters:

asset - the CQ DAM asset

propertyName - the property's name

propertyValue - the property's value

Throws:

Exception - if the property cannot be added / modified

setAssetMetadataOnSync

void setAssetMetadataOnSync(Asset asset,
 Scene7Asset scene7Asset,
 S7Config s7Config,
 String status)
                     throws Exception

Sets multiple properties at the same time on a CQ DAM asset to store its relevant Scene7 properties. The session must be manually saved.

Parameters:

asset - the CQ DAM asset on which to add metadata information

scene7Asset - the Scene7Asset from which to extract the metadata information

s7Config - the Scene7 configuration

status - the status of the sync operation (e.g. the status of an upload job)

Throws:

Exception - if the property cannot be added / modified

removeAssetMetadataProperty

void removeAssetMetadataProperty(Asset asset,
 String propertyName)
                          throws Exception

Removes a metadata property from a CQ DAM asset. The session must be manually saved.

Parameters:

asset - the CQ DAM asset

propertyName - the property's name

Throws:

Exception - if the property cannot be removed

setAssetJcrContentProperty

void setAssetJcrContentProperty(Asset asset,
 String propertyName,
 Object propertyValue)
                         throws Exception

Sets properties on the jcr:content node of a CQ DAM asset. The session must be manually saved.

Parameters:

asset - the CQ DAM asset

propertyName - the property's name

propertyValue - the property's value

Throws:

Exception - if the property cannot be added / modified

setResourceMetadataOnSync

void setResourceMetadataOnSync(Resource resource,
 String scene7Handle,
 S7Config s7Config,
 String status,
 Boolean deleteOnFail)
                        throws Exception

Sets properties on the Resource JCR node to store its relevant Scene7 properties. This method is compatible with Scene7 assets (e.g. images, videos) and company settings (e.g. image presets, viewer presets). The session must be manually saved.

Parameters:

resource - Resource object on which to add Scene7 metadata

scene7Handle - Scene7 asset handle or asset ID

s7Config - the Scene7 configuration

status - the status of the sync operation (e.g. the status of an upload job)

deleteOnFail - whether to delete Scene7 remote assets/settings when the properties save action fails,

Throws:

Exception