com.canto.cumulus.mediadeliverycloud

Class MediaDeliveryCloudManager

java.lang.Object

com.canto.cumulus.mediadeliverycloud.MediaDeliveryCloudManager

public class MediaDeliveryCloudManager
extends java.lang.Object

Media Delivery Cloud management class. This provides functionality to work with the Canto Media Delivery Cloud. It offers functions to request uploading of assets to the media delivery cloud, retrieving information about an asset both in Cumulus and the Media Delivery Cloud.

Since:

10.2

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_MAX_LENGTH
static java.lang.String	RENDITION_FORMAT_GIF
static java.lang.String	RENDITION_FORMAT_JPEG
static java.lang.String	RENDITION_FORMAT_PNG
static java.lang.String	RENDITION_FORMAT_TIF

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllRenditionParameters(Item item, JSONObject targetObject, java.lang.String propertyName)
void	addMasterImageRegionOfInterest(Item item, JSONObject targetObject, java.lang.String propertyName)
void	addMasterImageSize(Asset convertedAsset, JSONObject targetObject, java.lang.String propertyName)
AccountInformation	getAccountInformation()
MediaDeliveryCloudConfiguration	getConfiguration()
java.lang.String	getImageRenditionURL(Item item, RenditionParameters parameters) Returns the URL to the image with the given rendering parameters in the media delivery cloud
static MediaDeliveryCloudManager	getInstance(Server server)
java.lang.String	getOriginalAssetURL(Item item) Returns the URL to the original asset in the media delivery cloud
void	removeMasterImage(java.lang.String imageID) Deletes the master image and the renditions at the media delivery cloud.
void	removeMasterImage(java.lang.String imageID, boolean invalidateCDN) Deletes the master image and the renditions at the media delivery cloud and invalidates the corresponding entries in the CDN.
void	removeOriginalAsset(java.lang.String assetID) Deletes the original asset at the media delivery cloud.
void	removeOriginalAsset(java.lang.String assetID, boolean invalidateCDN) Deletes the original asset at the media delivery cloud.
void	removeWatermarkImage(java.lang.String watermarkImageID) Deletes the watermark image at the media delivery cloud.
void	syncAccountMetadata() Update the definitions of automatic crop templates if they have changed.
void	unpublishMasterImage(Item item) Deactivate the images for publishing.
void	unpublishMasterImage(Item item, boolean invalidateCDN) Deactivate the images for publishing.
void	unpublishOriginalAsset(Item item) Deactivate the original asset for publishing.
void	unpublishOriginalAsset(Item item, boolean invalidateCDN) Deactivate the original asset for publishing.
void	updateMasterImageExpirationDate(Item item) Update the images expiration date for publishing.
void	updateMasterImageMetadata(Item item) Update the images expiration date for publishing and other metadata such as crop parameters.
void	updateOriginalAssetExpirationDate(Item item) Update the original asset expiration date for publishing.
void	uploadMasterImage(Item item) Upload the master image to media delivery cloud.
void	uploadOriginalAsset(Item item) Upload the original asset to media delivery cloud.
void	uploadWatermarkImage(Asset asset, java.lang.String watermarkName) Upload a watermark image to media delivery cloud.
void	uploadWatermarkImage(Asset asset, java.lang.String watermarkName, java.lang.String imageID) Upload a watermark image to media delivery cloud.

Methods inherited from class java.lang.Object

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

Field Detail

RENDITION_FORMAT_JPEG

public static final java.lang.String RENDITION_FORMAT_JPEG

See Also:

Constant Field Values

RENDITION_FORMAT_PNG

public static final java.lang.String RENDITION_FORMAT_PNG

See Also:

Constant Field Values

RENDITION_FORMAT_GIF

public static final java.lang.String RENDITION_FORMAT_GIF

See Also:

Constant Field Values

RENDITION_FORMAT_TIF

public static final java.lang.String RENDITION_FORMAT_TIF

See Also:

Constant Field Values

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

See Also:

Constant Field Values

Method Detail

getInstance

public static MediaDeliveryCloudManager getInstance(Server server)

getConfiguration

public MediaDeliveryCloudConfiguration getConfiguration()

getAccountInformation

public AccountInformation getAccountInformation()
                                         throws java.io.IOException

Throws:

java.io.IOException

syncAccountMetadata

public void syncAccountMetadata()
                         throws java.io.IOException

Update the definitions of automatic crop templates if they have changed.

Throws:

java.io.IOException

Since:

11.0.1

uploadOriginalAsset

public void uploadOriginalAsset(Item item)
                         throws java.io.IOException,
                                UnresolvableAssetReferenceException

Upload the original asset to media delivery cloud. This function should be called by the Scheduler task for items that requested uploading the original asset. After successful upload this method updates the "Media Delivery Cloud State" field value.

Parameters:

item - The asset record item

Throws:

java.io.IOException

UnresolvableAssetReferenceException

uploadMasterImage

public void uploadMasterImage(Item item)
                       throws java.io.IOException

Upload the master image to media delivery cloud. This function should be called by the Scheduler task for items that requested uploading images. After successful upload this method updates the "Media Delivery Cloud State" field value.

Parameters:

item - The asset record item

Throws:

java.io.IOException

uploadWatermarkImage

public void uploadWatermarkImage(Asset asset,
                        java.lang.String watermarkName)
                          throws java.io.IOException

Upload a watermark image to media delivery cloud.

Parameters:

asset - The asset to upload as watermark image

watermarkName - The name of the watermark to identify

Throws:

java.io.IOException

uploadWatermarkImage

public void uploadWatermarkImage(Asset asset,
                        java.lang.String watermarkName,
                        java.lang.String imageID)
                          throws java.io.IOException

Upload a watermark image to media delivery cloud.

