com.day.cq.dam.commons.util

Class DamUtil

java.lang.Object

com.day.cq.dam.commons.util.DamUtil

public class DamUtil
extends Object

This class provides various utility methods pertaining to DAM.

Since:

CQ 5.4.0

Constructor Summary

Constructors

Constructor and Description
DamUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static String	assetToBinaryPath(String path) Translates the path of an asset to its congruent DAM binary path, by replacing the /content/dam path prefix with /var/dam.
static String	binaryToAssetPath(String path) Translates the path of a DAM binary to its congruent asset path, by replacing the /var/dam path prefix with /content/dam.
static boolean	checkforAIFile(Asset asset)
static List<String>	findExpiringAssets(Session session, Calendar lowerBound, Calendar upperBound) Find all dam assets which are getting expired between lowerBound and upperBound.
static Node	getApplicableProfile(Asset asset, String profileType, Session session) Get a specific Processing profile which may be applied to an asset
static String	getAppliedProcessingProfilePath(Asset asset) To get the processing profile path which may be applied to an asset
static Iterator<Asset>	getAssets(Resource res) Returns an iterator to all the assets contained in or represented by the resource.
static Rendition	getBestFitRendition(int width, List<Rendition> renditions)
static String	getThumbnailName(int width, int height) Returns the name of a thumbnail in the DAM thumbnail name format, respecting the given dimensions of the thumbnail.
static String	getThumbnailName(int width, int height, String[] selectors) Behaves like getThumbnailName(int, int).
static String	getThumbnailName(ThumbnailConfig config) Returns the expected rendition/thumbnail name based on the given thumbnail configuration.
static String	getValue(Node n, String name, String defaultValue) Returns the single property value from the given node n with name.
static boolean	isAsset(Resource resource) Checks whether the given Resource represents a Asset.
static boolean	isFrozenNode(Resource resource) Checks whether the give Resource represents a frozen node.
static boolean	isImage(Asset asset) To check weather asset falls under Image category.
static boolean	isRendition(Resource resource) Checks whether the given Resource represents a Rendition of an Asset.
static boolean	isSmartCollection(Resource resource) Checks if given resource represent a smart collection
static boolean	isSubAsset(Resource resource) Indicates whether the given resource is an Asset's sub-asset.
static boolean	isThumbnail(Node file) This method determines whether the given Node represents a thumbnail of an asset.
static boolean	isVideo(Asset asset) To check weather asset falls under Video category.
static Asset	resolveToAsset(Resource resource) Checks whether the given resource is an asset, and if not, travels upwards the resource hierarchy until a resource is an asset.
static void	setModified(Asset asset, String user, Calendar date) This method updates the "last modified" information of the given Asset.

Methods inherited from class java.lang.Object

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

Constructor Detail

DamUtil

public DamUtil()

Method Detail

assetToBinaryPath

public static String assetToBinaryPath(String path)

Translates the path of an asset to its congruent DAM binary path, by replacing the /content/dam path prefix with /var/dam. If the given path does not start with DAM's asset mountpoint, null is returned.

   DamUtil.assetToBinaryPath("/content/dam/myfolder/test.jpg")    = "/var/dam/myfolder/test.jpg"
   DamUtil.assetToBinaryPath(null)                                = null
 

Parameters:

path - The path to translate.

Returns:

The binary equivalent path or null if the given path is not a DAM asset path.

See Also:

DamConstants.MOUNTPOINT_BINARIES, DamConstants.MOUNTPOINT_ASSETS

binaryToAssetPath

public static String binaryToAssetPath(String path)

Translates the path of a DAM binary to its congruent asset path, by replacing the /var/dam path prefix with /content/dam. If the given path does not start with DAM's binary mountpoint, null is returned.

   DamUtil.binaryToAssetPath("/var/dam/myfolder/test.jpg")        = "/content/dam/myfolder/test.jpg"
   DamUtil.binaryToAssetPath(null)                                = null
 

Parameters:

path - The path to translate.

Returns:

The metadata equivalent path or null if the given path is not a DAM binary path.

See Also:

DamConstants.MOUNTPOINT_BINARIES, DamConstants.MOUNTPOINT_ASSETS

isThumbnail

public static boolean isThumbnail(Node file)

This method determines whether the given Node represents a thumbnail of an asset.

Parameters:

file - The node to check.

Returns:

true if the node represent's an asset's thumbnail, false otherwise.

getThumbnailName

public static String getThumbnailName(int width,
                      int height)

Returns the name of a thumbnail in the DAM thumbnail name format, respecting the given dimensions of the thumbnail. E.g. providing a width of 100 and a height of 100 would return the thumbnail name cq5dam.thumbnail.100.100.png. As a thumbnail represents a rendition of an Asset, the name can be used for easy retrieval of the thumbnail:

   ...
   final String thumbnailName = DamUtil.getThumbnailName(100, 100);
   final Resource thumbnail = asset.getRendition(thumbnailName);
   ...
 

Parameters:

width - The width of the thumbnail.

height - The height of the thumbnail.

Returns:

The rendition name of the thumbnail.

getThumbnailName

public static String getThumbnailName(ThumbnailConfig config)

