com.day.cq.dam.commons.handler

Class AbstractAssetHandler

java.lang.Object

com.day.cq.dam.commons.handler.AbstractAssetHandler

All Implemented Interfaces:

AssetHandler

Direct Known Subclasses:

AbstractAssetHandler, EPubHandler, KeynoteHandler, Mp3Handler, MSOfficeHandler, OpenOfficeHandler, PdfHandler, PictHandler, PsdHandler, StandardImageHandler, ZipHandler

public abstract class AbstractAssetHandler
extends java.lang.Object
implements AssetHandler

The AbstractAssetHandler serves as basis for all other asset handler implementations and provides common used functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_DEACTIVATED_MIME_TYPES The property for deactivated mime types.

Constructor Summary

Constructors

Constructor and Description
AbstractAssetHandler()

Method Summary

Modifier and Type	Method and Description
boolean	canHandleSubAssets() Indicates if the handler supports processing of sub assets
void	createThumbnails(Asset asset) Creates thumbnails for this asset.
void	createThumbnails(Asset asset, java.util.Collection<ThumbnailConfig> configs) Thumbnails of an asset are created during import/update of an asset and it's original binary.
void	createThumbnails(Asset asset, Rendition rendition, java.util.Collection<ThumbnailConfig> configs) Creates thumbnails for an Assets particular Rendition.
void	createThumbnails(Node asset, Node renditionFolder, Session session, java.util.List<java.lang.Integer[]> dimensions) Deprecated.
void	createThumbnailsExt(Node asset, Node renditionFolder, Session session, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> thumbnailConfigs) Deprecated.
void	exportAsset(Node asset, java.io.OutputStream stream) Deprecated.
ExtractedMetadata	extractMetadata(Node asset) Deprecated.
java.awt.image.BufferedImage	getImage(Node file) Deprecated.
java.awt.image.BufferedImage	getImage(Rendition rendition) This method retrieves the graphical representation of the given file.
java.awt.image.BufferedImage	getImage(Rendition rendition, java.awt.Dimension maxDimension) This method retrieves the graphical representation of an Assets given Rendition.
java.util.Iterator<? extends AssetRelation>	processRelated(Asset asset) extracts and stores the links to the assets related with provided asset.
java.util.List<java.lang.String>	processSubAssets(Asset asset) Handler implementations may choose to support sub asset creation for the file types it handles.
java.util.List<java.lang.String>	processSubAssets(Node asset, Session session) Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.day.cq.dam.api.handler.AssetHandler

getMimeTypes

Field Detail

PROPERTY_DEACTIVATED_MIME_TYPES

public static java.lang.String PROPERTY_DEACTIVATED_MIME_TYPES

The property for deactivated mime types.

Constructor Detail

AbstractAssetHandler

public AbstractAssetHandler()

Method Detail

createThumbnails

public void createThumbnails(Node asset,
                             Node renditionFolder,
                             Session session,
                             java.util.List<java.lang.Integer[]> dimensions)

Deprecated.

The thumbnail renditions are created depending on the dimensions list. The dimensions list has the following format: [width1,height1], [width2,height2], ...

Specified by:

createThumbnails in interface AssetHandler

Parameters:

asset - the asset/file for which the thumbnails are generated

renditionFolder - the folder where the thumbnails belong to

session - the jcr session shich is used to store the thumbnails

dimensions - the dimensions for the "ordered" thumbnails

createThumbnailsExt

public void createThumbnailsExt(Node asset,
                                Node renditionFolder,
                                Session session,
                                java.util.List<java.util.Map<java.lang.String,java.lang.Object>> thumbnailConfigs)
                         throws java.io.IOException

Deprecated.

Thumbnails of an asset are created during import/update of an asset and it's original binary. Currently this method is used by the CreateThumbnailProcess and the CommandLineProcess as part of the DAM Update Asset workflow. Implementations may choose to create asset thumbnails for every entry in the thumbnailConfigs list argument, to not create any thumbnails at all, or to create a generic thumbnail independent of the given config. Thumbnails themselves are renditions of an asset and must be persisted as such (see Asset.addRendition(String, java.io.InputStream, String)).

The thumbnail renditions are created depending on the given configuration list:

 {
     height:h1,
     width: w1,
     doCenter: true (or false)
 },
 {
 ...
 }
 

Sample:

   ...
   final ArrayList> config = new ArrayList>();
 

   config.add(new HashMap() {{
       put("width", 140);
       put("height", 100);
       put("doCenter", true);
   }});
   config.add(new HashMap() {{
       put("width", 80);
       put("height", 80);
       put("doCenter", true);
   }});
 

  handler.createThumbnailsExt(
           getTiff(),
           asset.adaptTo(Node.class).getNode("jcr:content/renditions"),
           session,
           config);
  ...
 

