public class DamUtil extends Object
Constructor and Description |
---|
DamUtil() |
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 boolean |
expiryStatus(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 Calendar |
getExpiryTime(Asset asset) |
static <T> T |
getInheritedProperty(String property,
Resource resource,
T defaultValue)
This method searches for the property in the provided contentPath
resource.
|
static Asset |
getParentAsset(Resource resource) |
static List<Asset> |
getReferencedSubAssets(Resource resource) |
static Collection<Asset> |
getRefererAssets(ResourceResolver resolver,
String path) |
static Collection<Asset> |
getSubAssets(Resource resource) |
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)
|
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)
|
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 . |
public static String assetToBinaryPath(String path)
null
is
returned.
DamUtil.assetToBinaryPath("/content/dam/myfolder/test.jpg") = "/var/dam/myfolder/test.jpg" DamUtil.assetToBinaryPath(null) = null
path
- The path to translate.null
if the given path is not a DAM asset path.DamConstants.MOUNTPOINT_BINARIES
,
DamConstants.MOUNTPOINT_ASSETS
public static String binaryToAssetPath(String path)
null
is
returned.
DamUtil.binaryToAssetPath("/var/dam/myfolder/test.jpg") = "/content/dam/myfolder/test.jpg" DamUtil.binaryToAssetPath(null) = null
path
- The path to translate.null
if the given path is not a DAM binary path.DamConstants.MOUNTPOINT_BINARIES
,
DamConstants.MOUNTPOINT_ASSETS
public static boolean isThumbnail(Node file)
Node
represents a thumbnail of an asset.file
- The node to check.true
if the node represent's an asset's thumbnail, false
otherwise.public static String getThumbnailName(int width, int height)
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); ...
width
- The width of the thumbnail.height
- The height of the thumbnail.public static String getThumbnailName(ThumbnailConfig config)
config
- The ThumbnailConfig
Rendition
name.public static String getThumbnailName(int width, int height, String[] selectors)
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); ...
width
- The width of the thumbnail.height
- The height of the thumbnail.selectors
- An array of selectors to be added. May be null (ignored).public static boolean isRendition(Resource resource)
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.resource
- The resource to check.true
if the resource is a rendition.public static boolean isAsset(Resource resource)
Resource
represents a Asset
. The requirements are
that the given resource
is of node type dam:Asset.resource
- The resource to check.true
if the resource is an asset.public static boolean isFrozenNode(Resource resource)
Resource
represents a frozen node. The requirements are
that the given resource
is of node type nt:frozenNode.resource
- The resource to checktrue
if the resource is an asset.public static boolean isSubAsset(Resource resource)
resource
is an Asset
's sub-asset.resource
- The Resource
to check.true
if this asset is a sub-asset.public static Asset resolveToAsset(Resource resource)
resource
is an asset, and if not, travels upwards the resource hierarchy
until a resource is an asset.resource
- The resource to check.Asset
or null
if no asset was found.public static void setModified(Asset asset, String user, Calendar date)
Asset
.asset
- The asset to update.user
- The username of who updated the asset.date
- The date/time the updated happened.public static List<String> findExpiringAssets(Session session, Calendar lowerBound, Calendar upperBound) throws RepositoryException
session
- lowerBound
- the lower bound of date where asset expiration is computed. If null it is not considered as
query criterionupperBound
- the upper bound of date where asset expiration is computed. If null it is not considered as
query criterionRepositoryException
public static String getValue(Node n, String name, String defaultValue) throws RepositoryException
n
with
name
. If there is no single-valued property for the given
name
, then the defaultValue
is returned.n
- a node.name
- a property name.defaultValue
- the default value.RepositoryException
- if value cannot be retrievedpublic static boolean isImage(Asset asset)
asset
- public static boolean isVideo(Asset asset)
asset
- public static boolean isSmartCollection(Resource resource)
resource
- an instance of Resource
true
if resource
represents a smart collection
false
if resource
does not represents a smart collectionpublic static Node getApplicableProfile(Asset asset, String profileType, Session session)
asset
- The asset we get from payload of DamUpdateAsset WorkflowprofileType
- The type of profile to get (metadata/video/image)session
- To retrieve nodes from JCRpublic static String getAppliedProcessingProfilePath(Asset asset)
asset
- The asset we get from payload of DamUpdateAsset Workflowpublic static Iterator<Asset> getAssets(Resource res)
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();public static boolean checkforAIFile(Asset asset)
public static Rendition getBestFitRendition(int width, List<Rendition> renditions)
public static boolean expiryStatus(Asset asset)
public static Collection<Asset> getSubAssets(Resource resource)
public static Collection<Asset> getRefererAssets(ResourceResolver resolver, String path)
public static <T> T getInheritedProperty(String property, Resource resource, T defaultValue)
property
- the property user is looking for.resource
- the resource representing the path where the property has to
be searcheddefaultValue
- "Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"