Returns the expected rendition/thumbnail name based on the given thumbnail configuration.

Parameters:

config - The ThumbnailConfig

Returns:

The Rendition name.

getThumbnailName

public static String getThumbnailName(int width,
                      int height,
                      String[] selectors)

Behaves like getThumbnailName(int, int). Additionally and optionally a string array of selectors to be added to the thumbnail name can be specified. E.g. providing width = 100, height = 100 and selectors = {"a", "b", "c"} would return the thumbnail name cq5dam.thumbnail.100.100.a.b.c.png. Example:

   ...
   final String[] selectors = {"a", "b", "c"};
   final String thumbnailName = DamUtil.getThumbnailName(100, 100, selectors);
   final Resource thumbnail = asset.getRendition(thumbnailName);
   ...
 

Parameters:

width - The width of the thumbnail.

height - The height of the thumbnail.

selectors - An array of selectors to be added. May be null (ignored).

Returns:

The rendition name of the thumbnail.

isRendition

public static boolean isRendition(Resource resource)

Checks whether the given Resource represents a Rendition of an Asset. The requirements are that given resource is stored within the renditions folder of an asset and that it's node type is nt:file.

Parameters:

resource - The resource to check.

Returns:

true if the resource is a rendition.

isAsset

public static boolean isAsset(Resource resource)

Checks whether the given Resource represents a Asset. The requirements are that the given resource is of node type dam:Asset.

Parameters:

resource - The resource to check.

Returns:

true if the resource is an asset.

isFrozenNode

public static boolean isFrozenNode(Resource resource)

Checks whether the give Resource represents a frozen node. The requirements are that the given resource is of node type nt:frozenNode.

Parameters:

resource - The resource to check

Returns:

true if the resource is an asset.

isSubAsset

public static boolean isSubAsset(Resource resource)

Indicates whether the given resource is an Asset's sub-asset.

Parameters:

resource - The Resource to check.

Returns:

true if this asset is a sub-asset.

resolveToAsset

public static Asset resolveToAsset(Resource resource)

Checks whether the given resource is an asset, and if not, travels upwards the resource hierarchy until a resource is an asset.

Parameters:

resource - The resource to check.

Returns:

The Asset or null if no asset was found.

setModified

public static void setModified(Asset asset,
               String user,
               Calendar date)

This method updates the "last modified" information of the given Asset.

Parameters:

asset - The asset to update.

user - The username of who updated the asset.

date - The date/time the updated happened.

findExpiringAssets

public static List<String> findExpiringAssets(Session session,
                              Calendar lowerBound,
                              Calendar upperBound)
                                       throws RepositoryException

Find all dam assets which are getting expired between lowerBound and upperBound.

Parameters:

session -

lowerBound - the lower bound of date where asset expiration is computed. If null it is not considered as query criterion

upperBound - the upper bound of date where asset expiration is computed. If null it is not considered as query criterion

Throws:

RepositoryException

getValue

public static String getValue(Node n,
              String name,
              String defaultValue)
                       throws RepositoryException

Returns the single property value from the given node n with name. If there is no single-valued property for the given name, then the defaultValue is returned.

Parameters:

n - a node.

name - a property name.

defaultValue - the default value.

Returns:

the value for the given property name or the default value.

Throws:

RepositoryException - if value cannot be retrieved

isImage

public static boolean isImage(Asset asset)

To check weather asset falls under Image category.

Parameters:

asset -

Returns:

True if asset is of type Image.

isVideo

public static boolean isVideo(Asset asset)

To check weather asset falls under Video category.

Parameters:

asset -

Returns:

True if asset is of type video.

isSmartCollection

public static boolean isSmartCollection(Resource resource)

Checks if given resource represent a smart collection

Parameters:

resource - an instance of Resource

Returns:

true if resource represents a smart collection false if resource does not represents a smart collection

getApplicableProfile

public static Node getApplicableProfile(Asset asset,
                        String profileType,
                        Session session)

Get a specific Processing profile which may be applied to an asset

Parameters:

asset - The asset we get from payload of DamUpdateAsset Workflow

profileType - The type of profile to get (metadata/video/image)

session - To retrieve nodes from JCR

Returns:

{Node} the Processing Profile, null if not found

getAppliedProcessingProfilePath

public static String getAppliedProcessingProfilePath(Asset asset)

To get the processing profile path which may be applied to an asset

Parameters:

asset - The asset we get from payload of DamUpdateAsset Workflow

Returns:

{String} the path of applied processing profile path

getAssets

public static Iterator<Asset> getAssets(Resource res)

Returns an iterator to all the assets contained in or represented by the resource. If resource is a folder, then all its folders are navigated recursively and assets are listed If a resource is ResourceCollection, then all its member resources are consulted and navigated recursively if any of the member represent folder or ResourceCollection. If the resource represents an asset itself, an iterator of single item i.e. Collections.singletonList(res.adaptTo(Asset.class)).iterator();

Parameters:

res - a sling Resource

Returns:

an Iterator of Asset

checkforAIFile

public static boolean checkforAIFile(Asset asset)

getBestFitRendition

public static Rendition getBestFitRendition(int width,
                            List<Rendition> renditions)