Parameters:

asset - The asset to upload as watermark image

watermarkName - The name of the watermark to identify

imageID - The image ID of an existing watermark image to be replaced or null to create a new image with a new ID.

Throws:

java.io.IOException

Since:

10.2.1

unpublishOriginalAsset

public void unpublishOriginalAsset(Item item)
                            throws java.io.IOException

Deactivate the original asset for publishing.

Parameters:

item - The asset record item

Throws:

java.io.IOException

unpublishOriginalAsset

public void unpublishOriginalAsset(Item item,
                          boolean invalidateCDN)
                            throws java.io.IOException

Deactivate the original asset for publishing.

Parameters:

item - The asset record item

invalidateCDN - Specify whether the asset should also immediately be removed from the CDN (Content Delivery Network) cache.

Throws:

java.io.IOException

Since:

11.1.1

unpublishMasterImage

public void unpublishMasterImage(Item item)
                          throws java.io.IOException

Deactivate the images for publishing.

Parameters:

item - The asset record item

Throws:

java.io.IOException

unpublishMasterImage

public void unpublishMasterImage(Item item,
                        boolean invalidateCDN)
                          throws java.io.IOException

Deactivate the images for publishing.

Parameters:

item - The asset record item

invalidateCDN - Specify whether the master image and all renditions should also be immediately removed from the CDN (Content Delivery Network).

Throws:

java.io.IOException

Since:

11.1.1

getOriginalAssetURL

public java.lang.String getOriginalAssetURL(Item item)
                                     throws java.io.IOException

Returns the URL to the original asset in the media delivery cloud

Parameters:

item - The asset record item

Throws:

java.io.IOException

addAllRenditionParameters

public void addAllRenditionParameters(Item item,
                             JSONObject targetObject,
                             java.lang.String propertyName)
                               throws java.io.IOException,
                                      JSONException

Throws:

java.io.IOException

JSONException

addMasterImageRegionOfInterest

public void addMasterImageRegionOfInterest(Item item,
                                  JSONObject targetObject,
                                  java.lang.String propertyName)
                                    throws java.io.IOException,
                                           JSONException

Throws:

java.io.IOException

JSONException

addMasterImageSize

public void addMasterImageSize(Asset convertedAsset,
                      JSONObject targetObject,
                      java.lang.String propertyName)
                        throws java.io.IOException,
                               JSONException

Throws:

java.io.IOException

JSONException

getImageRenditionURL

public java.lang.String getImageRenditionURL(Item item,
                                    RenditionParameters parameters)
                                      throws java.io.IOException

Returns the URL to the image with the given rendering parameters in the media delivery cloud

Parameters:

item - The asset record item

parameters - The rendering parameters to be used when getting the URL resource.

Throws:

java.io.IOException

removeOriginalAsset

public void removeOriginalAsset(java.lang.String assetID)
                         throws java.io.IOException

Deletes the original asset at the media delivery cloud. The "Media Delivery Cloud Asset ID" field value is provided (so it can be called from a trigger action after the item is already deleted).

Parameters:

assetID - The "Media Delivery Cloud Asset ID" field value

Throws:

java.io.IOException

removeOriginalAsset

public void removeOriginalAsset(java.lang.String assetID,
                       boolean invalidateCDN)
                         throws java.io.IOException

Deletes the original asset at the media delivery cloud. The "Media Delivery Cloud Asset ID" field value is provided (so it can be called from a trigger action after the item is already deleted).

Parameters:

assetID - The "Media Delivery Cloud Asset ID" field value

invalidateCDN - Specify whether the master image and all renditions should also be immediately removed from the CDN (Content Delivery Network).

Throws:

java.io.IOException

Since:

11.1.1

removeMasterImage

public void removeMasterImage(java.lang.String imageID)
                       throws java.io.IOException

Deletes the master image and the renditions at the media delivery cloud. The "Media Delivery Cloud Image ID" field value is provided (so it can be called from a trigger action after the item is already deleted).

Parameters:

imageID - The "Media Delivery Cloud Image ID" field value

Throws:

java.io.IOException

removeMasterImage

public void removeMasterImage(java.lang.String imageID,
                     boolean invalidateCDN)
                       throws java.io.IOException

Deletes the master image and the renditions at the media delivery cloud and invalidates the corresponding entries in the CDN. The "Media Delivery Cloud Image ID" field value is provided (so it can be called from a trigger action after the item is already deleted).

Parameters:

imageID - The "Media Delivery Cloud Image ID" field value

invalidateCDN - Specify whether the master image and all renditions should also be immediately removed from the CDN (Content Delivery Network).

Throws:

java.io.IOException

Since:

11.1.1

removeWatermarkImage

public void removeWatermarkImage(java.lang.String watermarkImageID)
                          throws java.io.IOException

Deletes the watermark image at the media delivery cloud.

Parameters:

watermarkImageID - The image ID of the watermark image

Throws:

java.io.IOException

updateOriginalAssetExpirationDate

public void updateOriginalAssetExpirationDate(Item item)
                                       throws java.io.IOException

Update the original asset expiration date for publishing.

Parameters:

item - The asset record item

Throws:

ObjectNotFoundException - if the Asset ID of the given item does not exist in MDC

java.io.IOException

updateMasterImageExpirationDate

public void updateMasterImageExpirationDate(Item item)
                                     throws java.io.IOException

Update the images expiration date for publishing.

Parameters:

item - The asset record item

Throws:

java.io.IOException

updateMasterImageMetadata

public void updateMasterImageMetadata(Item item)
                               throws java.io.IOException

Update the images expiration date for publishing and other metadata such as crop parameters.

Parameters:

item - The asset record item

Throws:

java.io.IOException

Since:

11.0.1