com.day.cq.dam.api.handler

Interface AssetHandler

All Known Implementing Classes:

AbstractAssetHandler, AbstractAssetHandler, AbstractSubAssetHandler, EPubHandler, KeynoteHandler, Mp3Handler, MSOfficeHandler, MSPowerPointHandler, MSPowerPointOOXMLHandler, OpenOfficeHandler, PdfHandler, PictHandler, PostScriptHandler, PsdHandler, StandardImageHandler, ZipHandler

public interface AssetHandler

The AssetHandler inteface specifies the handling of assets, specifically during importing or updating the binary of an asset.

Method Summary

Methods

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, 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, Collection<ThumbnailConfig> configs) Creates thumbnails for an Assets particular Rendition.
void	createThumbnails(Node asset, Node renditionFolder, Session session, List<Integer[]> dimensions) Deprecated. Use createThumbnails(com.day.cq.dam.api.Asset, java.util.Collection) instead.
void	createThumbnailsExt(Node asset, Node renditionFolder, Session session, List<Map<String,Object>> thumbnailConfigs) Deprecated. Use createThumbnails(com.day.cq.dam.api.Asset, java.util.Collection) instead.
void	exportAsset(Node asset, OutputStream stream) Deprecated. Use #exportAsset(com.day.cq.dam.api.Asset, java.io.OutputStream) instead.
ExtractedMetadata	extractMetadata(Node asset) Deprecated. Use #extractMetadata(com.day.cq.dam.api.Asset) instead.
BufferedImage	getImage(Node file) Deprecated. Use #getImage(Rendition) instead.
BufferedImage	getImage(Rendition rendition, Dimension maxDimension) This method retrieves the graphical representation of an Assets given Rendition.
String[]	getMimeTypes() This method returns the mime types a particular AssetHandler supports.
Iterator<? extends AssetRelation>	processRelated(Asset asset) extracts and stores the links to the assets related with provided asset.
List<String>	processSubAssets(Asset asset) Handler implementations may choose to support sub asset creation for the file types it handles.
List<String>	processSubAssets(Node asset, Session session) Deprecated. Use processSubAssets(com.day.cq.dam.api.Asset) instead.

Method Detail

canHandleSubAssets

boolean canHandleSubAssets()

Indicates if the handler supports processing of sub assets

Returns:

true if handler is able to process sub assets

createThumbnails

void createThumbnails(Asset asset,
                    Collection<ThumbnailConfig> configs)
                      throws 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);
  ...
 

Parameters:

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

configs - thumbnail configurations

Throws:

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

Since:

5.4.0

See Also:

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

createThumbnails

void createThumbnails(Asset asset)
                      throws 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.

Parameters:

asset - The asset for which to create thumbnails.

Throws:

IOException - If an error occurred while extracting the image.

createThumbnails

void createThumbnails(Asset asset,
                    Rendition rendition,
                    Collection<ThumbnailConfig> configs)
                      throws IOException

Creates thumbnails for an Assets particular Rendition.

Parameters:

asset - The asset for which to created thumbnails.

rendition - The rendition serving as the thumbnail basis.

configs - The thumbnail configurations.

Throws:

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

createThumbnails

void createThumbnails(Node asset,
                    Node renditionFolder,
                    Session session,
                    List<Integer[]> dimensions)

Deprecated. Use createThumbnails(com.day.cq.dam.api.Asset, java.util.Collection) instead.

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

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

void createThumbnailsExt(Node asset,
                       Node renditionFolder,
                       Session session,
                       List<Map<String,Object>> thumbnailConfigs)
                         throws IOException

Deprecated. Use createThumbnails(com.day.cq.dam.api.Asset, java.util.Collection) instead.

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);
  ...
 

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:

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

Since:

5.3.0

See Also:

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

exportAsset

void exportAsset(Node asset,
               OutputStream stream)
                 throws AssetHandlerException

Deprecated. Use #exportAsset(com.day.cq.dam.api.Asset, java.io.OutputStream) instead.

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

Parameters:

asset - the file node

stream - the OutputStream where the exported asset is put.

Throws:

AssetHandlerException - in case the export work failed.

extractMetadata

ExtractedMetadata extractMetadata(Node asset)

Deprecated. Use #extractMetadata(com.day.cq.dam.api.Asset) instead.

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.

Parameters:

asset - the file node

Returns:

all extracted metadata

See Also:

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

getImage

BufferedImage getImage(Node file)
                       throws IOException

Deprecated. Use #getImage(Rendition) instead.

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

Parameters:

file - to retrieve the image representation

Returns:

BufferedImage if a graphical representaion exists, otherwise null

Throws:

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

Since:

5.3.0

getImage

BufferedImage getImage(Rendition rendition,
                     Dimension maxDimension)
                       throws IOException

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.

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:

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

Since:

5.4.0

getMimeTypes

String[] getMimeTypes()

This method returns the mime types a particular AssetHandler supports.

Returns:

mime type, e.g. image/jpg

processSubAssets

List<String> processSubAssets(Node asset,
                            Session session)

Deprecated. Use processSubAssets(com.day.cq.dam.api.Asset) instead.

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.

Parameters:

asset - asset to extract sub assets

session - jcr session

Returns:

List constaining all paths to the newly created assets

See Also:

canHandleSubAssets(), Asset.isSubAsset()

processSubAssets

List<String> processSubAssets(Asset asset)

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.

Parameters:

asset - asset to extract sub assets

Returns:

List constaining all paths to the newly created assets

See Also:

canHandleSubAssets(), Asset.isSubAsset()

processRelated

Iterator<? extends AssetRelation> processRelated(Asset asset)

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

Parameters:

asset - asset to process

Returns:

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