Specified by:

createThumbnailsExt in interface AssetHandler

Parameters:

asset - the asset/file for which the thumbnails are generated

renditionFolder - the folder where thumbnails (renditions) shall be stored

session - the jcr session shich is used to store the thumbnails

thumbnailConfigs - thumbnail configurations

Throws:

java.io.IOException - is thrown in case while an error occured while fetching the image

See Also:

Asset.addRendition(String, java.io.InputStream, String), Asset.getRenditions(), ), Asset.getRendition(com.day.cq.dam.api.RenditionPicker)

createThumbnails

public void createThumbnails(Asset asset,
                             java.util.Collection<ThumbnailConfig> configs)
                      throws java.io.IOException

Thumbnails of an asset are created during import/update of an asset and it's original binary. Currently this method is used by the CreateThumbnailProcess and the CommandLineProcess as part of the DAM Update Asset workflow. Implementations may choose to create asset thumbnails for every entry in the thumbnailConfigs list argument, to not create any thumbnails at all, or to create a generic thumbnail independent of the given config. Thumbnails themselves are renditions of an asset and must be persisted as such (see Asset.addRendition(String, java.io.InputStream, String)).

The thumbnail renditions are created depending on the given configuration list:

 {
     height:h1,
     width: w1,
     doCenter: true (or false)
 },
 {
 ...
 }
 

Sample:

   ...
   final ArrayList> config = new ArrayList>();
 

   config.add(new HashMap() {{
       put("width", 140);
       put("height", 100);
       put("doCenter", true);
   }});
   config.add(new HashMap() {{
       put("width", 80);
       put("height", 80);
       put("doCenter", true);
   }});
 

  handler.createThumbnailsExt(
           getTiff(),
           asset.adaptTo(Node.class).getNode("jcr:content/renditions"),
           session,
           config);
  ...
 

Specified by:

createThumbnails in interface AssetHandler

Parameters:

asset - the asset/file for which the thumbnails are generated

configs - thumbnail configurations

Throws:

java.io.IOException - is thrown in case while an error occurred while fetching the image

See Also:

Asset.addRendition(String, java.io.InputStream, String), Asset.getRenditions(), ), Asset.getRendition(com.day.cq.dam.api.RenditionPicker)

createThumbnails

public void createThumbnails(Asset asset)
                      throws java.io.IOException

Creates thumbnails for this asset. Which thumbnails are created is automatically derived from the existing thumbnails (renditions with the cq5dam.thumbnail prefix). This essentially amounts to re-creating existing thumbnails.

Specified by:

createThumbnails in interface AssetHandler

Parameters:

asset - The asset for which to create thumbnails.

Throws:

java.io.IOException - If an error occurred while extracting the image.

createThumbnails

public void createThumbnails(Asset asset,
                             Rendition rendition,
                             java.util.Collection<ThumbnailConfig> configs)
                      throws java.io.IOException

Creates thumbnails for an Assets particular Rendition.

Specified by:

createThumbnails in interface AssetHandler

Parameters:

asset - The asset for which to created thumbnails.

rendition - The rendition serving as the thumbnail basis.

configs - The thumbnail configurations.

Throws:

java.io.IOException - If an error occurred extracting an image from the rendition.

canHandleSubAssets

public boolean canHandleSubAssets()

Indicates if the handler supports processing of sub assets

Specified by:

canHandleSubAssets in interface AssetHandler

Returns:

true if handler is able to process sub assets

processSubAssets

public java.util.List<java.lang.String> processSubAssets(Node asset,
                                                         Session session)

Deprecated.

Handler implementations may choose to support sub asset creation for the file types it handles. The method is called by the CreateSubAssetsProcess during import/update of an asset and its binary, as part of the DAM Update Asset workflow. Sub assets represent fragments of the original asset, for example every page of a multi-page PDF document are sub assets. Sub assets are stored as assets themselves under the parent asset. Sub assets are stored in the subassets folder of the main asset, e.g. at /content/dam/geometrixx/documents/ECM Artikel.pdf/subassets.

The asset argument represents the javax.jcr.Node of type nt:file holding the binary content or the DAM Asset node (type dam:Asset), for which its original rendition would be retrieved.

Specified by:

processSubAssets in interface AssetHandler

Parameters:

asset - asset to extract sub assets

session - jcr session

Returns:

List constaining all paths to the newly created assets

See Also:

AssetHandler.canHandleSubAssets(), Asset.isSubAsset()

processSubAssets

public java.util.List<java.lang.String> processSubAssets(Asset asset)

Description copied from interface: AssetHandler

Handler implementations may choose to support sub asset creation for the file types it handles. The method is called by the CreateSubAssetsProcess during import/update of an asset and its binary, as part of the DAM Update Asset workflow. Sub assets represent fragments of the original asset, for example every page of a multi-page PDF document are sub assets. Sub assets are stored as assets themselves under the parent asset. Sub assets are stored in the subassets folder of the main asset, e.g. at /content/dam/geometrixx/documents/ECM Artikel.pdf/subassets.

The asset argument represents the javax.jcr.Node of type nt:file holding the binary content or the DAM Asset node (type dam:Asset), for which its original rendition would be retrieved.

Specified by:

processSubAssets in interface AssetHandler

Parameters:

asset - asset to extract sub assets

Returns:

List constaining all paths to the newly created assets

See Also:

AssetHandler.canHandleSubAssets(), Asset.isSubAsset()

processRelated

public java.util.Iterator<? extends AssetRelation> processRelated(Asset asset)

Description copied from interface: AssetHandler

extracts and stores the links to the assets related with provided asset.

Specified by:

processRelated in interface AssetHandler

Parameters:

asset - asset to process

Returns:

Iterator of AssetRelation or an empty iterator if no related assets are available

getImage

public java.awt.image.BufferedImage getImage(Rendition rendition)
                                      throws java.io.IOException

Description copied from interface: AssetHandler

This method retrieves the graphical representation of the given file. For images the BufferedImage of the original image is returned, for other formats the first page is retrieved as BufferedImage

Specified by:

getImage in interface AssetHandler

Parameters:

rendition - to retrieve the image representation

Returns:

BufferedImage if a graphical representaion exists, otherwise null

Throws:

java.io.IOException - in case an error is thrown while fetching the buffered image

getImage

public java.awt.image.BufferedImage getImage(Rendition rendition,
                                             java.awt.Dimension maxDimension)
                                      throws java.io.IOException

Description copied from interface: AssetHandler

This method retrieves the graphical representation of an Assets given Rendition. For images the BufferedImage of the original image is returned, for other formats the first page is retrieved as BufferedImage.

If maxDimension is given, the handler should return an image where no dimension extends the given value. This can be used to reduce the memory footprint of large buffered images if the full resolution is not needed.

Specified by:

getImage in interface AssetHandler

Parameters:

rendition - The rendition for which to retrieve its graphical representation.

maxDimension - optional constraint for the maximal dimension of the image.

Returns:

BufferedImage if a graphical representation exists, otherwise null

Throws:

java.io.IOException - in case an error is thrown while fetching the buffered image

exportAsset

public void exportAsset(Node asset,
                        java.io.OutputStream stream)
                 throws AssetHandlerException

Deprecated.

This method is called when an asset is exported or the asset is downloaded.

Specified by:

exportAsset in interface AssetHandler

Parameters:

asset - the file node

stream - the OutputStream where the exported asset is put.

Throws:

AssetHandlerException - in case the export work failed.

extractMetadata

public ExtractedMetadata extractMetadata(Node asset)

Deprecated.

This method is used by the ExtractMetadataProcess as part of the DAM Update Asset workflow during import or update of an asset. Implementations must return an ExtractedMetadata object, which may be empty if no metadata is extracted, or contains the metadata values extracted from the binary being imported/updated at the time. The ExtractMetadataProcess will later save the metadata contained in ExtractedMetadata to the asset's metadata node (e.g. /content/dam/geometrixx/banners/banner-mono.png/jcr:content/metadata). Implementations are free to decide which and how many metadata values are extracted.

The method argument represents the javax.jcr.Node of type nt:file holding the binary content or the DAM Asset node (type dam:Asset), for which its original rendition would be retrieved.

Specified by:

extractMetadata in interface AssetHandler

Parameters:

asset - the file node

Returns:

all extracted metadata

See Also:

Asset.getMetadata(), Asset.getMetadata(String), Asset.getMetadataValue(String)

getImage

public java.awt.image.BufferedImage getImage(Node file)
                                      throws java.io.IOException

Deprecated.

This method retrieves the graphical representation of the given file. For images the BufferedImage of the original image is returned, for other formats the first page is retrieved as BufferedImage

Specified by:

getImage in interface AssetHandler

Parameters:

file - to retrieve the image representation

Returns:

BufferedImage if a graphical representaion exists, otherwise null

Throws:

java.io.IOException - in case an error is thrown while fetching the buffered image